Top Description Constructors Methods
org.apache.commons.math3.geometry.euclidean.oned

public Class SubOrientedPoint

extends AbstractSubHyperplane<Euclidean1D, Euclidean1D>
Class Inheritance
Imports
org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane, .Hyperplane, .Region
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

Constructor Summary

AccessConstructor and Description
public
SubOrientedPoint(final Hyperplane<Euclidean1D>
underlying hyperplane
hyperplane, final Region<Euclidean1D>
remaining region of the hyperplane
remainingRegion)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
protected AbstractSubHyperplane<Euclidean1D, Euclidean1D>
buildNew(final Hyperplane<Euclidean1D>
underlying hyperplane
hyperplane, final Region<Euclidean1D>
remaining region of the hyperplane
remainingRegion)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

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

public double
getSize()

Overrides org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.getSize.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.getSize.

Get the size of the instance.

public boolean
isEmpty()

Overrides org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.isEmpty.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.isEmpty.

Check if the instance is empty.

public SubHyperplane.SplitSubHyperplane<Euclidean1D>
split(final Hyperplane<Euclidean1D>
splitting hyperplane
hyperplane)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.split.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

Split the instance in two parts by an hyperplane.

Inherited from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane:
applyTransformcopySelfgetHyperplanegetRemainingRegionreuniteside

Constructor Detail

SubOrientedPointback to summary
public SubOrientedPoint(final Hyperplane<Euclidean1D> hyperplane, final Region<Euclidean1D> remainingRegion)

Simple constructor.

Parameters
hyperplane:Hyperplane<Euclidean1D>

underlying hyperplane

remainingRegion:Region<Euclidean1D>

remaining region of the hyperplane

Method Detail

buildNewback to summary
protected AbstractSubHyperplane<Euclidean1D, Euclidean1D> buildNew(final Hyperplane<Euclidean1D> hyperplane, final Region<Euclidean1D> remainingRegion)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

Doc from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

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

Parameters
hyperplane:Hyperplane<Euclidean1D>

underlying hyperplane

remainingRegion:Region<Euclidean1D>

remaining region of the hyperplane

Returns:AbstractSubHyperplane<Euclidean1D, Euclidean1D>

a new sub-hyperplane

Annotations
@Override
getSizeback to summary
public double getSize()

Overrides org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.getSize.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.getSize.

Doc from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.getSize.

Get the size of the instance.

Returns:double

Doc from org.apache.commons.math3.geometry.partitioning.SubHyperplane.getSize.

the size of the instance (this is a length in 1D, an area in 2D, a volume in 3D ...)

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Overrides org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.isEmpty.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.isEmpty.

Doc from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.isEmpty.

Check if the instance is empty.

Returns:boolean

Doc from org.apache.commons.math3.geometry.partitioning.SubHyperplane.isEmpty.

true if the instance is empty

Annotations
@Override
splitback to summary
public SubHyperplane.SplitSubHyperplane<Euclidean1D> split(final Hyperplane<Euclidean1D> hyperplane)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.split.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

Doc from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.split.

Split the instance in two parts by an hyperplane.

Parameters
hyperplane:Hyperplane<Euclidean1D>

Doc from org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

splitting hyperplane

Returns:SubHyperplane.SplitSubHyperplane<Euclidean1D>

Doc from org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

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

Annotations
@Override