Class BoundaryAttribute<S extends Space>

java.lang.Object

org.apache.commons.math3.geometry.partitioning.BoundaryAttribute<S>

Type Parameters:

S - Type of the space.

public class BoundaryAttribute<S extends Space>
extends Object

Class holding boundary attributes.

This class is used for the attributes associated with the nodes of region boundary shell trees returned by the Region.getTree(includeBoundaryAttributes) when the boolean includeBoundaryAttributes parameter is set to true. It contains the parts of the node cut sub-hyperplane that belong to the boundary.

This class is a simple placeholder, it does not provide any processing methods.

Since:

3.0

See Also:

• Region.getTree(boolean)

Field Summary

Fields

Modifier and Type	Field	Description
private final SubHyperplane<S>	plusInside	Part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null).
private final SubHyperplane<S>	plusOutside	Part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null).
private final NodesSet<S>	splitters	Sub-hyperplanes that were used to split the boundary part.

Constructor Summary

Constructors

Constructor	Description
BoundaryAttribute(SubHyperplane<S> plusOutside, SubHyperplane<S> plusInside)	Deprecated. as of 3.4, the constructor has been replaced by a new one which is not public anymore, as it is intended to be used only by BoundaryBuilder
BoundaryAttribute(SubHyperplane<S> plusOutside, SubHyperplane<S> plusInside, NodesSet<S> splitters)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
SubHyperplane<S>	getPlusInside()	Get the part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane.
SubHyperplane<S>	getPlusOutside()	Get the part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane.
NodesSet<S>	getSplitters()	Get the sub-hyperplanes that were used to split the boundary part.

Methods inherited from class Object

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

Field Details

plusOutside

private final SubHyperplane<S extends Space> plusOutside

Part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null).

plusInside

private final SubHyperplane<S extends Space> plusInside

Part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null).

splitters

private final NodesSet<S extends Space> splitters

Sub-hyperplanes that were used to split the boundary part.

Constructor Details

BoundaryAttribute

@Deprecated
public BoundaryAttribute(SubHyperplane<S> plusOutside,
 SubHyperplane<S> plusInside)

Deprecated.

as of 3.4, the constructor has been replaced by a new one which is not public anymore, as it is intended to be used only by BoundaryBuilder

Simple constructor.

Parameters:

plusOutside - part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null)

plusInside - part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null)

BoundaryAttribute

BoundaryAttribute(SubHyperplane<S> plusOutside,
 SubHyperplane<S> plusInside,
 NodesSet<S> splitters)

Simple constructor.

Parameters:

plusOutside - part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null)

plusInside - part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null)

splitters - sub-hyperplanes that were used to split the boundary part (may be null)

Since:

3.4

Method Details

getPlusOutside

public SubHyperplane<S> getPlusOutside()

Get the part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane.

Returns:

part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane

getPlusInside

public SubHyperplane<S> getPlusInside()

Get the part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane.

Returns:

part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane

getSplitters

public NodesSet<S> getSplitters()

Get the sub-hyperplanes that were used to split the boundary part.

Returns:

sub-hyperplanes that were used to split the boundary part