org.apache.commons.math3.geometry.spherical.twod

Class SubCircle

java.lang.Object

org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane<Sphere2D,Sphere1D>

org.apache.commons.math3.geometry.spherical.twod.SubCircle

All Implemented Interfaces:

SubHyperplane<Sphere2D>

public class SubCircle
extends AbstractSubHyperplane<Sphere2D,Sphere1D>

This class represents a sub-hyperplane for Circle.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.SubHyperplane

SubHyperplane.SplitSubHyperplane<U extends Space>

Constructor Summary

Constructors

Constructor and Description
SubCircle(Hyperplane<Sphere2D> hyperplane, Region<Sphere1D> remainingRegion) Simple constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected AbstractSubHyperplane<Sphere2D,Sphere1D>	buildNew(Hyperplane<Sphere2D> hyperplane, Region<Sphere1D> remainingRegion) Build a sub-hyperplane from an hyperplane and a region.
Side	side(Hyperplane<Sphere2D> hyperplane) Compute the relative position of the instance with respect to an hyperplane.
SubHyperplane.SplitSubHyperplane<Sphere2D>	split(Hyperplane<Sphere2D> hyperplane) Split the instance in two parts by an hyperplane.

Methods inherited from class org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane

applyTransform, copySelf, getHyperplane, getRemainingRegion, getSize, isEmpty, reunite

Methods inherited from class java.lang.Object

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

Constructor Detail

SubCircle

public SubCircle(Hyperplane<Sphere2D> hyperplane,
         Region<Sphere1D> remainingRegion)

Simple constructor.

Parameters:

hyperplane - underlying hyperplane

remainingRegion - remaining region of the hyperplane

Method Detail

buildNew

protected AbstractSubHyperplane<Sphere2D,Sphere1D> buildNew(Hyperplane<Sphere2D> hyperplane,
                                                Region<Sphere1D> remainingRegion)

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

Specified by:

buildNew in class AbstractSubHyperplane<Sphere2D,Sphere1D>

Parameters:

hyperplane - underlying hyperplane

remainingRegion - remaining region of the hyperplane

Returns:

a new sub-hyperplane

side

public Side side(Hyperplane<Sphere2D> hyperplane)

Compute the relative position of the instance with respect to an hyperplane.

Specified by:

side in interface SubHyperplane<Sphere2D>

Specified by:

side in class AbstractSubHyperplane<Sphere2D,Sphere1D>

Parameters:

hyperplane - hyperplane to check instance against

Returns:

one of Side.PLUS, Side.MINUS, Side.BOTH, Side.HYPER

split

public SubHyperplane.SplitSubHyperplane<Sphere2D> split(Hyperplane<Sphere2D> hyperplane)

Split the instance in two parts by an hyperplane.

Specified by:

split in interface SubHyperplane<Sphere2D>

Specified by:

split in class AbstractSubHyperplane<Sphere2D,Sphere1D>

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