diff --git a/src/site/xdoc/userguide/overview.xml b/src/site/xdoc/userguide/overview.xml index 47fd6de0d..e8a129010 100644 --- a/src/site/xdoc/userguide/overview.xml +++ b/src/site/xdoc/userguide/overview.xml @@ -31,7 +31,7 @@

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.

@@ -39,9 +39,9 @@

- 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.

We are actively seeking ideas for additional components that fit into the - Commons Math vision of a set of lightweight, + Commons-Math vision 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 @@

- Commons Math is divided into fourteen subpackages, based on functionality provided. + Commons-Math is divided into fourteen subpackages, based on functionality provided.

  1. org.apache.commons.math.stat - statistics, statistical tests
  2. org.apache.commons.math.analysis - rootfinding, integration, interpolation, polynomials
    3. @@ -95,7 +95,7 @@

    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.

    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 IEEE 754 standard 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 + + IllegalArgumentException or + + MathIllegalStateException 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 + IEEE 754 standard 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.

    As of version 2.2, the policy for dealing with null references is as follows: When an argument is unexpectedly null, a - NullArgumentException is raised for signalling the - illegal argument. Note that this class does not inherit from the - standard NullPointerException but is a subclass of - IllegalArgumentException. - No NullPointerException should be propagated from within - Commons-Math. + NullArgumentException is raised for signalling the illegal argument. Note that this + class does not inherit from the standard NullPointerException but is a subclass + of MathIllegalArgumentException. + No NullPointerException should be propagated from within Commons-Math.

    - Commons Math requires JDK 1.5+ and has no runtime dependencies. + Commons-Math requires JDK 1.5+ and has no runtime dependencies.

    - 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: .