Apache Commons Math 3.6.1 · org.apache.commons.math3.geometry.partitioning.BoundaryAttribute

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.

Field Summary

Modifier and Type	Field and 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

Access Constructor and Description

Access	Constructor and Description
public	BoundaryAttribute(final SubHyperplane<S> 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) plusOutside, final SubHyperplane<S> 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) 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.
pack-priv	BoundaryAttribute(final SubHyperplane<S> 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) plusOutside, final SubHyperplane<S> 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) plusInside, final NodesSet<S> sub-hyperplanes that were used to split the boundary part (may be null) splitters) Simple constructor.

public

BoundaryAttribute(final SubHyperplane<S>

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)

plusOutside, final SubHyperplane<S>

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)

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.

pack-priv

BoundaryAttribute(final SubHyperplane<S>

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)

plusOutside, final SubHyperplane<S>

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)

plusInside, final NodesSet<S>

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

splitters)

Simple constructor.

Method Summary

Modifier and Type	Method and Description
public SubHyperplane<S>	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 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.
public SubHyperplane<S>	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 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.
public NodesSet<S>	Returns: sub-hyperplanes that were used to split the boundary part getSplitters() Get the sub-hyperplanes that were used to split the boundary part.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

plusInside	back to summary
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).

plusOutside	back to summary
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).

splitters	back to summary
private final NodesSet<S> splitters Sub-hyperplanes that were used to split the boundary part.

Constructor Detail

BoundaryAttribute back to summary

BoundaryAttribute	back to summary
public BoundaryAttribute(final SubHyperplane<S> plusOutside, final 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:SubHyperplane<S> 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:SubHyperplane<S> 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) Annotations @Deprecated

public BoundaryAttribute(final SubHyperplane<S> plusOutside, final 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:SubHyperplane<S>: 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:SubHyperplane<S>: 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)

Annotations

@Deprecated

BoundaryAttribute	back to summary
pack-priv BoundaryAttribute(final SubHyperplane<S> plusOutside, final SubHyperplane<S> plusInside, final NodesSet<S> splitters) Simple constructor. Parameters plusOutside:SubHyperplane<S> 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:SubHyperplane<S> 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:NodesSet<S> sub-hyperplanes that were used to split the boundary part (may be null) Since 3.4

BoundaryAttribute

back to summary

pack-priv BoundaryAttribute(final SubHyperplane<S> plusOutside, final SubHyperplane<S> plusInside, final NodesSet<S> splitters)

Simple constructor.

Parameters

plusOutside:SubHyperplane<S>: 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:SubHyperplane<S>: 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:NodesSet<S>: sub-hyperplanes that were used to split the boundary part (may be null)

Since

3.4

Method Detail

getPlusInside	back to summary
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:SubHyperplane<S> 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

getPlusInside

back to summary

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:SubHyperplane<S>: 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

getPlusOutside	back to summary
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:SubHyperplane<S> 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

getPlusOutside

back to summary

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:SubHyperplane<S>: 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

getSplitters	back to summary
public NodesSet<S> getSplitters() Get the sub-hyperplanes that were used to split the boundary part. Returns:NodesSet<S> sub-hyperplanes that were used to split the boundary part

getSplitters

back to summary

public NodesSet<S> getSplitters()

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

Returns:NodesSet<S>: sub-hyperplanes that were used to split the boundary part

public Class BoundaryAttribute<S extends Space>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail