Class SubOrientedPoint
java.lang.Object
org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane<Euclidean1D,Euclidean1D>
org.apache.commons.math3.geometry.euclidean.oned.SubOrientedPoint
- All Implemented Interfaces:
SubHyperplane<Euclidean1D>
This class represents sub-hyperplane for
OrientedPoint.
An hyperplane in 1D is a simple point, its orientation being a boolean.
Instances of this class are guaranteed to be immutable.
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.SubHyperplane
SubHyperplane.SplitSubHyperplane<U extends Space> -
Constructor Summary
ConstructorsConstructorDescriptionSubOrientedPoint(Hyperplane<Euclidean1D> hyperplane, Region<Euclidean1D> remainingRegion) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected AbstractSubHyperplane<Euclidean1D, Euclidean1D> buildNew(Hyperplane<Euclidean1D> hyperplane, Region<Euclidean1D> remainingRegion) Build a sub-hyperplane from an hyperplane and a region.doublegetSize()Get the size of the instance.booleanisEmpty()Check if the instance is empty.split(Hyperplane<Euclidean1D> hyperplane) Split the instance in two parts by an hyperplane.Methods inherited from class org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane
applyTransform, copySelf, getHyperplane, getRemainingRegion, reunite, side
-
Constructor Details
-
SubOrientedPoint
Simple constructor.- Parameters:
hyperplane- underlying hyperplaneremainingRegion- remaining region of the hyperplane
-
-
Method Details
-
getSize
public double getSize()Get the size of the instance.- Specified by:
getSizein interfaceSubHyperplane<Euclidean1D>- Overrides:
getSizein classAbstractSubHyperplane<Euclidean1D,Euclidean1D> - Returns:
- the size of the instance (this is a length in 1D, an area in 2D, a volume in 3D ...)
-
isEmpty
public boolean isEmpty()Check if the instance is empty.- Specified by:
isEmptyin interfaceSubHyperplane<Euclidean1D>- Overrides:
isEmptyin classAbstractSubHyperplane<Euclidean1D,Euclidean1D> - Returns:
- true if the instance is empty
-
buildNew
protected AbstractSubHyperplane<Euclidean1D,Euclidean1D> buildNew(Hyperplane<Euclidean1D> hyperplane, Region<Euclidean1D> remainingRegion) Build a sub-hyperplane from an hyperplane and a region.- Specified by:
buildNewin classAbstractSubHyperplane<Euclidean1D,Euclidean1D> - Parameters:
hyperplane- underlying hyperplaneremainingRegion- remaining region of the hyperplane- Returns:
- a new sub-hyperplane
-
split
Split the instance in two parts by an hyperplane.- Specified by:
splitin interfaceSubHyperplane<Euclidean1D>- Specified by:
splitin classAbstractSubHyperplane<Euclidean1D,Euclidean1D> - Parameters:
hyperplane- splitting hyperplane- Returns:
- an object containing both the part of the instance on the plus side of the hyperplane and the part of the instance on the minus side of the hyperplane
-