psteitz 2004/07/21 19:34:26
Modified: math/src/java/org/apache/commons/math/analysis
PolynomialSplineFunction.java
math/src/java/org/apache/commons/math/random
EmpiricalDistribution.java RandomDataImpl.java
Log:
javadoc
Revision Changes Path
1.9 +2 -2
jakarta-commons/math/src/java/org/apache/commons/math/analysis/PolynomialSplineFunction.java
Index: PolynomialSplineFunction.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/analysis/PolynomialSplineFunction.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- PolynomialSplineFunction.java 20 Jul 2004 12:55:01 -0000 1.8
+++ PolynomialSplineFunction.java 22 Jul 2004 02:34:25 -0000 1.9
@@ -24,7 +24,7 @@
* Represents a polynomial spline function.
* <p>
* A <strong>polynomial spline function</strong> consists of a set of
- * <i>interpolating polynomials</i> and an ascending array of domain
+ * <i>interpolating polynomials</i> and an ascending array of domain
* <i>knot points</i>, determining the intervals over which the spline function
* is defined by the constituent polynomials. The polynomials are assumed to
* have been computed to match the values of another function at the knot
1.22 +8 -5
jakarta-commons/math/src/java/org/apache/commons/math/random/EmpiricalDistribution.java
Index: EmpiricalDistribution.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/random/EmpiricalDistribution.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- EmpiricalDistribution.java 18 Jul 2004 23:57:11 -0000 1.21
+++ EmpiricalDistribution.java 22 Jul 2004 02:34:25 -0000 1.22
@@ -83,7 +83,9 @@
/**
- * Returns a [EMAIL PROTECTED] StatisticalSummary} describing this distribution.
+ * Returns a
+ * [EMAIL PROTECTED]
org.apache.commons.math.stat.univariate.StatisticalSummary}
+ * describing this distribution.
* <strong>Preconditions:</strong><ul>
* <li>the distribution must be loaded before invoking this method</li>
* </ul>
@@ -108,9 +110,10 @@
int getBinCount();
/**
- * Returns a list of [EMAIL PROTECTED] SummaryStatistics} containing statistics
- * describing the values in each of the bins. The List is indexed on
- * the bin number.
+ * Returns a list of
+ * [EMAIL PROTECTED] org.apache.commons.math.stat.univariate.SummaryStatistics}
+ * containing statistics describing the values in each of the bins. The
+ * List is indexed on the bin number.
*
* @return List of bin statistics
*/
1.16 +48 -33
jakarta-commons/math/src/java/org/apache/commons/math/random/RandomDataImpl.java
Index: RandomDataImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/random/RandomDataImpl.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- RandomDataImpl.java 14 Jun 2004 23:15:15 -0000 1.15
+++ RandomDataImpl.java 22 Jul 2004 02:34:25 -0000 1.16
@@ -25,18 +25,16 @@
import java.util.Collection;
/**
- * Implements the <code>RandomData</code> interface using
- * <code>java.util.Random</code> and
- * <code>java.util.Random.SecureRandom</code> instances to generate data.
+ * Implements the [EMAIL PROTECTED] RandomData} interface using
+ * [EMAIL PROTECTED] java.util.Random} and [EMAIL PROTECTED]
java.util.Random.SecureRandom} instances
+ * to generate data.
* <p>
- * Supports reseeding the underlying
- * <a href="http://en.wikipedia.org/wiki/Pseudorandom_number_generator";>
- * PRNG</a>. The <code>SecurityProvider</code> and <code>Algorithm</code>
+ * Supports reseeding the underlying pseudo-random number generator (PRNG).
+ * The <code>SecurityProvider</code> and <code>Algorithm</code>
* used by the <code>SecureRandom</code> instance can also be reset.
* <p>
- * For details on the PRNGs, see the JDK documentation for
- * <code>java.util.Random</code> and
- * <code>java.util.Random.SecureRandom</code>
+ * For details on the PRNGs, see [EMAIL PROTECTED] java.util.Random} and
+ * [EMAIL PROTECTED] java.util.Random.SecureRandom}.
* <p>
* <strong>Usage Notes</strong>: <ul>
* <li>
@@ -45,9 +43,13 @@
* to generate a random sequence of values or strings, you should use just
* <strong>one</strong> <code>RandomDataImpl</code> instance repeatedly.</li>
* <li>
- * The "secure" methods are *much* slower. These should be used only when
- * a <a
href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator";>
- * Secure Random Sequence</a> is required.</li>
+ * The "secure" methods are *much* slower. These should be used only when a
+ * cryptographically secure random sequence is required. A secure random
+ * sequence is a sequence of pseudo-random values which, in addition to being
+ * well-dispersed (so no subsequence of values is an any more likely than other
+ * subsequence of the the same length), also has the additional property that
+ * knowledge of values generated up to any point in the sequence does not make
+ * it any easier to predict subsequent values.</li>
* <li>
* When a new <code>RandomDataImpl</code> is created, the underlying random
* number generators are <strong>not</strong> intialized. The first call to a
@@ -64,7 +66,10 @@
* results in the same subsequent random sequence); whereas reSeedSecure(long)
* does <strong>not</strong> reinitialize the secure random number generator
* (so secure sequences started with calls to reseedSecure(long) won't be
- * identical).</li></ul>
+ * identical).</li>
+ * <li>
+ * This implementation is not synchronized.
+ * </ul>
*
* @version $Revision$ $Date$
*/
@@ -133,6 +138,7 @@
/**
* Generate a random int value uniformly distributed between
* <code>lower</code> and <code>upper</code>, inclusive.
+ *
* @param lower the lower bound.
* @param upper the upper bound.
* @return the random integer.
@@ -149,6 +155,7 @@
/**
* Generate a random long value uniformly distributed between
* <code>lower</code> and <code>upper</code>, inclusive.
+ *
* @param lower the lower bound.
* @param upper the upper bound.
* @return the random integer.
@@ -171,12 +178,10 @@
* <li>
* SHA-1 hash is applied to yield a 20-byte binary digest.</li>
* <li>
- * Each byte of the binary digest is converted to 2 hex digits</li></ol>
- * <p>
- * TODO: find external reference or provide justification for the claim
- * that this yields a cryptographically secure sequence of hex strings.
- * @param len the desired string length.
- * @return the random string.
+ * Each byte of the binary digest is converted to 2 hex digits.</li></ol>
+ *
+ * @param len the length of the generated string
+ * @return the random string
*/
public String nextSecureHexString(int len) {
if (len <= 0) {
@@ -229,7 +234,8 @@
/**
* Generate a random int value uniformly distributed between
* <code>lower</code> and <code>upper</code>, inclusive. This algorithm
- * using a secure random number generator for its engine.
+ * uses a secure random number generator.
+ *
* @param lower the lower bound.
* @param upper the upper bound.
* @return the random integer.
@@ -246,7 +252,8 @@
/**
* Generate a random long value uniformly distributed between
* <code>lower</code> and <code>upper</code>, inclusive. This algorithm
- * using a secure random number generator for its engine.
+ * uses a secure random number generator.
+ *
* @param lower the lower bound.
* @param upper the upper bound.
* @return the random integer.
@@ -261,7 +268,8 @@
}
/**
- * Generates a random long value from the Poisson distribution with the given
mean.
+ * Generates a random long value from the Poisson distribution with the
+ * given mean.
* <p>
* <strong>Algorithm Description</strong>:
* Uses simulation of a Poisson process using Uniform deviates, as
@@ -269,7 +277,9 @@
* <a href ="http://dmawww.epfl.ch/benarous/Pmmi/interactive/rng7.htm";>
* here.</a>
* <p>
- * The Poisson process (and hence value returned) is bounded by 1000 * mean.
+ * The Poisson process (and hence value returned) is bounded by
+ * 1000 * mean.
+ *
* @param mean mean of the Poisson distribution.
* @return the random Poisson value.
*/
@@ -295,13 +305,13 @@
}
/**
- * Generate a random value from a Normal distribution. This algorithm
- * generates random values for the general Normal distribution with the
- * given mean, <code>mu</code> and the given standard deviation,
+ * Generate a random value from a Normal (a.k.a. Gaussian) distribution
+ * with the given mean, <code>mu</code> and the given standard deviation,
* <code>sigma</code>.
- * @param mu the mean of the distribution.
- * @param sigma the standard deviation of the distribution.
- * @return the random Normal value.
+ *
+ * @param mu the mean of the distribution
+ * @param sigma the standard deviation of the distribution
+ * @return the random Normal value
*/
public double nextGaussian(double mu, double sigma) {
if (sigma <= 0) {
@@ -312,11 +322,16 @@
}
/**
+ * Returns a random value from an Exponential distribution with the given
+ * mean.
+ * <p>
* <strong>Algorithm Description</strong>: Uses the
* <a href="http://www.jesus.ox.ac.uk/~clifford/a5/chap1/node5.html";>
- * Inversion Method</a> to generate exponential from uniform deviates.
- * @param mean the mean of the distribution.
- * @return the random Exponential value.
+ * Inversion Method</a> to generate exponentially distributed random values
+ * from uniform deviates.
+ *
+ * @param mean the mean of the distribution
+ * @return the random Exponential value
*/
public double nextExponential(double mean) {
if (mean < 0.0) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
