'\"
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\" 
'\" RCS: @(#) $Id: math.n,v 1.5 2000/09/09 01:46:25 ericm Exp $
'\" 
.so man.macros
.TH math n 1.0 math "Tcl Math Library"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
math \- Tcl math library
.SH SYNOPSIS
\fBpackage require math ?1.0?\fR
.sp
\fB::math::max\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::min\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::sum\fR \fIvalue\fR ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::prod\fR \fIvalue\fR ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::mean\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::random\fR ?\fIvalue\fR? ?\fIvalue\fR?
.sp
\fB::math::sigma\fR \fIvalue\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::cov\fR \fIvalue\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::stats\fR \fIvalue\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::prod\fR \fIvalue\fR ?\fIvalue\fR \fI...\fR?
.sp
\fB::math::dot\fR \fIvalues\fR \fIrows\fR \fIcols\fR
.sp
\fB::math::cross\fR \fIvalues\fR \fIrows\fR \fIcols\fR
.sp
\fB::math::det\fR \fIvalues\fR \fIrows\fR \fIcols\fR
.sp
\fB::math::integrate\fR \fIlist of xy value pairs\fR
.sp
.BE
.SH DESCRIPTION
.PP
The \fBmath\fR package provides utility math functions.
.SH COMMANDS
.TP
\fB::math::max\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
Return the maximum of one or more numeric values.
.TP
\fB::math::min\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
Return the minimum of one or more numeric values.
.TP
\fB::math::sum\fR \fIvalue\fR ?\fIvalue\fR \fI...\fR?
Return the sum of one or more numeric values.
.TP
\fB::math::prod\fR \fIvalue\fR ?\fIvalue\fR \fI...\fR?
Return the product of one or more numeric values.
.TP
\fB::math::mean\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
Return the mean, or "average" 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? ?\fIvalue\fR \fI...\fR?
Return the population standard deviation of two or more numeric values.
.TP
\fB::math::cov\fR \fIvalue\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
Return the coefficient of variation expressed as percent of two or more numeric values.
.TP
\fB::math::stats\fR \fIvalue\fR \fIvalue\fR ?\fIvalue\fR? ?\fIvalue\fR \fI...\fR?
Return the mean, standard deviation, and coefficient of variation as percent as a list.
.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.
.SH KEYWORDS
math statistics
