Package org.hipparchus.geometry.euclidean.oned

Class SubOrientedPoint

java.lang.Object

org.hipparchus.geometry.partitioning.AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

org.hipparchus.geometry.euclidean.oned.SubOrientedPoint

All Implemented Interfaces:

SubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

public class SubOrientedPoint
extends AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

This class represents sub-hyperplane for OrientedPoint.

An hyperplane in 1D is a simple point, its orientation being a boolean.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hipparchus.geometry.partitioning.SubHyperplane

SubHyperplane.SplitSubHyperplane<U extends Space,R extends Point<U,R>,F extends Hyperplane<U,R,F,J>,J extends SubHyperplane<U,R,F,J>>

Constructor Summary

Constructors

Constructor	Description
SubOrientedPoint(OrientedPoint hyperplane, Region<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint> remainingRegion)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
protected SubOrientedPoint	buildNew(OrientedPoint hyperplane, Region<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint> remainingRegion)	Build a sub-hyperplane from an hyperplane and a region.
Vector1D	getInteriorPoint()	Get an interior point.
double	getSize()	Get the size of the instance.
boolean	isEmpty()	Check if the instance is empty.
SubHyperplane.SplitSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>	split(OrientedPoint hyperplane)	Split the instance in two parts by an hyperplane.

Methods inherited from class org.hipparchus.geometry.partitioning.AbstractSubHyperplane

applyTransform, copySelf, getHyperplane, getRemainingRegion, reunite

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubOrientedPoint

public SubOrientedPoint(OrientedPoint hyperplane,
                        Region<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint> remainingRegion)

Simple constructor.

Parameters:

hyperplane - underlying hyperplane

remainingRegion - remaining region of the hyperplane

Method Detail

getSize

public double getSize()

Get the size of the instance.

Specified by:

getSize in interface SubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

Overrides:

getSize in class AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

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:

isEmpty in interface SubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

Overrides:

isEmpty in class AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

Returns:

true if the instance is empty

buildNew

protected SubOrientedPoint buildNew(OrientedPoint hyperplane,
                                    Region<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint> remainingRegion)

Build a sub-hyperplane from an hyperplane and a region.

Specified by:

buildNew in class AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

Parameters:

hyperplane - underlying hyperplane

remainingRegion - remaining region of the hyperplane

Returns:

a new sub-hyperplane

getInteriorPoint

public Vector1D getInteriorPoint()

Get an interior point.

Returns:

an arbitrary interior point, or null if sub-hyperplane is empty

split

public SubHyperplane.SplitSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint> split(OrientedPoint hyperplane)

Split the instance in two parts by an hyperplane.

Specified by:

split in interface SubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

Specified by:

split in class AbstractSubHyperplane<Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint,Euclidean1D,Vector1D,OrientedPoint,SubOrientedPoint>

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