From 5cd31fd1be27ef454e1bb501cad7be7ff865b5ae Mon Sep 17 00:00:00 2001 From: Gilles Sadowski Date: Thu, 13 Jan 2011 16:12:50 +0000 Subject: [PATCH] "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 --- src/site/xdoc/userguide/overview.xml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/site/xdoc/userguide/overview.xml b/src/site/xdoc/userguide/overview.xml index e8a129010..4d8be4b03 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.

  • Computing means, variances and other summary statistics for a list of numbers
  • Fitting a line to a set of data points using linear regression
    • @@ -60,7 +60,7 @@

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) @@ -111,7 +111,7 @@ 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 + 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.

    @@ -122,19 +122,19 @@ 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. + 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: .