"Commons Math" instead of "Commons-Math"
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1058644 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
3a5a2a4da2
commit
5cd31fd1be
|
@ -31,7 +31,7 @@
|
||||||
<subsection name="0.1 About The User Guide" href="about">
|
<subsection name="0.1 About The User Guide" href="about">
|
||||||
<p>
|
<p>
|
||||||
This guide is intended to help programmers quickly find what they need to develop
|
This guide is intended to help programmers quickly find what they need to develop
|
||||||
solutions using Commons-Math. It also provides a supplement to the javadoc API documentation,
|
solutions using Commons Math. It also provides a supplement to the javadoc API documentation,
|
||||||
providing a little more explanation of the mathematical objects and functions included
|
providing a little more explanation of the mathematical objects and functions included
|
||||||
in the package.
|
in the package.
|
||||||
</p>
|
</p>
|
||||||
|
@ -39,9 +39,9 @@
|
||||||
|
|
||||||
<subsection name="0.2 What's in commons-math" href="summary">
|
<subsection name="0.2 What's in commons-math" href="summary">
|
||||||
<p>
|
<p>
|
||||||
Commons-Math is made up of a small set of math/stat utilities addressing
|
Commons Math is made up of a small set of math/stat utilities addressing
|
||||||
programming problems like the ones in the list below. This list is not exhaustive,
|
programming problems like the ones in the list below. This list is not exhaustive,
|
||||||
it's just meant to give a feel for the kinds of things that Commons-Math provides.
|
it's just meant to give a feel for the kinds of things that Commons Math provides.
|
||||||
<ul>
|
<ul>
|
||||||
<li>Computing means, variances and other summary statistics for a list of numbers</li>
|
<li>Computing means, variances and other summary statistics for a list of numbers</li>
|
||||||
<li>Fitting a line to a set of data points using linear regression</li>
|
<li>Fitting a line to a set of data points using linear regression</li>
|
||||||
|
@ -60,7 +60,7 @@
|
||||||
</ul></p>
|
</ul></p>
|
||||||
<p>
|
<p>
|
||||||
We are actively seeking ideas for additional components that fit into the
|
We are actively seeking ideas for additional components that fit into the
|
||||||
<a href="../index.html#summary">Commons-Math vision</a> of a set of lightweight,
|
<a href="../index.html#summary">Commons Math vision</a> of a set of lightweight,
|
||||||
self-contained math/stat components useful for solving common programming problems.
|
self-contained math/stat components useful for solving common programming problems.
|
||||||
Suggestions for new components or enhancements to existing functionality are always welcome!
|
Suggestions for new components or enhancements to existing functionality are always welcome!
|
||||||
All feedback/suggestions for improvement should be sent to the
|
All feedback/suggestions for improvement should be sent to the
|
||||||
|
@ -71,7 +71,7 @@
|
||||||
|
|
||||||
<subsection name="0.3 How commons-math is organized" href="organization">
|
<subsection name="0.3 How commons-math is organized" href="organization">
|
||||||
<p>
|
<p>
|
||||||
Commons-Math is divided into fourteen subpackages, based on functionality provided.
|
Commons Math is divided into fourteen subpackages, based on functionality provided.
|
||||||
<ol>
|
<ol>
|
||||||
<li><a href="stat.html">org.apache.commons.math.stat</a> - statistics, statistical tests</li>
|
<li><a href="stat.html">org.apache.commons.math.stat</a> - statistics, statistical tests</li>
|
||||||
<li><a href="analysis.html">org.apache.commons.math.analysis</a> - rootfinding, integration, interpolation, polynomials</li>
|
<li><a href="analysis.html">org.apache.commons.math.analysis</a> - rootfinding, integration, interpolation, polynomials</li>
|
||||||
|
@ -95,7 +95,7 @@
|
||||||
<subsection name="0.4 How interface contracts are specified in commons-math javadoc" href="contracts">
|
<subsection name="0.4 How interface contracts are specified in commons-math javadoc" href="contracts">
|
||||||
<p>
|
<p>
|
||||||
You should always read the javadoc class and method comments carefully when using
|
You should always read the javadoc class and method comments carefully when using
|
||||||
Commons-Math components in your programs. The javadoc provides references to the algorithms
|
Commons Math components in your programs. The javadoc provides references to the algorithms
|
||||||
that are used, usage notes about limitations, performance, etc. as well as interface contracts.
|
that are used, usage notes about limitations, performance, etc. as well as interface contracts.
|
||||||
Interface contracts are specified in terms of preconditions (what has to be true in order
|
Interface contracts are specified in terms of preconditions (what has to be true in order
|
||||||
for the method to return valid results), special values returned (e.g. Double.NaN)
|
for the method to return valid results), special values returned (e.g. Double.NaN)
|
||||||
|
@ -111,7 +111,7 @@
|
||||||
exceptions (and any other exceptions) are thrown are specified in the javadoc method
|
exceptions (and any other exceptions) are thrown are specified in the javadoc method
|
||||||
comments.
|
comments.
|
||||||
In some cases, to be consistent with the <a href="http://grouper.ieee.org/groups/754/">
|
In some cases, to be consistent with the <a href="http://grouper.ieee.org/groups/754/">
|
||||||
IEEE 754 standard</a> for floating point arithmetic and with java.lang.Math, Commons-Math
|
IEEE 754 standard</a> for floating point arithmetic and with java.lang.Math, Commons Math
|
||||||
methods return <code>Double.NaN</code> values. Conditions under which <code>Double.NaN</code>
|
methods return <code>Double.NaN</code> values. Conditions under which <code>Double.NaN</code>
|
||||||
or other special values are returned are fully specified in the javadoc method comments.
|
or other special values are returned are fully specified in the javadoc method comments.
|
||||||
</p>
|
</p>
|
||||||
|
@ -122,19 +122,19 @@
|
||||||
NullArgumentException</a> is raised for signalling the illegal argument. Note that this
|
NullArgumentException</a> is raised for signalling the illegal argument. Note that this
|
||||||
class does not inherit from the standard <code>NullPointerException</code> but is a subclass
|
class does not inherit from the standard <code>NullPointerException</code> but is a subclass
|
||||||
of <code>MathIllegalArgumentException</code>.
|
of <code>MathIllegalArgumentException</code>.
|
||||||
No <code>NullPointerException</code> should be propagated from within Commons-Math.
|
No <code>NullPointerException</code> should be propagated from within Commons Math.
|
||||||
</p>
|
</p>
|
||||||
</subsection>
|
</subsection>
|
||||||
|
|
||||||
<subsection name="0.5 Dependencies" href="dependencies">
|
<subsection name="0.5 Dependencies" href="dependencies">
|
||||||
<p>
|
<p>
|
||||||
Commons-Math requires JDK 1.5+ and has no runtime dependencies.
|
Commons Math requires JDK 1.5+ and has no runtime dependencies.
|
||||||
</p>
|
</p>
|
||||||
</subsection>
|
</subsection>
|
||||||
|
|
||||||
<subsection name="0.6 License" href="license">
|
<subsection name="0.6 License" href="license">
|
||||||
<p>
|
<p>
|
||||||
Commons-Math is distributed under the terms of the Apache License, Version 2.0:
|
Commons Math is distributed under the terms of the Apache License, Version 2.0:
|
||||||
<a href="http://www.apache.org/licenses/LICENSE-2.0"/>.
|
<a href="http://www.apache.org/licenses/LICENSE-2.0"/>.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue