'\"
'\" Generated from file 'math\&.man' by tcllib/doctools with format 'nroff'
'\"
.TH "math" n 1\&.2\&.5 tcllib "Tcl Math Library"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
math \- Tcl Math Library
.SH SYNOPSIS
package require \fBTcl  8\&.2\fR
.sp
package require \fBmath  ?1\&.2\&.5?\fR
.sp
\fB::math::cov\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::integrate\fR \fIlist of xy value pairs\fR
.sp
\fB::math::fibonacci\fR \fIn\fR
.sp
\fB::math::max\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::mean\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::min\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::product\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::random\fR ?\fIvalue1\fR? ?\fIvalue2\fR?
.sp
\fB::math::sigma\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::stats\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
\fB::math::sum\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
.sp
.BE
.SH DESCRIPTION
.PP
The \fBmath\fR package provides utility math functions\&.
.PP
Besides a set of basic commands, available via the package \fImath\fR,
there are more specialised packages:
.IP \(bu
\fBmath::bigfloat\fR - Arbitrary-precision floating-point
arithmetic
.IP \(bu
\fBmath::bignum\fR - Arbitrary-precision integer arithmetic
.IP \(bu
\fBmath::calculus::romberg\fR - Robust integration methods for
functions of one variable, using Romberg integration
.IP \(bu
\fBmath::calculus\fR - Integration of functions, solving ordinary
differential equations
.IP \(bu
\fBmath::combinatorics\fR - Procedures for various combinatorial
functions (for instance the Gamma function and "k out of n")
.IP \(bu
\fBmath::complexnumbers\fR - Complex number arithmetic
.IP \(bu
\fBmath::constants\fR - A set of well-known mathematical
constants, such as Pi, E, and the golden ratio
.IP \(bu
\fBmath::fourier\fR - Discrete Fourier transforms
.IP \(bu
\fBmath::fuzzy\fR - Fuzzy comparisons of floating-point numbers
.IP \(bu
\fBmath::geometry\fR - 2D geometrical computations
.IP \(bu
\fBmath::interpolate\fR - Various interpolation methods
.IP \(bu
\fBmath::linearalgebra\fR - Linear algebra package
.IP \(bu
\fBmath::optimize\fR - Optimization methods
.IP \(bu
\fBmath::polynomials\fR - Polynomial arithmetic (includes families
of classical polynomials)
.IP \(bu
\fBmath::rationalfunctions\fR - Arithmetic of rational functions
.IP \(bu
\fBmath::roman\fR - Manipulation (including arithmetic) of Roman
numerals
.IP \(bu
\fBmath::special\fR - Approximations of special functions from
mathematical physics
.IP \(bu
\fBmath::statistics\fR - Statistical operations and tests
.PP
.SH "BASIC COMMANDS"
.TP
\fB::math::cov\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the coefficient of variation expressed as percent of two or
more numeric values\&.
.TP
\fB::math::integrate\fR \fIlist of xy value pairs\fR
Return the area under a "curve" defined by a set of x,y pairs and the
error bound as a list\&.
.TP
\fB::math::fibonacci\fR \fIn\fR
Return the \fIn\fR'th Fibonacci number\&.
.TP
\fB::math::max\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the maximum of one or more numeric values\&.
.TP
\fB::math::mean\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the mean, or "average" of one or more numeric values\&.
.TP
\fB::math::min\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the minimum of one or more numeric values\&.
.TP
\fB::math::product\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the product of one or more numeric values\&.
.TP
\fB::math::random\fR ?\fIvalue1\fR? ?\fIvalue2\fR?
Return a random number\&.  If no arguments are given, the number is a
floating point value between 0 and 1\&.  If one argument is given, the
number is an integer value between 0 and \fIvalue1\fR\&.  If two
arguments are given, the number is an integer value between
\fIvalue1\fR and \fIvalue2\fR\&.
.TP
\fB::math::sigma\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the population standard deviation of two or more numeric
values\&.
.TP
\fB::math::stats\fR \fIvalue\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the mean, standard deviation, and coefficient of variation (as
percent) as a list\&.
.TP
\fB::math::sum\fR \fIvalue\fR ?\fIvalue \&.\&.\&.\fR?
Return the sum of one or more numeric values\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the package it describes, will undoubtedly contain
bugs and other problems\&.
Please report such in the category \fImath\fR of the
\fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&.
Please also report any ideas for enhancements you may have for either
package and/or documentation\&.
.PP
When proposing code changes, please provide \fIunified diffs\fR,
i\&.e the output of \fBdiff -u\fR\&.
.PP
Note further that \fIattachments\fR are strongly preferred over
inlined patches\&. Attachments can be made by going to the \fBEdit\fR
form of the ticket immediately after its creation, and then using the
left-most button in the secondary navigation bar\&.
.SH KEYWORDS
math, statistics
.SH CATEGORY
Mathematics