Author: tn
Date: Tue Sep 25 13:56:57 2012
New Revision: 1389866
URL: http://svn.apache.org/viewvc?rev=1389866&view=rev
Log:
Javadoc fixes.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/AVLTree.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/AVLTree.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/AVLTree.java?rev=1389866&r1=1389865&r2=1389866&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/AVLTree.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/AVLTree.java
Tue Sep 25 13:56:57 2012
@@ -17,30 +17,30 @@
package org.apache.commons.math3.geometry.partitioning.utilities;
/** This class implements AVL trees.
-
+ *
* <p>The purpose of this class is to sort elements while allowing
* duplicate elements (i.e. such that {@code a.equals(b)} is
* true). The {@code SortedSet} interface does not allow this, so
* a specific class is needed. Null elements are not allowed.</p>
-
+ *
* <p>Since the {@code equals} method is not sufficient to
* differentiate elements, the {@link #delete delete} method is
* implemented using the equality operator.</p>
-
+ *
* <p>In order to clearly mark the methods provided here do not have
* the same semantics as the ones specified in the
* {@code SortedSet} interface, different names are used
* ({@code add} has been replaced by {@link #insert insert} and
* {@code remove} has been replaced by {@link #delete
* delete}).</p>
-
+ *
* <p>This class is based on the C implementation Georg Kraml has put
* in the public domain. Unfortunately, his <a
* href="www.purists.org/georg/avltree/index.html">page</a> seems not
* to exist any more.</p>
-
+ *
* @param <T> the type of the elements
-
+ *
* @version $Id$
* @since 3.0
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java?rev=1389866&r1=1389865&r2=1389866&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
Tue Sep 25 13:56:57 2012
@@ -21,7 +21,7 @@ import java.util.Arrays;
import org.apache.commons.math3.util.FastMath;
/** This class implements an ordering operation for T-uples.
-
+ *
* <p>Ordering is done by encoding all components of the T-uple into a
* single scalar value and using this value as the sorting
* key. Encoding is performed using the method invented by Georg
@@ -38,14 +38,14 @@ import org.apache.commons.math3.util.Fas
* 2<sup>p</sup> offset is added to the components in order to avoid
* negative numbers (this offset is adjusted as needed during the
* comparison operations).</p>
-
+ *
* <p>The more interesting property of the encoding method for our
* purpose is that it allows to select all the points that are in a
* given range. This is depicted in dimension 2 by the following
- * picure:</p>
-
+ * picture:</p>
+ *
* <img src="doc-files/OrderedTuple.png" />
-
+ *
* <p>This picture shows a set of 100000 random 2-D pairs having their
* first component between -50 and +150 and their second component
* between -350 and +50. We wanted to extract all pairs having their
@@ -62,16 +62,16 @@ import org.apache.commons.math3.util.Fas
* the points having their first component between +30 and +31 and
* their second component between -91 and -90, we get a subset of 11
* points, 2 of which really belonging to the desired rectangle.</p>
-
+ *
* <p>the previous selection technique can be applied in all
* dimensions, still using two points to define the interval. The
* first point will have all its components set to their lower bounds
* while the second point will have all its components set to their
* upper bounds.</p>
-
+ *
* <p>T-uples with negative infinite or positive infinite components
* are sorted logically.</p>
-
+ *
* <p>Since the specification of the {@code Comparator} interface
* allows only {@code ClassCastException} errors, some arbitrary
* choices have been made to handle specific cases. The rationale for
@@ -87,7 +87,7 @@ import org.apache.commons.math3.util.Fas
* are considered as if they had {@code Double.NaN}
* components</li>
* </ul>
-
+ *
* @version $Id$
* @since 3.0
*/
