commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1612042 - in /commons/proper/math/trunk/src: main/java/org/apache/commons/math3/fraction/ main/java/org/apache/commons/math3/random/ test/java/org/apache/commons/math3/analysis/polynomials/
Date Sun, 20 Jul 2014 06:57:54 GMT
Author: ggregory
Date: Sun Jul 20 06:57:53 2014
New Revision: 1612042

URL: http://svn.apache.org/r1612042
Log:
Use the more modern, compact, and flexible Javadoc "{@code ...}" instead of the HTML "<tt>...</tt>".

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/BigFraction.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/Fraction.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/BitsStreamGenerator.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomAdaptor.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataGenerator.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomGenerator.java
    commons/proper/math/trunk/src/test/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionTest.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/BigFraction.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/BigFraction.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/BigFraction.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/BigFraction.java
Sun Jul 20 06:57:53 2014
@@ -97,7 +97,7 @@ public class BigFraction
 
     /**
      * <p>
-     * Create a {@link BigFraction} equivalent to the passed <tt>BigInteger</tt>,
ie
+     * Create a {@link BigFraction} equivalent to the passed {@code BigInteger}, ie
      * "num / 1".
      * </p>
      *
@@ -362,7 +362,7 @@ public class BigFraction
 
     /**
      * <p>
-     * Create a {@link BigFraction} equivalent to the passed <tt>int</tt>, ie
+     * Create a {@link BigFraction} equivalent to the passed {@code int}, ie
      * "num / 1".
      * </p>
      *
@@ -376,7 +376,7 @@ public class BigFraction
     /**
      * <p>
      * Create a {@link BigFraction} given the numerator and denominator as simple
-     * <tt>int</tt>. The {@link BigFraction} is reduced to lowest terms.
+     * {@code int}. The {@link BigFraction} is reduced to lowest terms.
      * </p>
      *
      * @param num
@@ -403,7 +403,7 @@ public class BigFraction
     /**
      * <p>
      * Create a {@link BigFraction} given the numerator and denominator as simple
-     * <tt>long</tt>. The {@link BigFraction} is reduced to lowest terms.
+     * {@code long}. The {@link BigFraction} is reduced to lowest terms.
      * </p>
      *
      * @param num
@@ -473,12 +473,12 @@ public class BigFraction
 
     /**
      * <p>
-     * Adds the value of this fraction to the passed <tt>integer</tt>, returning
+     * Adds the value of this fraction to the passed {@code integer}, returning
      * the result in reduced form.
      * </p>
      *
      * @param i
-     *            the <tt>integer</tt> to add.
+     *            the {@code integer} to add.
      * @return a <code>BigFraction</code> instance with the resulting values.
      */
     public BigFraction add(final int i) {
@@ -487,12 +487,12 @@ public class BigFraction
 
     /**
      * <p>
-     * Adds the value of this fraction to the passed <tt>long</tt>, returning
+     * Adds the value of this fraction to the passed {@code long}, returning
      * the result in reduced form.
      * </p>
      *
      * @param l
-     *            the <tt>long</tt> to add.
+     *            the {@code long} to add.
      * @return a <code>BigFraction</code> instance with the resulting values.
      */
     public BigFraction add(final long l) {
@@ -559,7 +559,7 @@ public class BigFraction
      *            rounding mode to apply. see {@link BigDecimal} constants.
      * @return the fraction as a <code>BigDecimal</code>.
      * @throws IllegalArgumentException
-     *             if <tt>roundingMode</tt> does not represent a valid rounding
+     *             if {@code roundingMode} does not represent a valid rounding
      *             mode.
      * @see BigDecimal
      */
@@ -593,8 +593,8 @@ public class BigFraction
      *
      * @param object
      *            the object to compare to, must not be <code>null</code>.
-     * @return -1 if this is less than <tt>object</tt>, +1 if this is greater
-     *         than <tt>object</tt>, 0 if they are equal.
+     * @return -1 if this is less than {@code object}, +1 if this is greater
+     *         than {@code object}, 0 if they are equal.
      * @see java.lang.Comparable#compareTo(java.lang.Object)
      */
     public int compareTo(final BigFraction object) {
@@ -676,11 +676,11 @@ public class BigFraction
 
     /**
      * <p>
-     * Gets the fraction as a <tt>double</tt>. This calculates the fraction as
+     * Gets the fraction as a {@code double}. This calculates the fraction as
      * the numerator divided by denominator.
      * </p>
      *
-     * @return the fraction as a <tt>double</tt>
+     * @return the fraction as a {@code double}
      * @see java.lang.Number#doubleValue()
      */
     @Override
@@ -729,11 +729,11 @@ public class BigFraction
 
     /**
      * <p>
-     * Gets the fraction as a <tt>float</tt>. This calculates the fraction as
+     * Gets the fraction as a {@code float}. This calculates the fraction as
      * the numerator divided by denominator.
      * </p>
      *
-     * @return the fraction as a <tt>float</tt>.
+     * @return the fraction as a {@code float}.
      * @see java.lang.Number#floatValue()
      */
     @Override
@@ -763,10 +763,10 @@ public class BigFraction
 
     /**
      * <p>
-     * Access the denominator as a <tt>int</tt>.
+     * Access the denominator as a {@code int}.
      * </p>
      *
-     * @return the denominator as a <tt>int</tt>.
+     * @return the denominator as a {@code int}.
      */
     public int getDenominatorAsInt() {
         return denominator.intValue();
@@ -774,10 +774,10 @@ public class BigFraction
 
     /**
      * <p>
-     * Access the denominator as a <tt>long</tt>.
+     * Access the denominator as a {@code long}.
      * </p>
      *
-     * @return the denominator as a <tt>long</tt>.
+     * @return the denominator as a {@code long}.
      */
     public long getDenominatorAsLong() {
         return denominator.longValue();
@@ -796,10 +796,10 @@ public class BigFraction
 
     /**
      * <p>
-     * Access the numerator as a <tt>int</tt>.
+     * Access the numerator as a {@code int}.
      * </p>
      *
-     * @return the numerator as a <tt>int</tt>.
+     * @return the numerator as a {@code int}.
      */
     public int getNumeratorAsInt() {
         return numerator.intValue();
@@ -807,10 +807,10 @@ public class BigFraction
 
     /**
      * <p>
-     * Access the numerator as a <tt>long</tt>.
+     * Access the numerator as a {@code long}.
      * </p>
      *
-     * @return the numerator as a <tt>long</tt>.
+     * @return the numerator as a {@code long}.
      */
     public long getNumeratorAsLong() {
         return numerator.longValue();
@@ -831,7 +831,7 @@ public class BigFraction
 
     /**
      * <p>
-     * Gets the fraction as an <tt>int</tt>. This returns the whole number part
+     * Gets the fraction as an {@code int}. This returns the whole number part
      * of the fraction.
      * </p>
      *
@@ -845,7 +845,7 @@ public class BigFraction
 
     /**
      * <p>
-     * Gets the fraction as a <tt>long</tt>. This returns the whole number part
+     * Gets the fraction as a {@code long}. This returns the whole number part
      * of the fraction.
      * </p>
      *
@@ -876,12 +876,12 @@ public class BigFraction
 
     /**
      * <p>
-     * Multiply the value of this fraction by the passed <tt>int</tt>, returning
+     * Multiply the value of this fraction by the passed {@code int}, returning
      * the result in reduced form.
      * </p>
      *
      * @param i
-     *            the <tt>int</tt> to multiply by.
+     *            the {@code int} to multiply by.
      * @return a {@link BigFraction} instance with the resulting values.
      */
     public BigFraction multiply(final int i) {
@@ -890,12 +890,12 @@ public class BigFraction
 
     /**
      * <p>
-     * Multiply the value of this fraction by the passed <tt>long</tt>,
+     * Multiply the value of this fraction by the passed {@code long},
      * returning the result in reduced form.
      * </p>
      *
      * @param l
-     *            the <tt>long</tt> to multiply by.
+     *            the {@code long} to multiply by.
      * @return a {@link BigFraction} instance with the resulting values.
      */
     public BigFraction multiply(final long l) {
@@ -938,11 +938,11 @@ public class BigFraction
 
     /**
      * <p>
-     * Gets the fraction percentage as a <tt>double</tt>. This calculates the
+     * Gets the fraction percentage as a {@code double}. This calculates the
      * fraction as the numerator divided by denominator multiplied by 100.
      * </p>
      *
-     * @return the fraction percentage as a <tt>double</tt>.
+     * @return the fraction percentage as a {@code double}.
      */
     public double percentageValue() {
         return multiply(ONE_HUNDRED).doubleValue();

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/Fraction.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/Fraction.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/Fraction.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/fraction/Fraction.java
Sun Jul 20 06:57:53 2014
@@ -308,8 +308,8 @@ public class Fraction
     /**
      * Compares this object to another based on size.
      * @param object the object to compare to
-     * @return -1 if this is less than <tt>object</tt>, +1 if this is greater
-     *         than <tt>object</tt>, 0 if they are equal.
+     * @return -1 if this is less than {@code object}, +1 if this is greater
+     *         than {@code object}, 0 if they are equal.
      */
     public int compareTo(Fraction object) {
         long nOd = ((long) numerator) * object.denominator;
@@ -318,9 +318,9 @@ public class Fraction
     }
 
     /**
-     * Gets the fraction as a <tt>double</tt>. This calculates the fraction as
+     * Gets the fraction as a {@code double}. This calculates the fraction as
      * the numerator divided by denominator.
-     * @return the fraction as a <tt>double</tt>
+     * @return the fraction as a {@code double}
      */
     @Override
     public double doubleValue() {
@@ -333,7 +333,7 @@ public class Fraction
      * fractions are considered to be equal.
      * @param other fraction to test for equality to this fraction
      * @return true if two fractions are equal, false if object is
-     *         <tt>null</tt>, not an instance of {@link Fraction}, or not equal
+     *         {@code null}, not an instance of {@link Fraction}, or not equal
      *         to this fraction instance.
      */
     @Override
@@ -352,9 +352,9 @@ public class Fraction
     }
 
     /**
-     * Gets the fraction as a <tt>float</tt>. This calculates the fraction as
+     * Gets the fraction as a {@code float}. This calculates the fraction as
      * the numerator divided by denominator.
-     * @return the fraction as a <tt>float</tt>
+     * @return the fraction as a {@code float}
      */
     @Override
     public float floatValue() {
@@ -387,7 +387,7 @@ public class Fraction
     }
 
     /**
-     * Gets the fraction as an <tt>int</tt>. This returns the whole number part
+     * Gets the fraction as an {@code int}. This returns the whole number part
      * of the fraction.
      * @return the whole number fraction part
      */
@@ -397,7 +397,7 @@ public class Fraction
     }
 
     /**
-     * Gets the fraction as a <tt>long</tt>. This returns the whole number part
+     * Gets the fraction as a {@code long}. This returns the whole number part
      * of the fraction.
      * @return the whole number fraction part
      */
@@ -441,7 +441,7 @@ public class Fraction
 
     /**
      * Add an integer to the fraction.
-     * @param i the <tt>integer</tt> to add.
+     * @param i the {@code integer} to add.
      * @return this + i
      */
     public Fraction add(final int i) {
@@ -464,7 +464,7 @@ public class Fraction
 
     /**
      * Subtract an integer from the fraction.
-     * @param i the <tt>integer</tt> to subtract.
+     * @param i the {@code integer} to subtract.
      * @return this - i
      */
     public Fraction subtract(final int i) {
@@ -556,7 +556,7 @@ public class Fraction
 
     /**
      * Multiply the fraction by an integer.
-     * @param i the <tt>integer</tt> to multiply by.
+     * @param i the {@code integer} to multiply by.
      * @return this * i
      */
     public Fraction multiply(final int i) {
@@ -586,7 +586,7 @@ public class Fraction
 
     /**
      * Divide the fraction by an integer.
-     * @param i the <tt>integer</tt> to divide by.
+     * @param i the {@code integer} to divide by.
      * @return this * i
      */
     public Fraction divide(final int i) {
@@ -595,11 +595,11 @@ public class Fraction
 
     /**
      * <p>
-     * Gets the fraction percentage as a <tt>double</tt>. This calculates the
+     * Gets the fraction percentage as a {@code double}. This calculates the
      * fraction as the numerator divided by denominator multiplied by 100.
      * </p>
      *
-     * @return the fraction percentage as a <tt>double</tt>.
+     * @return the fraction percentage as a {@code double}.
      */
     public double percentageValue() {
         return 100 * doubleValue();

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/BitsStreamGenerator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/BitsStreamGenerator.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/BitsStreamGenerator.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/BitsStreamGenerator.java
Sun Jul 20 06:57:53 2014
@@ -163,13 +163,13 @@ public abstract class BitsStreamGenerato
     }
 
     /**
-     * Returns a pseudorandom, uniformly distributed <tt>long</tt> value
+     * Returns a pseudorandom, uniformly distributed {@code long} value
      * between 0 (inclusive) and the specified value (exclusive), drawn from
      * this random number generator's sequence.
      *
      * @param n the bound on the random number to be returned.  Must be
      * positive.
-     * @return  a pseudorandom, uniformly distributed <tt>long</tt>
+     * @return  a pseudorandom, uniformly distributed {@code long}
      * value between 0 (inclusive) and n (exclusive).
      * @throws IllegalArgumentException  if n is not positive.
      */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomAdaptor.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomAdaptor.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomAdaptor.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomAdaptor.java
Sun Jul 20 06:57:53 2014
@@ -132,7 +132,7 @@ public class RandomAdaptor extends Rando
      /**
      * Returns the next pseudorandom, uniformly distributed <code>int</code>
      * value from this random number generator's sequence.
-     * All 2<font size="-1"><sup>32</sup></font> possible <tt>int</tt>
values
+     * All 2<font size="-1"><sup>32</sup></font> possible {@code
int} values
      * should be produced with  (approximately) equal probability.
      *
      * @return the next pseudorandom, uniformly distributed <code>int</code>
@@ -144,13 +144,13 @@ public class RandomAdaptor extends Rando
     }
 
     /**
-     * Returns a pseudorandom, uniformly distributed <tt>int</tt> value
+     * Returns a pseudorandom, uniformly distributed {@code int} value
      * between 0 (inclusive) and the specified value (exclusive), drawn from
      * this random number generator's sequence.
      *
      * @param n the bound on the random number to be returned.  Must be
      * positive.
-     * @return  a pseudorandom, uniformly distributed <tt>int</tt>
+     * @return  a pseudorandom, uniformly distributed {@code int}
      * value between 0 (inclusive) and n (exclusive).
      * @throws IllegalArgumentException  if n is not positive.
      */
@@ -162,7 +162,7 @@ public class RandomAdaptor extends Rando
     /**
      * Returns the next pseudorandom, uniformly distributed <code>long</code>
      * value from this random number generator's sequence.  All
-     * 2<font size="-1"><sup>64</sup></font> possible <tt>long</tt>
values
+     * 2<font size="-1"><sup>64</sup></font> possible {@code long}
values
      * should be produced with (approximately) equal probability.
      *
      * @return  the next pseudorandom, uniformly distributed <code>long</code>

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataGenerator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataGenerator.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataGenerator.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataGenerator.java
Sun Jul 20 06:57:53 2014
@@ -226,14 +226,14 @@ public class RandomDataGenerator impleme
     }
 
     /**
-     * Returns a pseudorandom, uniformly distributed <tt>long</tt> value
+     * Returns a pseudorandom, uniformly distributed {@code long} value
      * between 0 (inclusive) and the specified value (exclusive), drawn from
      * this random number generator's sequence.
      *
      * @param rng random generator to use
      * @param n the bound on the random number to be returned.  Must be
      * positive.
-     * @return  a pseudorandom, uniformly distributed <tt>long</tt>
+     * @return  a pseudorandom, uniformly distributed {@code long}
      * value between 0 (inclusive) and n (exclusive).
      * @throws IllegalArgumentException  if n is not positive.
      */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomGenerator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomGenerator.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomGenerator.java
(original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomGenerator.java
Sun Jul 20 06:57:53 2014
@@ -69,7 +69,7 @@ public interface RandomGenerator {
     /**
      * Returns the next pseudorandom, uniformly distributed <code>int</code>
      * value from this random number generator's sequence.
-     * All 2<font size="-1"><sup>32</sup></font> possible <tt>int</tt>
values
+     * All 2<font size="-1"><sup>32</sup></font> possible {@code
int} values
      * should be produced with  (approximately) equal probability.
      *
      * @return the next pseudorandom, uniformly distributed <code>int</code>
@@ -78,13 +78,13 @@ public interface RandomGenerator {
     int nextInt();
 
     /**
-     * Returns a pseudorandom, uniformly distributed <tt>int</tt> value
+     * Returns a pseudorandom, uniformly distributed {@code int} value
      * between 0 (inclusive) and the specified value (exclusive), drawn from
      * this random number generator's sequence.
      *
      * @param n the bound on the random number to be returned.  Must be
      * positive.
-     * @return  a pseudorandom, uniformly distributed <tt>int</tt>
+     * @return  a pseudorandom, uniformly distributed {@code int}
      * value between 0 (inclusive) and n (exclusive).
      * @throws IllegalArgumentException  if n is not positive.
      */
@@ -93,7 +93,7 @@ public interface RandomGenerator {
     /**
      * Returns the next pseudorandom, uniformly distributed <code>long</code>
      * value from this random number generator's sequence.  All
-     * 2<font size="-1"><sup>64</sup></font> possible <tt>long</tt>
values
+     * 2<font size="-1"><sup>64</sup></font> possible {@code long}
values
      * should be produced with (approximately) equal probability.
      *
      * @return  the next pseudorandom, uniformly distributed <code>long</code>

Modified: commons/proper/math/trunk/src/test/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionTest.java?rev=1612042&r1=1612041&r2=1612042&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionTest.java
(original)
+++ commons/proper/math/trunk/src/test/java/org/apache/commons/math3/analysis/polynomials/PolynomialFunctionTest.java
Sun Jul 20 06:57:53 2014
@@ -60,7 +60,7 @@ public final class PolynomialFunctionTes
      * <p>This will test the function f(x) = 3*x - 1.5</p>
      * <p>This will have the values
      *  <tt>f(0) = -1.5, f(-1) = -4.5, f(-2.5) = -9,
-     *      f(0.5) = 0, f(1.5) = 3</tt> and <tt>f(3) = 7.5</tt>
+     *      f(0.5) = 0, f(1.5) = 3</tt> and {@code f(3) = 7.5}
      * </p>
      */
     @Test
@@ -129,8 +129,8 @@ public final class PolynomialFunctionTes
      * tests the firstDerivative function by comparison
      *
      * <p>This will test the functions
-     * <tt>f(x) = x^3 - 2x^2 + 6x + 3, g(x) = 3x^2 - 4x + 6</tt>
-     * and <tt>h(x) = 6x - 4</tt>
+     * {@code f(x) = x^3 - 2x^2 + 6x + 3, g(x) = 3x^2 - 4x + 6}
+     * and {@code h(x) = 6x - 4}
      */
     @Test
     public void testfirstDerivativeComparison() {
@@ -228,8 +228,8 @@ public final class PolynomialFunctionTes
      * tests the firstDerivative function by comparison
      *
      * <p>This will test the functions
-     * <tt>f(x) = x^3 - 2x^2 + 6x + 3, g(x) = 3x^2 - 4x + 6</tt>
-     * and <tt>h(x) = 6x - 4</tt>
+     * {@code f(x) = x^3 - 2x^2 + 6x + 3, g(x) = 3x^2 - 4x + 6}
+     * and {@code h(x) = 6x - 4}
      */
     @Test
     public void testMath341() {



Mime
View raw message