Author: erans
Date: Sun Apr 25 21:42:47 2010
New Revision: 937893
URL: http://svn.apache.org/viewvc?rev=937893&view=rev
Log:
Removed package part in class name links.
Modified:
commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml
commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml
commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml
commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml
commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml
commons/proper/math/trunk/src/site/xdoc/userguide/random.xml
commons/proper/math/trunk/src/site/xdoc/userguide/special.xml
commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml
commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml
commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/complex.xml Sun Apr 25
21:42:47 2010
@@ -35,9 +35,8 @@
<subsection name="7.2 Complex Numbers" href="complex">
<p>
<a href="../apidocs/org/apache/commons/math/complex/Complex.html">
- org.apache.commons.math.complex.Complex</a> provides a complex number
- type that forms the basis for the complex functionality found in
- commons-math.
+ Complex</a> provides a complex number type that forms the basis for
+ the complex functionality found in commons-math.
</p>
<p>
Complex functions and arithmetic operations are implemented in
@@ -80,14 +79,14 @@ Complex answer = lhs.add(rhs); //
<subsection name="7.3 Complex Transcendental Functions" href="function">
<p>
<a href="../apidocs/org/apache/commons/math/complex/Complex.html">
- org.apache.commons.math.complex.Complex</a> also provides
- implementations of serveral transcendental functions involving
complex
- number arguments. Prior to version 1.2, these functions were
provided
+ Complex</a> also provides implementations of serveral transcendental
+ functions involving complex number arguments.
+ Prior to version 1.2, these functions were provided
by <a
href="../apidocs/org/apache/commons/math/complex/ComplexUtils.html">
- org.apache.commons.math.complex.ComplexUtils</a> in a way similar to
the real
- number functions found in <code>java.lang.Math</code>, but this has
been
- deprecated. These operations provide the means to compute the log,
sine,
- tangent, and other complex values :
+ ComplexUtils</a> in a way similar to the real number functions found
in
+ <code>java.lang.Math</code>, but this has been deprecated.
+ These operations provide the means to compute the log, sine, tangent,
+ and other complex values :
<source>Complex first = new Complex(1.0, 3.0);
Complex second = new Complex(2.0, 5.0);
@@ -100,7 +99,7 @@ Complex answer = first.log(); //
<p>
<code>Complex</code> instances can be converted to and from strings
using the<a
href="../apidocs/org/apache/commons/math/complex/ComplexFormat.html">
- org.apache.commons.math.complex.ComplexFormat</a> class.
+ ComplexFormat</a> class.
<code>ComplexFormat</code> is a <code>java.text.Format</code>
extension and, as such, is used like other formatting objects (e.g.
<code>java.text.SimpleDateFormat</code>):
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml
(original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/distribution.xml Sun Apr
25 21:42:47 2010
@@ -19,9 +19,9 @@
<?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?>
<!-- $Revision$ $Date$ -->
-<document url="stat.html">
+<document url="distribution.html">
<properties>
- <title>The Commons Math User Guide - Statistics</title>
+ <title>The Commons Math User Guide - Distributions</title>
</properties>
<body>
<section name="8 Probability Distributions">
@@ -41,9 +41,10 @@
</p>
<p>
Using a distribution object, PDF and CDF probabilities are easily
computed
- using the <code>cumulativeProbability</code> methods. For a
distribution <code>X</code>,
- and a domain value, <code>x</code>,
<code>cumulativeProbability</code> computes
- <code>P(X <= x)</code> (i.e. the lower tail probability of
<code>X</code>).
+ using the <code>cumulativeProbability</code> methods. For a
distribution
+ <code>X</code>, and a domain value, <code>x</code>,
+ <code>cumulativeProbability</code> computes <code>P(X <= x)</code>
+ (i.e. the lower tail probability of <code>X</code>).
</p>
<source>TDistribution t = new TDistributionImpl(29);
double lowerTail = t.cumulativeProbability(-2.656); // P(T <= -2.656)
@@ -66,19 +67,27 @@ double upperTail = 1.0 - t.cumulativePro
</subsection>
<subsection name="8.3 User Defined Distributions" href="userdefined">
<p>
- Since there are numerous distributions and Commons-Math only directly
supports a handful,
- it may be necessary to extend the distribution framework to satisfy
individual needs. It
- is recommended that the <code>Distribution</code>,
<code>ContinuousDistribution</code>,
- <code>DiscreteDistribution</code>, and
<code>IntegerDistribution</code> interfaces serve as
- base types for any extension. These serve as the basis for all the
distributions directly
- supported by Commons-Math and using those interfaces for
implementation purposes will
- insure any extension is compatible with the remainder of Commons-Math.
To aid in
- implementing a distribution extension, the
<code>AbstractDistribution</code>,
- <code>AbstractContinuousDistribution</code>, and
<code>AbstractIntegerDistribution</code>
- provide implementation building blocks and offer a lot of default
distribution
- functionality. By extending these abstract classes directly, a good
portion of the
- repetitive distribution implementation is already developed and should
save time and effort
- in developing user defined distributions.
+ Since there are numerous distributions and Commons-Math only directly
+ supports a handful, it may be necessary to extend the distribution
+ framework to satisfy individual needs. It is recommended that the
+ <a
href="../apidocs/org/apache/commons/math/distribution/Distribution.html">Distribution</a>,
+ <a
href="../apidocs/org/apache/commons/math/distribution/ContinuousDistribution.html">
+ ContinuousDistribution</a>,
+ <a
href="../apidocs/org/apache/commons/math/distribution/DiscreteDistribution.html">
+ DiscreteDistribution</a>, and <a
href="../apidocs/org/apache/commons/math/distribution/IntegerDistribution.html">
+ IntegerDistribution</a> interfaces serve as
+ base types for any extension. These serve as the basis for all the
+ distributions directly supported by Commons-Math and using those
interfaces
+ for implementation purposes will ensure any extension is compatible
with the
+ remainder of Commons-Math. To aid in implementing a distribution
extension,
+ the <a
href="../apidocs/org/apache/commons/math/distribution/AbstractDistribution.html">
+ AbstractDistribution</a>, <a
href="../apidocs/org/apache/commons/math/distribution/AbstractContinuousDistribution.html">
+ AbstractContinuousDistribution</a>, and <a
href="../apidocs/org/apache/commons/math/distribution/AbstractIntegerDistribution.html">
+ AbstractIntegerDistribution</a> provide implementation building blocks
and
+ offer basic distribution functionality. By extending these abstract
classes
+ directly, much of the repetitive distribution implementation is already
+ developed and should save time and effor in developing user-defined
+ distributions.
</p>
</subsection>
</section>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/fraction.xml Sun Apr 25
21:42:47 2010
@@ -19,7 +19,7 @@
<?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?>
<!-- $Revision$ $Date$ -->
-<document url="stat.html">
+<document url="fraction.html">
<properties>
<title>The Commons Math User Guide - Fractions</title>
</properties>
@@ -34,14 +34,13 @@
<subsection name="9.2 Fraction Numbers" href="fraction">
<p>
<a href="../apidocs/org/apache/commons/math/fraction/Fraction.html">
- org.apache.commons.math.fraction.Fraction</a> and
- <a
href="../apidocs/org/apache/commons/math/fraction/BigFraction.html">
- org.apache.commons.math.fraction.BigFraction</a> provide fraction
number
- type that forms the basis for the fraction functionality found in
- commons-math. The former one can be used for fractions whose
numerators
- and denominators are small enough to fit in an int (taking care of
intermediate
- values) while the second class should be used when there is a risk
the numerator
- and denominator grow very large.
+ Fraction</a> and <a
href="../apidocs/org/apache/commons/math/fraction/BigFraction.html">
+ BigFraction</a> provide fraction number type that forms the basis for
+ the fraction functionality found in Commons-Math. The former one can
be
+ used for fractions whose numerators and denominators are small enough
+ to fit in an int (taking care of intermediate values) while the
second
+ class should be used when there is a risk the numerator and
denominator
+ grow very large.
</p>
<p>
A fraction number, can be built from two integer arguments
representing numerator
@@ -73,10 +72,9 @@ Fraction answer = lhs.add(rhs); // a
<p>
<code>Fraction</code> instances can be converted to and from strings
using the<a
href="../apidocs/org/apache/commons/math/fraction/FractionFormat.html">
- org.apache.commons.math.fraction.FractionFormat</a> class.
- <code>FractionFormat</code> is a <code>java.text.Format</code>
- extension and, as such, is used like other formatting objects (e.g.
- <code>java.text.SimpleDateFormat</code>):
+ FractionFormat</a> class. <code>FractionFormat</code> is a
+ <code>java.text.Format</code> extension and, as such, is used like
other
+ formatting objects (e.g. <code>java.text.SimpleDateFormat</code>):
<source>FractionFormat format = new FractionFormat(); // default
format
Fraction f = new Fraction(2, 4);
String s = format.format(f); // s contains "1 / 2", note the reduced
fraction</source>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/genetics.xml Sun Apr 25
21:42:47 2010
@@ -34,22 +34,21 @@
<subsection name="14.2 GA Framework">
<p>
<a
href="../apidocs/org/apache/commons/math/genetics/GeneticAlgorithm.html">
- org.apache.commons.math.genetic.GeneticAlgorithm</a> provides an
- execution framework for Genetic Algorithms (GA).
- <a
href="../apidocs/org/apache/commons/math/genetics/Population.html">Populations,</a>
consisting
- of <a
href="../apidocs/org/apache/commons/math/genetics/Chromosome.html">
- Chromosomes</a> are evolved by the <code>GeneticAlgorithm</code>
until a
- <a
href="../apidocs/org/apache/commons/math/genetics/StoppingCondition.html">StoppingCondition</a>
- is reached. Evolution is determined by
- <a
href="../apidocs/org/apache/commons/math/genetics/SelectionPolicy.html">SelectionPolicies</a>,
- <a
href="../apidocs/org/apache/commons/math/genetics/MutationPolicy.html">
MutationPolicies</a>
- and <a
href="../apidocs/org/apache/commons/math/genetics/Fitness.html">Fitness</a>.
+ GeneticAlgorithm</a> provides an execution framework for Genetic
Algorithms (GA).
+ <a href="../apidocs/org/apache/commons/math/genetics/Population.html">
+ Populations,</a> consisting of <a
href="../apidocs/org/apache/commons/math/genetics/Chromosome.html">
+ Chromosomes</a> are evolved by the <code>GeneticAlgorithm</code> until a
+ <a
href="../apidocs/org/apache/commons/math/genetics/StoppingCondition.html">
+ StoppingCondition</a> is reached. Evolution is determined by <a
href="../apidocs/org/apache/commons/math/genetics/SelectionPolicy.html">
+ SelectionPolicy</a>, <a
href="../apidocs/org/apache/commons/math/genetics/MutationPolicy.html">
+ MutationPolicy</a> and <a
href="../apidocs/org/apache/commons/math/genetics/Fitness.html">
+ Fitness</a>.
</p>
<p>
- The GA itself is implemented by the <code>evolve</code> method of
the <code>GeneticAlgorithm</code> class,
- which looks like this:
- <source>
-public Population evolve(Population initial, StoppingCondition condition) {
+ The GA itself is implemented by the <code>evolve</code> method of the
+ <code>GeneticAlgorithm</code> class,
+ which looks like this:
+ <source>public Population evolve(Population initial, StoppingCondition
condition) {
Population current = initial;
while (!condition.isSatisfied(current)) {
current = nextGeneration(current);
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/geometry.xml Sun Apr 25
21:42:47 2010
@@ -36,8 +36,8 @@
<subsection name="11.2 Vectors" href="vectors">
<p>
<a href="../apidocs/org/apache/commons/math/geometry/Vector3D.html">
- org.apache.commons.math.geometry.Vector3D</a> provides a simple
vector
- type. One important feature is that instances of this class are
guaranteed
+ Vector3D</a> provides a simple vector type. One important feature is
+ that instances of this class are guaranteed
to be immutable, this greatly simplifies modelling dynamical systems
with changing states: once a vector has been computed, a reference
to it
is known to preserve its state as long as the reference itself is
preserved.
@@ -58,14 +58,14 @@
</p>
<p>
<a
href="../apidocs/org/apache/commons/math/geometry/Vector3DFormat.html">
- org.apache.commons.math.geometry.Vector3DFormat</a> is a specialized
format
- for formatting output or parsing input with text representation of
3D vectors.
+ Vector3DFormat</a> is a specialized format for formatting output or
parsing
+ input with text representation of 3D vectors.
</p>
</subsection>
<subsection name="11.3 Rotations" href="rotations">
<p>
<a href="../apidocs/org/apache/commons/math/geometry/Rotation.html">
- org.apache.commons.math.geometry.Rotation</a> represents 3D
rotations.
+ Rotation</a> represents 3D rotations.
Rotation instances are also immutable objects, as Vector3D instances.
</p>
<p>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/random.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/random.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/random.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/random.xml Sun Apr 25
21:42:47 2010
@@ -66,9 +66,8 @@
<subsection name="2.2 Random numbers" href="deviates">
<p>
The <a href="../apidocs/org/apache/commons/math/random/RandomData.html">
- org.apache.commons.math.RandomData</a> interface defines methods for
- generating random sequences of numbers. The API contracts of these methods
- use the following concepts:
+ RandomData</a> interface defines methods for generating random sequences
+ of numbers. The API contracts of these methods use the following concepts:
<dl>
<dt>Random sequence of numbers from a probability distribution</dt>
<dd>There is no such thing as a single "random number." What can be
@@ -173,15 +172,14 @@ for (int i = 0; i < 1000; i++) {
components of these vectors are uncorrelated, they may be generated simply
one at a time and packed together in the vector. The <a
href="../apidocs/org/apache/commons/math/random/UncorrelatedRandomVectorGenerator.html">
- org.apache.commons.math.UncorrelatedRandomVectorGenerator</a> class
- does however simplify this process by setting the mean and deviation of
each
- component once and generating complete vectors. When the components are
correlated
- however, generating them is much more difficult. The <a
-
href="../apidocs/org/apache/commons/math/random/CorrelatedRandomVectorGenerator.html">
- org.apache.commons.math.CorrelatedRandomVectorGenerator</a> class
- provides this service. In this case, the user must set up a complete
covariance matrix
- instead of a simple standard deviations vector. This matrix gathers both
the variance
- and the correlation information of the probability law.
+ UncorrelatedRandomVectorGenerator</a> class does however simplify this
+ process by setting the mean and deviation of each component once and
+ generating complete vectors. When the components are correlated however,
+ generating them is much more difficult. The <a
href="../apidocs/org/apache/commons/math/random/CorrelatedRandomVectorGenerator.html">
+ CorrelatedRandomVectorGenerator</a> class provides this service. In this
+ case, the user must set up a complete covariance matrix instead of a simple
+ standard deviations vector. This matrix gathers both the variance and the
+ correlation information of the probability law.
</p>
<p>
The main use for correlated random vector generation is for Monte-Carlo
@@ -310,19 +308,18 @@ for (int i = 0; i < 1000; i++) {
<code>java.util.Random</code> in applications, a random generator
adaptor framework has been added to commons-math. The
<a href="../apidocs/org/apache/commons/math/random/RandomGenerator.html">
- org.apache.commons.math.RandomGenerator</a> interface abstracts the
public
- interface of <code>java.util.Random</code> and any implementation of this
+ RandomGenerator</a> interface abstracts the public interface of
+ <code>java.util.Random</code> and any implementation of this
interface can be used as the source of random data for the commons-math
data generation classes. An abstract base class,
<a
href="../apidocs/org/apache/commons/math/random/AbstractRandomGenerator.html">
- org.apache.commons.math.AbstractRandomGenerator</a> is provided to make
- implementation easier. This class provides default implementations of
- "derived" data generation methods based on the primitive,
- <code>nextDouble().</code> To support generic replacement of
- <code>java.util.Random</code>, the
+ AbstractRandomGenerator</a> is provided to make implementation easier.
+ This class provides default implementations of "derived" data generation
+ methods based on the primitive, <code>nextDouble()</code>.
+ To support generic replacement of <code>java.util.Random</code>, the
<a href="../apidocs/org/apache/commons/math/random/RandomAdaptor.html">
- org.apache.commons.math.RandomAdaptor</a> class is provided, which
- extends <code>java.util.Random</code> and wraps and delegates calls to
+ RandomAdaptor</a> class is provided, which extends
+ <code>java.util.Random</code> and wraps and delegates calls to
a <code>RandomGenerator</code> instance.
</p>
<p>
@@ -387,4 +384,4 @@ RandomData randomData = new RandomDataIm
</section>
</body>
-</document>
\ No newline at end of file
+</document>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/special.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/special.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/special.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/special.xml Sun Apr 25
21:42:47 2010
@@ -35,7 +35,8 @@
</subsection>
<subsection name="5.2 Erf functions" href="erf">
<p>
- <code>org.apache.commons.math.special.Erf</code> contains several
useful functions involving the Error Function, Erf.
+ <a
href="../apidocs/org/apache/commons/math/special/Erf.html">Erf</a> contains
+ several useful functions involving the Error Function, Erf.
<table>
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
<tr><td>Error Function</td><td>erf</td><td>See <a
href="http://mathworld.wolfram.com/Erf.html";>Erf</a> from MathWorld</td></tr>
@@ -44,7 +45,8 @@
</subsection>
<subsection name="5.3 Gamma functions" href="gamma">
<p>
- <code>org.apache.commons.math.special.Gamma</code> contains several
useful functions involving the Gamma Function.
+ <a
href="../apidocs/org/apache/commons/math/special/Gamma.html">Gamma</a>
+ contains several useful functions involving the Gamma Function.
<table>
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
<tr><td>Log Gamma</td><td>logGamma</td><td>See <a
href="http://mathworld.wolfram.com/GammaFunction.html";>Gamma Function</a> from
MathWorld</td></tr>
@@ -54,7 +56,8 @@
</subsection>
<subsection name="5.4 Beta funtions" href="beta">
<p>
- <code>org.apache.commons.math.special.Beta</code> contains several
useful functions involving the Beta Function.
+ <a
href="../apidocs/org/apache/commons/math/special/Beta.html">Beta</a>
+ contains several useful functions involving the Beta Function.
<table>
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
<tr><td>Log Beta</td><td>logBeta</td><td>See <a
href="http://mathworld.wolfram.com/BetaFunction.html";>Beta Function</a> from
MathWorld</td></tr>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/stat.xml Sun Apr 25
21:42:47 2010
@@ -64,7 +64,7 @@
<p>
The top level interface is
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/UnivariateStatistic.html">
- org.apache.commons.math.stat.descriptive.UnivariateStatistic.</a>
+ UnivariateStatistic</a>.
This interface, implemented by all statistics, consists of
<code>evaluate()</code> methods that take double[] arrays as
arguments
and return the value of the statistic. This interface is extended
by
@@ -121,29 +121,34 @@
<p>
<code>SummaryStatistics</code> can be aggregated using
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/AggregateSummaryStatistics.html">
- AggregateSummaryStatistics.</a> This class can be used to
concurrently gather statistics for multiple
- datasets as well as for a combined sample including all of the data.
+ AggregateSummaryStatistics.</a> This class can be used to
concurrently
+ gather statistics for multiple datasets as well as for a combined
sample
+ including all of the data.
</p>
<p>
- <code>MultivariateSummaryStatistics</code> is similar to
<code>SummaryStatistics</code>
- but handles n-tuple values instead of scalar values. It can also
compute the
- full covariance matrix for the input data.
+ <code>MultivariateSummaryStatistics</code> is similar to
+ <code>SummaryStatistics</code> but handles n-tuple values instead of
+ scalar values. It can also compute the full covariance matrix for
the
+ input data.
</p>
<p>
- Neither <code>DescriptiveStatistics</code> nor
<code>SummaryStatistics</code> is
- thread-safe. <a
href="../apidocs/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.html">
+ Neither <code>DescriptiveStatistics</code> nor
<code>SummaryStatistics</code>
+ is thread-safe.
+ <a
href="../apidocs/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.html">
SynchronizedDescriptiveStatistics</a> and
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.html">
- SynchronizedSummaryStatistics</a>, respectively, provide
thread-safe versions for applications that
- require concurrent access to statistical aggregates by multiple
threads.
+ SynchronizedSummaryStatistics</a>, respectively, provide thread-safe
+ versions for applications that require concurrent access to
statistical
+ aggregates by multiple threads.
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/SynchronizedMultiVariateSummaryStatistics.html">
- SynchronizedMultivariateSummaryStatistics</a> provides threadsafe
<code>MultivariateSummaryStatistics.</code>
+ SynchronizedMultivariateSummaryStatistics</a> provides thread-safe
+ <code>MultivariateSummaryStatistics.</code>
</p>
<p>
There is also a utility class,
<a href="../apidocs/org/apache/commons/math/stat/StatUtils.html">
- StatUtils</a>, that provides static methods for computing statistics
- directly from double[] arrays.
+ StatUtils</a>, that provides static methods for computing statistics
+ directly from double[] arrays.
</p>
<p>
Here are some examples showing how to compute Descriptive statistics.
@@ -236,10 +241,11 @@ DescriptiveStatistics stats = new Synchr
<dt>Compute statistics for multiple samples and overall statistics
concurrently</dt>
<br/>
<dd>There are two ways to do this using
<code>AggregateSummaryStatistics.</code>
- The first is to use an <code>AggregateSummaryStatistics</code>
instance to accumulate
- overall statistics contributed by <code>SummaryStatistics</code>
instances created using
+ The first is to use an <code>AggregateSummaryStatistics</code> instance
+ to accumulate overall statistics contributed by
<code>SummaryStatistics</code>
+ instances created using
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/AggregateSummaryStatistics.html#createContributingStatistics()">
- AggregateSummaryStatistics.createContributingStatistics()</a>:
+ AggregateSummaryStatistics.createContributingStatistics()</a>:
<source>
// Create a AggregateSummaryStatistics instance to accumulate the overall
statistics
// and AggregatingSummaryStatistics for the subsamples
@@ -288,7 +294,7 @@ double totalSampleSum = aggregatedStats.
<subsection name="1.3 Frequency distributions">
<p>
<a href="../apidocs/org/apache/commons/math/stat/Frequency.html">
- org.apache.commons.math.stat.descriptive.Frequency</a>
+ Frequency</a>
provides a simple interface for maintaining counts and percentages
of discrete
values.
</p>
@@ -352,9 +358,8 @@ System.out.println(f.getCumPct("z")); /
<subsection name="1.4 Simple regression">
<p>
<a
href="../apidocs/org/apache/commons/math/stat/regression/SimpleRegression.html">
- org.apache.commons.math.stat.regression.SimpleRegression</a>
- provides ordinary least squares regression with one independent
variable,
- estimating the linear model:
+ SimpleRegression</a> provides ordinary least squares regression with
+ one independent variable estimating the linear model:
</p>
<p>
<code> y = intercept + slope * x </code>
@@ -469,9 +474,9 @@ System.out.println(regression.getSlopeSt
<subsection name="1.5 Multiple linear regression">
<p>
<a
href="../apidocs/org/apache/commons/math/stat/regression/MultipleLinearRegression.html">
- org.apache.commons.math.stat.regression.MultipleLinearRegression</a>
- provides ordinary least squares regression with a generic multiple
variable linear model, which
- in matrix notation can be expressed as:
+ MultipleLinearRegression</a> provides ordinary least squares
regression
+ with a generic multiple variable linear model, which in matrix
notation
+ can be expressed as:
</p>
<p>
<code> y=X*b+u </code>
@@ -484,9 +489,9 @@ System.out.println(regression.getSlopeSt
</p>
<p>
Two implementations are provided: <a
href="../apidocs/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.html">
-
org.apache.commons.math.stat.regression.OLSMultipleLinearRegression</a> and
+ OLSMultipleLinearRegression</a> and
<a
href="../apidocs/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.html">
-
org.apache.commons.math.stat.regression.GLSMultipleLinearRegression</a>
+ GLSMultipleLinearRegression</a>
</p>
<p>
Observations (x,y and covariance data matrices) can be added to the
model via the <code>addData(double[] y, double[][] x, double[][]
covariance)</code> method.
@@ -775,15 +780,12 @@ new PearsonsCorrelation().correlation(ra
ChiSquareTestImpl</a> and
<a
href="../apidocs/org/apache/commons/math/stat/inference/OneWayAnovaImpl.html">
OneWayAnovaImpl</a>, respectively.
- The
- <a
href="../apidocs/org/apache/commons/math/stat/inference/TestUtils.html">
+ The <a
href="../apidocs/org/apache/commons/math/stat/inference/TestUtils.html">
TestUtils</a> class provides static methods to get test instances or
to compute test statistics directly. The examples below all use the
static methods in <code>TestUtils</code> to execute tests. To get
- test object instances, either use e.g.,
- <code>TestUtils.getTTest()</code> or use the implementation
constructors
- directly, e.g.,
- <code>new TTestImpl()</code>.
+ test object instances, either use e.g.,
<code>TestUtils.getTTest()</code>
+ or use the implementation constructors directly, e.g. <code>new
TTestImpl()</code>.
</p>
<p>
<strong>Implementation Notes</strong>
@@ -839,7 +841,7 @@ System.out.println(TestUtils.t(mu, obser
</dd>
<dd>To compare the mean of a dataset described by a
<a
href="../apidocs/org/apache/commons/math/stat/descriptive/StatisticalSummary.html">
- org.apache.commons.math.stat.descriptive.StatisticalSummary</a> to
a fixed value:
+ StatisticalSummary</a> to a fixed value:
<source>
double[] observed ={1d, 2d, 3d};
double mu = 2.5d;
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/transform.xml Sun Apr 25
21:42:47 2010
@@ -31,10 +31,14 @@
This package provides a few transformers for signal analysis. All
transformers
provide both direct and inverse transforms.
<ul>
- <li><code>FastFourierTransformer</code> (produces
<code>Complex</code> results)</li>
- <li><code>FastCosineTransformer</code> (produces real results)</li>
- <li><code>FastSineTransformer</code> (produces real results)</li>
- <li><code>FastHadamardTransformer</code> (produces real
results)</li>
+ <li><a
href="../apidocs/org/apache/commons/math/transform/FastFourierTransformer.html">
+ FastFourierTransformer</a> (produces <code>Complex</code>
results)</li>
+ <li><a
href="../apidocs/org/apache/commons/math/transform/FastCosineTransformer.html">
+ FastCosineTransformer</a> (produces real results)</li>
+ <li><a
href="../apidocs/org/apache/commons/math/transform/FastSineTransformer.html">
+ FastSineTransformer</a> (produces real results)</li>
+ <li><a
href="../apidocs/org/apache/commons/math/transform/FastHadamardTransformer.html">
+ FastHadamardTransformer</a> (produces real results)</li>
</ul>
</p>
</section>
Modified: commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml?rev=937893&r1=937892&r2=937893&view=diff
==============================================================================
--- commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml (original)
+++ commons/proper/math/trunk/src/site/xdoc/userguide/utilities.xml Sun Apr 25
21:42:47 2010
@@ -45,17 +45,17 @@
<code>util</code> package. The core functionality provided is described in
the documentation for the interface,
<a href="../apidocs/org/apache/commons/math/util/DoubleArray.html">
- org.apache.commons.math.util.DoubleArray.</a> This interface adds one
- method, <code>addElementRolling(double)</code> to basic list accessors.
+ DoubleArray</a>. This interface adds one method,
+ <code>addElementRolling(double)</code> to basic list accessors.
The <code>addElementRolling</code> method adds an element
(the actual parameter) to the end of the list and removes the first element
in the list.
</p>
<p>
The <a
href="../apidocs/org/apache/commons/math/util/ResizableDoubleArray.html">
- org.apache.commons.math.util.ResizableDoubleArray</a> class provides a
- configurable, array-backed implementation of the <code>DoubleArray</code>
- interface. When <code>addElementRolling</code> is invoked, the underlying
+ ResizableDoubleArray</a> class provides a configurable, array-backed
+ implementation of the <code>DoubleArray</code> interface.
+ When <code>addElementRolling</code> is invoked, the underlying
array is expanded if necessary, the new element is added to the end of the
array and the "usable window" of the array is moved forward, so that
the first element is effectively discarded, what was the second becomes the
@@ -75,8 +75,8 @@
<subsection name="6.3 int/double hash map" href="int_double_hash_map">
<p>
The <a
href="../apidocs/org/apache/commons/math/util/OpenIntToDoubleHashMap.html">
- org.apache.commons.math.util.OpenIntToDoubleHashMap</a> class provides a
specialized
- hash map implementation for int/double. This implementation has a much
smaller memory
+ OpenIntToDoubleHashMap</a> class provides a specialized hash map
+ implementation for int/double. This implementation has a much smaller
memory
overhead than standard <code>java.util.HashMap</code> class. It uses open
addressing
and primitive arrays, which greatly reduces the number of intermediate
objects and
improve data locality.
@@ -86,19 +86,17 @@
<subsection name="6.4 Continued Fractions" href="continued_fractions">
<p>
The <a
href="../apidocs/org/apache/commons/math/util/ContinuedFraction.html">
- org.apache.commons.math.util.ContinuedFraction</a> class provides a generic
- way to create and evaluate continued fractions. The easiest way to create
a
- continued fraction is to subclass <code>ContinuedFraction</code> and
- override the <code>getA</code> and <code>getB</code> methods which return
+ ContinuedFraction</a> class provides a generic way to create and evaluate
+ continued fractions. The easiest way to create a continued fraction is
+ to subclass <code>ContinuedFraction</code> and override the
+ <code>getA</code> and <code>getB</code> methods which return
the continued fraction terms. The precise definition of these terms is
explained in <a href="http://mathworld.wolfram.com/ContinuedFraction.html";>
Continued Fraction, equation (1)</a> from MathWorld.
</p>
<p>
- As an example, the constant Pi could be computed using the continued
fraction
- defined at <a href="http://functions.wolfram.com/Constants/Pi/10/0002/";>
- http://functions.wolfram.com/Constants/Pi/10/0002/</a>. The following
- anonymous class provides the implementation:
+ As an example, the constant Pi can be computed using a <a
href="http://functions.wolfram.com/Constants/Pi/10/0002/";>continued
fraction</a>. The following anonymous class
+ provides the implementation:
<source>ContinuedFraction c = new ContinuedFraction() {
public double getA(int n, double x) {
switch(n) {
@@ -119,11 +117,8 @@
constant).
</p>
<p>
- For a more practical use of continued fractions, consider the exponential
- function with the continued fraction definition of
- <a href="http://functions.wolfram.com/ElementaryFunctions/Exp/10/";>
- http://functions.wolfram.com/ElementaryFunctions/Exp/10/</a>. The
- following anonymous class provides its implementation:
+ For a more practical use of continued fractions, consider the <a
href="http://functions.wolfram.com/ElementaryFunctions/Exp/10/";>exponential
function</a>.
+ The following anonymous class provides its implementation:
<source>ContinuedFraction c = new ContinuedFraction() {
public double getA(int n, double x) {
if (n % 2 == 0) {
@@ -190,4 +185,4 @@
</section>
</body>
-</document>
\ No newline at end of file
+</document>
