Javadoc fixes.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1389866 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
282bb0eaa6
commit
774257e3a7
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -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.FastMath;
|
|||
* 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.FastMath;
|
|||
* 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.FastMath;
|
|||
* are considered as if they had {@code Double.NaN}
|
||||
* components</li>
|
||||
* </ul>
|
||||
|
||||
*
|
||||
* @version $Id$
|
||||
* @since 3.0
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue