Apache/commons-math
1
0
Fork 0
mirror of https://github.com/apache/commons-math.git synced 2025-02-06 10:09:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved javadoc

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1560336 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2014-01-22 12:39:14 +00:00
parent e02b8f8a5a
commit 1fc112d053
3 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.java
View File

@ -21,9 +21,10 @@ import org.apache.commons.math3.geometry.Space;
/** Class holding boundary attributes. /** Class holding boundary attributes.
* <p>This class is used for the attributes associated with the * <p>This class is used for the attributes associated with the
* nodes of region boundary shell trees returned by the {@link * nodes of region boundary shell trees returned by the {@link
* Region#getTree Region.getTree}. It contains the * Region#getTree(boolean) Region.getTree(includeBoundaryAttributes)}
* parts of the node cut sub-hyperplane that belong to the * when the boolean {@code includeBoundaryAttributes} parameter is
* boundary.</p> * set to {@code true}. It contains the parts of the node cut
* sub-hyperplane that belong to the boundary.</p>
* <p>This class is a simple placeholder, it does not provide any * <p>This class is a simple placeholder, it does not provide any
* processing methods.</p> * processing methods.</p>
* @param <S> Type of the space. * @param <S> Type of the space.

8
src/main/java/org/apache/commons/math3/geometry/partitioning/Region.java
View File

@ -136,10 +136,10 @@ public interface Region<S extends Space> {
* all internal nodes are guaranteed to have non-null * all internal nodes are guaranteed to have non-null
* attributes, however some {@link BoundaryAttribute * attributes, however some {@link BoundaryAttribute
* BoundaryAttribute} instances may have their {@link * BoundaryAttribute} instances may have their {@link
* BoundaryAttribute#plusInside plusInside} and {@link * BoundaryAttribute#getPlusInside() getPlusInside} and {@link
* BoundaryAttribute#plusOutside plusOutside} fields both null if * BoundaryAttribute#getPlusOutside() getPlusOutside} methods both
* the corresponding cut sub-hyperplane does not have any parts * returning null if the corresponding cut sub-hyperplane does not
* belonging to the boundary.</p> * have any parts belonging to the boundary.</p>
* <p>Since computing the boundary is not always required and can be * <p>Since computing the boundary is not always required and can be
* time-consuming for large trees, these internal nodes attributes * time-consuming for large trees, these internal nodes attributes

4
src/main/java/org/apache/commons/math3/geometry/spherical/oned/ArcsSet.java
View File

@ -889,8 +889,8 @@ public class ArcsSet extends AbstractRegion<Sphere1D, Sphere1D> implements Itera
/** Specialized exception for inconsistent BSP tree state inconsistency. /** Specialized exception for inconsistent BSP tree state inconsistency.
* <p> * <p>
* This exception is thrown at {@link ArcsSet} construction time when the * This exception is thrown at {@link ArcsSet} construction time when the
* {@link Location inside/outside} state is not consistent at the 0, * {@link org.apache.commons.math3.geometry.partitioning.Region.Location inside/outside}
* \(2 \pi \) crossing. * state is not consistent at the 0, \(2 \pi \) crossing.
* </p> * </p>
*/ */
public static class InconsistentStateAt2PiWrapping extends MathIllegalArgumentException { public static class InconsistentStateAt2PiWrapping extends MathIllegalArgumentException {