|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.math3.geometry.euclidean.oned.OrientedPoint
public class OrientedPoint
This class represents a 1D oriented hyperplane.
An hyperplane in 1D is a simple point, its orientation being a boolean.
Instances of this class are guaranteed to be immutable.
Constructor Summary | |
---|---|
OrientedPoint(Vector1D location,
boolean direct)
Simple constructor. |
Method Summary | |
---|---|
OrientedPoint |
copySelf()
Copy the instance. |
Vector1D |
getLocation()
Get the hyperplane location on the real line. |
double |
getOffset(Vector<Euclidean1D> point)
Get the offset (oriented distance) of a point. |
boolean |
isDirect()
Check if the hyperplane orientation is direct. |
void |
revertSelf()
Revert the instance. |
boolean |
sameOrientationAs(Hyperplane<Euclidean1D> other)
Check if the instance has the same orientation as another hyperplane. |
SubOrientedPoint |
wholeHyperplane()
Build a region covering the whole hyperplane. |
IntervalsSet |
wholeSpace()
Build a region covering the whole space. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OrientedPoint(Vector1D location, boolean direct)
location
- location of the hyperplanedirect
- if true, the plus side of the hyperplane is towards
abscissas greater than location
Method Detail |
---|
public OrientedPoint copySelf()
Since instances are immutable, this method directly returns the instance.
copySelf
in interface Hyperplane<Euclidean1D>
public double getOffset(Vector<Euclidean1D> point)
The offset is 0 if the point is on the underlying hyperplane, it is positive if the point is on one particular side of the hyperplane, and it is negative if the point is on the other side, according to the hyperplane natural orientation.
getOffset
in interface Hyperplane<Euclidean1D>
point
- point to check
public SubOrientedPoint wholeHyperplane()
Since this class represent zero dimension spaces which does
not have lower dimension sub-spaces, this method returns a dummy
implementation of a SubHyperplane
.
This implementation is only used to allow the SubHyperplane
class implementation to work properly, it should
not be used otherwise.
wholeHyperplane
in interface Hyperplane<Euclidean1D>
public IntervalsSet wholeSpace()
wholeSpace
in interface Hyperplane<Euclidean1D>
IntervalsSet
instance)public boolean sameOrientationAs(Hyperplane<Euclidean1D> other)
This method is expected to be called on parallel hyperplanes. The method should not re-check for parallelism, only for orientation, typically by testing something like the sign of the dot-products of normals.
sameOrientationAs
in interface Hyperplane<Euclidean1D>
other
- other hyperplane to check against the instance
public Vector1D getLocation()
public boolean isDirect()
public void revertSelf()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |