org.apache.commons.geometry.core.partitioning

Class Split<T>

java.lang.Object

org.apache.commons.geometry.core.partitioning.Split<T>

Type Parameters:

T - Split type

public final class Split<T>
extends Object

Class containing the result of splitting an object with a hyperplane.

Constructor Summary

Constructors

Constructor and Description
Split(T minus, T plus) Build a new instance from its parts.

Method Summary

Modifier and Type	Method and Description
SplitLocation	getLocation() Get the location of the object with respect to its splitting hyperplane.
T	getMinus() Get the part of the object lying on the minus side of the splitting hyperplane or null if no such part exists.
T	getPlus() Get the part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Split

public Split(T minus,
             T plus)

Build a new instance from its parts.

Parameters:

minus - part of the object lying on the minus side of the splitting hyperplane or null if no such part exists

plus - part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.

Method Detail

getMinus

public T getMinus()

Get the part of the object lying on the minus side of the splitting hyperplane or null if no such part exists.

Returns:

part of the object lying on the minus side of the splitting hyperplane

getPlus

public T getPlus()

Get the part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.

Returns:

part of the object lying on the plus side of the splitting hyperplane

getLocation

public SplitLocation getLocation()

Get the location of the object with respect to its splitting hyperplane.

Returns:

• SplitLocation.PLUS - if only getPlus() is not null
• SplitLocation.MINUS - if only getMinus() is not null
• SplitLocation.BOTH - if both getPlus() and getMinus() are not null
• SplitLocation.NEITHER - if both getPlus() and getMinus() are null

toString

public String toString()

Overrides:

toString in class Object