Author: erans
Date: Thu Jan 13 15:13:38 2011
New Revision: 1058602
URL: http://svn.apache.org/viewvc?rev=1058602&view=rev
Log:
Update.
Modified:
commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml?rev=1058602&r1=1058601&r2=1058602&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/overview.xml Thu Jan 13
15:13:38 2011
@@ -31,7 +31,7 @@
<subsection name="0.1 About The User Guide" href="about">
<p>
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
in the package.
</p>
@@ -39,9 +39,9 @@
<subsection name="0.2 What's in commons-math" href="summary">
<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,
- 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>
<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>
@@ -60,7 +60,7 @@
</ul></p>
<p>
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.
Suggestions for new components or enhancements to existing functionality
are always welcome!
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">
<p>
- Commons Math is divided into fourteen subpackages, based on functionality
provided.
+ Commons-Math is divided into fourteen subpackages, based on functionality
provided.
<ol>
<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>
@@ -95,7 +95,7 @@
<subsection name="0.4 How interface contracts are specified in commons-math
javadoc" href="contracts">
<p>
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.
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)
@@ -103,36 +103,38 @@
values/objects or state changes.</p>
<p>
When the actual parameters provided to a method or the internal state of
an object
- make a computation meaningless, an IllegalArgumentException or
IllegalStateException may
- be thrown. Exact conditions under which runtime exceptions (and any other
exceptions) are
- thrown are specified in the javadoc method comments. 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 methods return Double.NaN
values.
- Conditions under which Double.NaN or other special values are returned are
fully specified
- in the javadoc method comments.
+ make a computation meaningless, a
+ <a
href="../apidocs/org/apache/commons/math/exception/MathIllegalArgumentException.html">
+ IllegalArgumentException</a> or
+ <a
href="../apidocs/org/apache/commons/math/exception/MathIllegalStateException.html">
+ MathIllegalStateException</a> may be thrown. Exact conditions under
which runtime
+ exceptions (and any other exceptions) are thrown are specified in the
javadoc method
+ comments.
+ 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
+ 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.
</p>
<p>
As of version 2.2, the policy for dealing with null references is as
follows: When an argument is unexpectedly null, a
<a
href="../apidocs/org/apache/commons/math/exception/NullArgumentException.html">
- 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 of
- <code>IllegalArgumentException</code>.
- No <code>NullPointerException</code> should be propagated from within
- Commons-Math.
+ 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
+ of <code>MathIllegalArgumentException</code>.
+ No <code>NullPointerException</code> should be propagated from within
Commons-Math.
</p>
</subsection>
<subsection name="0.5 Dependencies" href="dependencies">
<p>
- Commons Math requires JDK 1.5+ and has no runtime dependencies.
+ Commons-Math requires JDK 1.5+ and has no runtime dependencies.
</p>
</subsection>
<subsection name="0.6 License" href="license">
<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"/>.
</p>