|
10
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2
|
|
|
3
|
|
|
4
|
|
|
5
|
|
|
6
|
|
|
7
|
|
|
8
|
|
|
9
|
|
|
10
|
|
|
11
|
|
|
12
|
|
|
13 <html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
14 <head>
|
|
|
15 <title>Math - User Guide - Overview</title>
|
|
|
16 <style type="text/css" media="all">
|
|
|
17 @import url("../css/maven-base.css");
|
|
|
18 @import url("../css/maven-theme.css");
|
|
|
19 @import url("../css/site.css");
|
|
|
20 </style>
|
|
|
21 <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
|
|
|
22 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
|
|
|
23 </head>
|
|
|
24 <body class="composite">
|
|
|
25 <div id="banner">
|
|
|
26 <span id="bannerLeft">
|
|
|
27
|
|
|
28 Commons Math User Guide
|
|
|
29
|
|
|
30 </span>
|
|
|
31 <div class="clear">
|
|
|
32 <hr/>
|
|
|
33 </div>
|
|
|
34 </div>
|
|
|
35 <div id="breadcrumbs">
|
|
|
36
|
|
|
37
|
|
|
38
|
|
|
39
|
|
|
40
|
|
|
41
|
|
|
42
|
|
|
43
|
|
|
44 <div class="xright">
|
|
|
45
|
|
|
46
|
|
|
47
|
|
|
48
|
|
|
49
|
|
|
50
|
|
|
51
|
|
|
52 </div>
|
|
|
53 <div class="clear">
|
|
|
54 <hr/>
|
|
|
55 </div>
|
|
|
56 </div>
|
|
|
57 <div id="leftColumn">
|
|
|
58 <div id="navcolumn">
|
|
|
59
|
|
|
60
|
|
|
61
|
|
|
62
|
|
|
63
|
|
|
64
|
|
|
65
|
|
|
66
|
|
|
67 <h5>User Guide</h5>
|
|
|
68 <ul>
|
|
|
69
|
|
|
70 <li class="none">
|
|
|
71 <a href="../userguide/index.html">Contents</a>
|
|
|
72 </li>
|
|
|
73
|
|
|
74 <li class="none">
|
|
|
75 <strong>Overview</strong>
|
|
|
76 </li>
|
|
|
77
|
|
|
78 <li class="none">
|
|
|
79 <a href="../userguide/stat.html">Statistics</a>
|
|
|
80 </li>
|
|
|
81
|
|
|
82 <li class="none">
|
|
|
83 <a href="../userguide/random.html">Data Generation</a>
|
|
|
84 </li>
|
|
|
85
|
|
|
86 <li class="none">
|
|
|
87 <a href="../userguide/linear.html">Linear Algebra</a>
|
|
|
88 </li>
|
|
|
89
|
|
|
90 <li class="none">
|
|
|
91 <a href="../userguide/analysis.html">Numerical Analysis</a>
|
|
|
92 </li>
|
|
|
93
|
|
|
94 <li class="none">
|
|
|
95 <a href="../userguide/special.html">Special Functions</a>
|
|
|
96 </li>
|
|
|
97
|
|
|
98 <li class="none">
|
|
|
99 <a href="../userguide/utilities.html">Utilities</a>
|
|
|
100 </li>
|
|
|
101
|
|
|
102 <li class="none">
|
|
|
103 <a href="../userguide/complex.html">Complex Numbers</a>
|
|
|
104 </li>
|
|
|
105
|
|
|
106 <li class="none">
|
|
|
107 <a href="../userguide/distribution.html">Distributions</a>
|
|
|
108 </li>
|
|
|
109
|
|
|
110 <li class="none">
|
|
|
111 <a href="../userguide/fraction.html">Fractions</a>
|
|
|
112 </li>
|
|
|
113
|
|
|
114 <li class="none">
|
|
|
115 <a href="../userguide/transform.html">Transform Methods</a>
|
|
|
116 </li>
|
|
|
117
|
|
|
118 <li class="none">
|
|
|
119 <a href="../userguide/geometry.html">3D Geometry</a>
|
|
|
120 </li>
|
|
|
121
|
|
|
122 <li class="none">
|
|
|
123 <a href="../userguide/optimization.html">Optimization</a>
|
|
|
124 </li>
|
|
|
125
|
|
|
126 <li class="none">
|
|
|
127 <a href="../userguide/ode.html">Ordinary Differential Equations</a>
|
|
|
128 </li>
|
|
|
129
|
|
|
130 <li class="none">
|
|
|
131 <a href="../userguide/genetics.html">Genetic Algorithms</a>
|
|
|
132 </li>
|
|
|
133 </ul>
|
|
|
134 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
|
|
135 <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
|
|
|
136 </a>
|
|
|
137
|
|
|
138
|
|
|
139
|
|
|
140
|
|
|
141
|
|
|
142
|
|
|
143
|
|
|
144
|
|
|
145 </div>
|
|
|
146 </div>
|
|
|
147 <div id="bodyColumn">
|
|
|
148 <div id="contentBox">
|
|
|
149 <div class="section"><h2><a name="Overview"></a>Overview</h2>
|
|
|
150 <div class="section"><h3><a name="a0.1_About_The_User_Guide"></a>0.1 About The User Guide</h3>
|
|
|
151 <p>
|
|
|
152 This guide is intended to help programmers quickly find what they need to develop
|
|
|
153 solutions using Commons Math. It also provides a supplement to the javadoc API documentation,
|
|
|
154 providing a little more explanation of the mathematical objects and functions included
|
|
|
155 in the package.
|
|
|
156 </p>
|
|
|
157 </div>
|
|
|
158 <div class="section"><h3><a name="a0.2_Whats_in_commons-math"></a>0.2 What's in commons-math</h3>
|
|
|
159 <p>
|
|
|
160 Commons Math is made up of a small set of math/stat utilities addressing
|
|
|
161 programming problems like the ones in the list below. This list is not exhaustive,
|
|
|
162 it's just meant to give a feel for the kinds of things that Commons Math provides.
|
|
|
163 <ul><li>Computing means, variances and other summary statistics for a list of numbers</li>
|
|
|
164 <li>Fitting a line to a set of data points using linear regression</li>
|
|
|
165 <li>Finding a smooth curve that passes through a collection of points (interpolation)</li>
|
|
|
166 <li>Fitting a parametric model to a set of measurements using least-squares methods</li>
|
|
|
167 <li>Solving equations involving real-valued functions (i.e. root-finding)</li>
|
|
|
168 <li>Solving systems of linear equations</li>
|
|
|
169 <li>Solving Ordinary Differential Equations</li>
|
|
|
170 <li>Minimizing multi-dimensional functions</li>
|
|
|
171 <li>Generating random numbers with more restrictions (e.g distribution, range) than what
|
|
|
172 is possible using the JDK</li>
|
|
|
173 <li>Generating random samples and/or datasets that are "like" the data in an input file</li>
|
|
|
174 <li>Performing statistical significance tests</li>
|
|
|
175 <li>Miscellaneous mathematical functions such as factorials, binomial
|
|
|
176 coefficients and "special functions" (e.g. gamma, beta functions)</li>
|
|
|
177 </ul>
|
|
|
178 </p>
|
|
|
179 <p>
|
|
|
180 We are actively seeking ideas for additional components that fit into the
|
|
|
181 <a href="../index.html#summary">Commons Math vision</a> of a set of lightweight,
|
|
|
182 self-contained math/stat components useful for solving common programming problems.
|
|
|
183 Suggestions for new components or enhancements to existing functionality are always welcome!
|
|
|
184 All feedback/suggestions for improvement should be sent to the
|
|
|
185 <a href="http://commons.apache.org/mail-lists.html" class="externalLink">commons-dev mailing list</a> with
|
|
|
186 [math] at the beginning of the subject line.
|
|
|
187 </p>
|
|
|
188 </div>
|
|
|
189 <div class="section"><h3><a name="a0.3_How_commons-math_is_organized"></a>0.3 How commons-math is organized</h3>
|
|
|
190 <p>
|
|
|
191 Commons Math is divided into fourteen subpackages, based on functionality provided.
|
|
|
192 <ol type="1"><li><a href="stat.html">org.apache.commons.math.stat</a> - statistics, statistical tests</li>
|
|
|
193 <li><a href="analysis.html">org.apache.commons.math.analysis</a> - rootfinding, integration, interpolation, polynomials</li>
|
|
|
194 <li><a href="random.html">org.apache.commons.math.random</a> - random numbers, strings and data generation</li>
|
|
|
195 <li><a href="special.html">org.apache.commons.math.special</a> - special functions (Gamma, Beta) </li>
|
|
|
196 <li><a href="linear.html">org.apache.commons.math.linear</a> - matrices, solving linear systems </li>
|
|
|
197 <li><a href="utilities.html">org.apache.commons.math.util</a> - common math/stat functions extending java.lang.Math </li>
|
|
|
198 <li><a href="complex.html">org.apache.commons.math.complex</a> - complex numbers</li>
|
|
|
199 <li><a href="distribution.html">org.apache.commons.math.distribution</a> - probability distributions</li>
|
|
|
200 <li><a href="fraction.html">org.apache.commons.math.fraction</a> - rational numbers</li>
|
|
|
201 <li><a href="transform.html">org.apache.commons.math.transform</a> - transform methods (Fast Fourier)</li>
|
|
|
202 <li><a href="geometry.html">org.apache.commons.math.geometry</a> - 3D geometry (vectors and rotations)</li>
|
|
|
203 <li><a href="optimization.html">org.apache.commons.math.optimization</a> - function maximization or minimization</li>
|
|
|
204 <li><a href="ode.html">org.apache.commons.math.ode</a> - Ordinary Differential Equations integration</li>
|
|
|
205 <li><a href="genetics.html">org.apache.commons.math.genetics</a> - Genetic Algorithms</li>
|
|
|
206 </ol>
|
|
|
207
|
|
|
208 Package javadocs are <a href="../apidocs/index.html">here</a></p>
|
|
|
209 </div>
|
|
|
210 <div class="section"><h3><a name="a0.4_How_interface_contracts_are_specified_in_commons-math_javadoc"></a>0.4 How interface contracts are specified in commons-math javadoc</h3>
|
|
|
211 <p>
|
|
|
212 You should always read the javadoc class and method comments carefully when using
|
|
|
213 Commons Math components in your programs. The javadoc provides references to the algorithms
|
|
|
214 that are used, usage notes about limitations, performance, etc. as well as interface contracts.
|
|
|
215 Interface contracts are specified in terms of preconditions (what has to be true in order
|
|
|
216 for the method to return valid results), special values returned (e.g. Double.NaN)
|
|
|
217 or exceptions that may be thrown if the preconditions are not met, and definitions for returned
|
|
|
218 values/objects or state changes.</p>
|
|
|
219 <p>
|
|
|
220 When the actual parameters provided to a method or the internal state of an object
|
|
|
221 make a computation meaningless, an IllegalArgumentException or IllegalStateException may
|
|
|
222 be thrown. Exact conditions under which runtime exceptions (and any other exceptions) are
|
|
|
223 thrown are specified in the javadoc method comments. In some cases, to be consistent with
|
|
|
224 the <a href="http://grouper.ieee.org/groups/754/" class="externalLink">IEEE 754 standard</a> for floating point
|
|
|
225 arithmetic and with java.lang.Math, Commons Math methods return Double.NaN values.
|
|
|
226 Conditions under which Double.NaN or other special values are returned are fully specified
|
|
|
227 in the javadoc method comments.
|
|
|
228 </p>
|
|
|
229 </div>
|
|
|
230 <div class="section"><h3><a name="a0.5_Dependencies"></a>0.5 Dependencies</h3>
|
|
|
231 <p>
|
|
|
232 Commons Math requires JDK 1.5+ and has no runtime dependencies.
|
|
|
233 </p>
|
|
|
234 </div>
|
|
|
235 <div class="section"><h3><a name="a0.6_License"></a>0.6 License</h3>
|
|
|
236 <p>
|
|
|
237 Commons Math is distributed under the terms of the Apache License, Version 2.0:
|
|
|
238 <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink"></a>.
|
|
|
239 </p>
|
|
|
240 <p>
|
|
|
241 This product includes software developed by the University of Chicago, as Operator
|
|
|
242 of Argonne National Laboratory. This corresponds to software translated from the lmder,
|
|
|
243 lmpar and qrsolv Fortran routines from the Minpack package and distributed under the
|
|
|
244 following disclaimer: <a href="http://www.netlib.org/minpack/disclaimer" class="externalLink"></a>.
|
|
|
245 </p>
|
|
|
246 <p>
|
|
|
247 This product includes software translated from the odex Fortran routine developed by
|
|
|
248 E. Hairer and G. Wanner and distributed under the following license:
|
|
|
249 <a href="http://www.unige.ch/~hairer/prog/licence.txt" class="externalLink"></a>.
|
|
|
250 </p>
|
|
|
251 <p>
|
|
|
252 This product includes software translated from some LAPACK Fortran routines and
|
|
|
253 distributed under the following license: <a href="http://www.netlib.org/lapack/LICENSE" class="externalLink"></a>.
|
|
|
254 </p>
|
|
|
255 </div>
|
|
|
256 </div>
|
|
|
257
|
|
|
258 </div>
|
|
|
259 </div>
|
|
|
260 <div class="clear">
|
|
|
261 <hr/>
|
|
|
262 </div>
|
|
|
263 <div id="footer">
|
|
|
264 <div class="xright">©
|
|
|
265 2003-2010
|
|
|
266
|
|
|
267
|
|
|
268
|
|
|
269
|
|
|
270
|
|
|
271
|
|
|
272
|
|
|
273
|
|
|
274
|
|
|
275 </div>
|
|
|
276 <div class="clear">
|
|
|
277 <hr/>
|
|
|
278 </div>
|
|
|
279 </div>
|
|
|
280 </body>
|
|
|
281 </html>
|
