org.apache.commons.geometry.euclidean.oned

Class OrientedPoint

java.lang.Object

org.apache.commons.geometry.core.partitioning.AbstractHyperplane<Vector1D>

org.apache.commons.geometry.euclidean.oned.OrientedPoint

All Implemented Interfaces:

Hyperplane<Vector1D>

public final class OrientedPoint
extends AbstractHyperplane<Vector1D>

This class represents a 1D oriented hyperplane.

A hyperplane in 1D is a simple point, its orientation being a boolean indicating if the direction is positive or negative.

Instances of this class are guaranteed to be immutable.

See Also:

OrientedPoints

Method Summary

Modifier and Type	Method and Description
HyperplaneLocation	classify(double location) Classify the number line location with respect to the instance.
HyperplaneLocation	classify(Vector1D pt)
boolean	eq(OrientedPoint other, Precision.DoubleEquivalence precision) Return true if this instance should be considered equivalent to the argument, using the given precision context for comparison.
boolean	equals(Object obj)
Vector1D.Unit	getDirection() Get the direction of the hyperplane's plus side.
double	getLocation() Get the location of the hyperplane as a single value.
Vector1D	getPoint() Get the location of the hyperplane as a point.
int	hashCode()
boolean	isPositiveFacing() Return true if the hyperplane is oriented with its plus side in the direction of positive infinity.
double	offset(double location) Compute the offset of the given number line location.
double	offset(Vector1D pt)
Vector1D	project(Vector1D pt)
OrientedPoint	reverse()
boolean	similarOrientation(Hyperplane<Vector1D> other)
HyperplaneConvexSubset<Vector1D>	span()
String	toString()
OrientedPoint	transform(Transform<Vector1D> transform)

Methods inherited from class org.apache.commons.geometry.core.partitioning.AbstractHyperplane

contains, getPrecision

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPoint

public Vector1D getPoint()

Get the location of the hyperplane as a point.

Returns:

the hyperplane location as a point

See Also:

getLocation()

getLocation

public double getLocation()

Get the location of the hyperplane as a single value. This is equivalent to pt.getPoint().getX().

Returns:

the location of the hyperplane as a single value.

See Also:

getPoint()

getDirection

public Vector1D.Unit getDirection()

Get the direction of the hyperplane's plus side.

Returns:

the hyperplane direction

isPositiveFacing

public boolean isPositiveFacing()

Return true if the hyperplane is oriented with its plus side in the direction of positive infinity.

Returns:

true if the hyperplane is facing toward positive infinity

reverse

public OrientedPoint reverse()

transform

public OrientedPoint transform(Transform<Vector1D> transform)

offset

public double offset(Vector1D pt)

offset

public double offset(double location)

Compute the offset of the given number line location. This is a convenience overload of offset(Vector1D) for use in one dimension.

Parameters:

location - the number line location to compute the offset for

Returns:

the offset of the location from the instance

classify

public HyperplaneLocation classify(Vector1D pt)

Specified by:

classify in interface Hyperplane<Vector1D>

Overrides:

classify in class AbstractHyperplane<Vector1D>

classify

public HyperplaneLocation classify(double location)

Classify the number line location with respect to the instance. This is a convenience overload of classify(Vector1D) for use in one dimension.

Parameters:

location - the number line location to classify

Returns:

the classification of the number line location with respect to this instance

similarOrientation

public boolean similarOrientation(Hyperplane<Vector1D> other)

project

public Vector1D project(Vector1D pt)

span

public HyperplaneConvexSubset<Vector1D> span()

Since there are no subspaces in 1D, this method effectively returns a stub implementation of HyperplaneConvexSubset, the main purpose of which is to support the proper functioning of the partitioning code.

eq

public boolean eq(OrientedPoint other,
                  Precision.DoubleEquivalence precision)

Return true if this instance should be considered equivalent to the argument, using the given precision context for comparison.

Instances are considered equivalent if they

1. have equivalent locations and
2. point in the same direction.

Parameters:

other - the point to compare with

precision - precision context to use for the comparison

Returns:

true if this instance should be considered equivalent to the argument

See Also:

Vector1D.eq(Vector1D, Precision.DoubleEquivalence)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object