commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l..@apache.org
Subject svn commit: r1073473 - /commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java
Date Tue, 22 Feb 2011 19:49:39 GMT
Author: luc
Date: Tue Feb 22 19:49:38 2011
New Revision: 1073473

URL: http://svn.apache.org/viewvc?rev=1073473&view=rev
Log:
added missing @since tags
JIRA: MATH-532

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java?rev=1073473&r1=1073472&r2=1073473&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MathUtils.java Tue
Feb 22 19:49:38 2011
@@ -436,6 +436,7 @@ public final class MathUtils {
      * @param x first value
      * @param y second value
      * @return {@code true} if the values are equal or both are NaN.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(float x, float y) {
         return (Float.isNaN(x) && Float.isNaN(y)) || equals(x, y, 1);
@@ -449,6 +450,7 @@ public final class MathUtils {
      * @param y second value
      * @param eps the amount of absolute error to allow.
      * @return {@code true} if the values are equal or within range of each other.
+     * @since 2.2
      */
     public static boolean equals(float x, float y, float eps) {
         return equals(x, y, 1) || FastMath.abs(y - x) <= eps;
@@ -463,6 +465,7 @@ public final class MathUtils {
      * @param eps the amount of absolute error to allow.
      * @return {@code true} if the values are equal or within range of each other,
      * or both are NaN.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(float x, float y, float eps) {
         return equalsIncludingNaN(x, y) || (FastMath.abs(y - x) <= eps);
@@ -484,6 +487,7 @@ public final class MathUtils {
      * values between {@code x} and {@code y}.
      * @return {@code true} if there are fewer than {@code maxUlps} floating
      * point values between {@code x} and {@code y}.
+     * @since 2.2
      */
     public static boolean equals(float x, float y, int maxUlps) {
         // Check that "maxUlps" is non-negative and small enough so that
@@ -516,6 +520,7 @@ public final class MathUtils {
      * values between {@code x} and {@code y}.
      * @return {@code true} if both arguments are NaN or if there are less than
      * {@code maxUlps} floating point values between {@code x} and {@code y}.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(float x, float y, int maxUlps) {
         return (Float.isNaN(x) && Float.isNaN(y)) || equals(x, y, maxUlps);
@@ -555,6 +560,7 @@ public final class MathUtils {
      * @param y second array
      * @return true if the values are both null or have same dimension and
      * equal elements
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(float[] x, float[] y) {
         if ((x == null) || (y == null)) {
@@ -590,6 +596,7 @@ public final class MathUtils {
      * @param x first value
      * @param y second value
      * @return {@code true} if the values are equal or both are NaN.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(double x, double y) {
         return (Double.isNaN(x) && Double.isNaN(y)) || equals(x, y, 1);
@@ -619,6 +626,7 @@ public final class MathUtils {
      * @param eps the amount of absolute error to allow.
      * @return {@code true} if the values are equal or within range of each other,
      * or both are NaN.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(double x, double y, double eps) {
         return equalsIncludingNaN(x, y) || (FastMath.abs(y - x) <= eps);
@@ -672,6 +680,7 @@ public final class MathUtils {
      * values between {@code x} and {@code y}.
      * @return {@code true} if both arguments are NaN or if there are less than
      * {@code maxUlps} floating point values between {@code x} and {@code y}.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(double x, double y, int maxUlps) {
         return (Double.isNaN(x) && Double.isNaN(y)) || equals(x, y, maxUlps);
@@ -711,6 +720,7 @@ public final class MathUtils {
      * @param y Second array.
      * @return {@code true} if the values are both {@code null} or have same
      * dimension and equal elements.
+     * @since 2.2
      */
     public static boolean equalsIncludingNaN(double[] x, double[] y) {
         if ((x == null) || (y == null)) {
@@ -1972,6 +1982,7 @@ public final class MathUtils {
      * @param dir Ordering direction.
      * @param strict Whether the order should be strict.
      * @throws NonMonotonousSequenceException if the array is not sorted.
+     * @since 2.2
      */
     public static void checkOrder(double[] val, OrderDirection dir,
                                   boolean strict) {
@@ -1983,6 +1994,7 @@ public final class MathUtils {
      *
      * @param val Values.
      * @throws NonMonotonousSequenceException if the array is not sorted.
+     * @since 2.2
      */
     public static void checkOrder(double[] val) {
         checkOrder(val, OrderDirection.INCREASING, true);
@@ -2075,6 +2087,7 @@ public final class MathUtils {
      *
      * @param v vector of doubles
      * @return the 2-norm of the vector
+     * @since 2.2
      */
     public static double safeNorm(double[] v) {
         double rdwarf = 3.834e-20;



Mime
View raw message