Author: psteitz
Date: Tue Jul 4 14:01:10 2006
New Revision: 419099
URL: http://svn.apache.org/viewvc?rev=419099&view=rev
Log:
Improved javadoc for nextAfter.
Modified:
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
Modified:
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java?rev=419099&r1=419098&r2=419099&view=diff
==============================================================================
---
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
(original)
+++
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
Tue Jul 4 14:01:10 2006
@@ -474,13 +474,20 @@
}
/**
- * Get the closest machine representable number
- * from a number in some direction.
-
+ * Get the next machine representable number after a number, moving
+ * in the direction of another number.
+ * <p>
+ * If <code>direction</code> is greater than or equal to<code>d</code>,
+ * the smallest machine representable number strictly greater than
+ * <code>d</code> is returned; otherwise the largest representable number
+ * strictly less than <code>d</code> is returned.
+ * <p>
+ * If <code>d</code> is NaN or Infinite, it is returned unchanged.
+ *
* @param d base number
* @param direction (the only important thing is whether
* direction is greater or smaller than d)
- * @return
+ * @return the next machine representable number in the specified direction
*/
public static double nextAfter(double d, double direction) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
