Class OrientedPoint
- All Implemented Interfaces:
Hyperplane<Euclidean1D>
An hyperplane in 1D is a simple point, its orientation being a boolean.
Instances of this class are guaranteed to be immutable.
-
Constructor Summary
ConstructorDescriptionOrientedPoint
(Vector1D location, boolean direct, double tolerance) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptioncopySelf()
Copy the instance.Build a sub-hyperplane covering nothing.Get the hyperplane location on the real line.double
getOffset
(Point<Euclidean1D> point) Get the offset (oriented distance) of a point.double
getOffset
(Vector<Euclidean1D, Vector1D> vector) Get the offset (oriented distance) of a vector.double
Get the tolerance below which points are considered to belong to the hyperplane.boolean
isDirect()
Check if the hyperplane orientation is direct.project
(Point<Euclidean1D> point) Project a point to the hyperplane.void
Revert the instance.boolean
sameOrientationAs
(Hyperplane<Euclidean1D> other) Check if the instance has the same orientation as another hyperplane.Build a region covering the whole hyperplane.Build a region covering the whole space.
-
Constructor Details
-
OrientedPoint
Simple constructor.- Parameters:
location
- location of the hyperplanedirect
- if true, the plus side of the hyperplane is towards abscissas greater thanlocation
tolerance
- tolerance below which points are considered to belong to the hyperplane
-
-
Method Details
-
copySelf
Copy the instance.Since instances are immutable, this method directly returns the instance.
- Specified by:
copySelf
in interfaceHyperplane<Euclidean1D>
- Returns:
- the instance itself
-
getOffset
Get the offset (oriented distance) of a vector.- Parameters:
vector
- vector to check- Returns:
- offset of the vector
-
getOffset
Get the offset (oriented distance) of a 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.
- Specified by:
getOffset
in interfaceHyperplane<Euclidean1D>
- Parameters:
point
- point to check- Returns:
- offset of the point
-
wholeHyperplane
Build a region covering the whole hyperplane.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 theSubHyperplane
class implementation to work properly, it should not be used otherwise.- Specified by:
wholeHyperplane
in interfaceHyperplane<Euclidean1D>
- Returns:
- a dummy sub hyperplane
-
emptyHyperplane
Build a sub-hyperplane covering nothing..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 theSubHyperplane
class implementation to work properly, it should not be used otherwise.- Specified by:
emptyHyperplane
in interfaceHyperplane<Euclidean1D>
- Returns:
- a dummy sub hyperplane
-
wholeSpace
Build a region covering the whole space.- Specified by:
wholeSpace
in interfaceHyperplane<Euclidean1D>
- Returns:
- a region containing the instance (really an
IntervalsSet
instance)
-
sameOrientationAs
Check if the instance has the same orientation as another hyperplane.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.
- Specified by:
sameOrientationAs
in interfaceHyperplane<Euclidean1D>
- Parameters:
other
- other hyperplane to check against the instance- Returns:
- true if the instance and the other hyperplane have the same orientation
-
project
Project a point to the hyperplane.- Specified by:
project
in interfaceHyperplane<Euclidean1D>
- Parameters:
point
- point to project- Returns:
- projected point
-
getTolerance
public double getTolerance()Get the tolerance below which points are considered to belong to the hyperplane.- Specified by:
getTolerance
in interfaceHyperplane<Euclidean1D>
- Returns:
- tolerance below which points are considered to belong to the hyperplane
-
getLocation
Get the hyperplane location on the real line.- Returns:
- the hyperplane location
-
isDirect
public boolean isDirect()Check if the hyperplane orientation is direct.- Returns:
- true if the plus side of the hyperplane is towards abscissae greater than hyperplane location
-
revertSelf
public void revertSelf()Revert the instance.
-