File: math.man

package info (click to toggle)
tcllib 1.10-dfsg-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 17,708 kB
  • ctags: 6,122
  • sloc: tcl: 106,354; ansic: 9,205; sh: 8,707; xml: 1,766; yacc: 753; makefile: 115; perl: 84; f90: 84; python: 33; ruby: 13; php: 11
file content (144 lines) | stat: -rw-r--r-- 4,053 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
[manpage_begin math n 1.2.4]
[comment {-*- tcl -*- doctools manpage}]
[moddesc   {Tcl Math Library}]
[titledesc {Tcl Math Library}]
[require Tcl 8.2]
[require math [opt 1.2.4]]
[description]
[para]

The [package math] package provides utility math functions.
[para]
Besides a set of basic commands, available via the package [emph math],
there are more specialised packages:

[list_begin itemized]
[item]
[package math::bigfloat] - Arbitrary-precision floating-point
arithmetic
[item]
[package math::bignum] - Arbitrary-precision integer arithmetic
[item]
[package math::calculus::romberg] - Robust integration methods for
functions of one variable, using Romberg integration
[item]
[package math::calculus] - Integration of functions, solving ordinary
differential equations
[item]
[package math::combinatorics] - Procedures for various combinatorial
functions (for instance the Gamma function and "k out of n")
[item]
[package math::complexnumbers] - Complex number arithmetic
[item]
[package math::constants] - A set of well-known mathematical
constants, such as Pi, E, and the golden ratio
[item]
[package math::fourier] - Discrete Fourier transforms
[item]
[package math::fuzzy] - Fuzzy comparisons of floating-point numbers
[item]
[package math::geometry] - 2D geometrical computations
[item]
[package math::interpolate] - Various interpolation methods
[item]
[package math::linearalgebra] - Linear algebra package
[item]
[package math::optimize] - Optimization methods
[item]
[package math::polynomials] - Polynomial arithmetic (includes families
of classical polynomials)
[item]
[package math::rationalfunctions] - Arithmetic of rational functions
[item]
[package math::roman] - Manipulation (including arithmetic) of Roman
numerals
[item]
[package math::special] - Approximations of special functions from
mathematical physics
[item]
[package math::statistics] - Statistical operations and tests
[list_end]

[section "BASIC COMMANDS"]

[list_begin definitions]

[call [cmd ::math::cov] [arg value] [arg value] [opt [arg {value ...}]]]

Return the coefficient of variation expressed as percent of two or
more numeric values.


[call [cmd ::math::integrate] [arg {list of xy value pairs}]]

Return the area under a "curve" defined by a set of x,y pairs and the
error bound as a list.


[call [cmd ::math::fibonacci] [arg n]]

Return the [arg n]'th Fibonacci number.


[call [cmd ::math::max] [arg value] [opt [arg {value ...}]]]

Return the maximum of one or more numeric values.


[call [cmd ::math::mean] [arg value] [opt [arg {value ...}]]]

Return the mean, or "average" of one or more numeric values.


[call [cmd ::math::min] [arg value] [opt [arg {value ...}]]]

Return the minimum of one or more numeric values.


[call [cmd ::math::product] [arg value] [opt [arg {value ...}]]]

Return the product of one or more numeric values.


[call [cmd ::math::random] [opt [arg value1]] [opt [arg value2]]]

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 [arg value1].  If two
arguments are given, the number is an integer value between

[arg value1] and [arg value2].


[call [cmd ::math::sigma] [arg value] [arg value] [opt [arg {value ...}]]]

Return the population standard deviation of two or more numeric
values.


[call [cmd ::math::stats] [arg value] [arg value] [opt [arg {value ...}]]]

Return the mean, standard deviation, and coefficient of variation (as
percent) as a list.


[call [cmd ::math::sum] [arg value] [opt [arg {value ...}]]]

Return the sum of one or more numeric values.

[list_end]

[section {BUGS, IDEAS, FEEDBACK}]

This document, and the package it describes, will undoubtedly contain
bugs and other problems.

Please report such in the category [emph math] of the
[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].

Please also report any ideas for enhancements you may have for either
package and/or documentation.


[keywords math statistics]
[manpage_end]