org.apache.commons.geometry.euclidean.oned

Class RegionBSPTree1D

java.lang.Object

org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree<P,N>

org.apache.commons.geometry.core.partitioning.bsp.AbstractRegionBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

org.apache.commons.geometry.euclidean.oned.RegionBSPTree1D

All Implemented Interfaces:

BSPSubtree<Vector1D,RegionBSPTree1D.RegionNode1D>, BSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>, HyperplaneBoundedRegion<Vector1D>, Splittable<Vector1D,HyperplaneBoundedRegion<Vector1D>>, Region<Vector1D>, Sized

public final class RegionBSPTree1D
extends AbstractRegionBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

Binary space partitioning (BSP) tree representing a region in one dimensional Euclidean space.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionBSPTree1D.RegionNode1D BSP tree node for one dimensional Euclidean space.

Nested classes/interfaces inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractRegionBSPTree

AbstractRegionBSPTree.AbstractRegionNode<P extends Point<P>,N extends AbstractRegionBSPTree.AbstractRegionNode<P,N>>, AbstractRegionBSPTree.BoundaryProjector<P extends Point<P>,N extends AbstractRegionBSPTree.AbstractRegionNode<P,N>>, AbstractRegionBSPTree.RegionSizeProperties<P extends Point<P>>

Nested classes/interfaces inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree

AbstractBSPTree.AbstractNode<P extends Point<P>,N extends AbstractBSPTree.AbstractNode<P,N>>, AbstractBSPTree.SubtreeInitializer<N extends AbstractBSPTree.AbstractNode<?,?>>

Nested classes/interfaces inherited from interface org.apache.commons.geometry.core.partitioning.bsp.BSPTree

BSPTree.FindNodeCutRule, BSPTree.Node<P extends Point<P>,N extends BSPTree.Node<P,N>>

Constructor Summary

Constructors

Constructor and Description
RegionBSPTree1D() Create a new, empty region.
RegionBSPTree1D(boolean full) Create a new region.

Method Summary

Modifier and Type	Method and Description
void	add(Interval interval) Add an interval to this region.
RegionLocation	classify(double x) Classify a point location with respect to the region.
protected AbstractRegionBSPTree.RegionSizeProperties<Vector1D>	computeRegionSizeProperties()
boolean	contains(double x) Return true if the given point location is on the inside or boundary of the region.
RegionBSPTree1D	copy() Return a deep copy of this instance.
protected RegionBSPTree1D.RegionNode1D	createNode()
static RegionBSPTree1D	empty() Return a new, empty RegionBSPTree1D instance.
static RegionBSPTree1D	from(Interval interval, Interval... more) Construct a new instance from one or more intervals.
static RegionBSPTree1D	from(Iterable<Interval> intervals) Construct a new instance from the given collection of intervals.
static RegionBSPTree1D	full() Return a new RegionBSPTree1D instance containing the entire space.
double	getBoundarySize()
double	getMax() Get the maximum value on the inside of the region; returns Double.POSITIVE_INFINITY if the region does not have a maximum value and Double.NEGATIVE_INFINITY if the region is empty.
double	getMin() Get the minimum value on the inside of the region; returns Double.NEGATIVE_INFINITY if the region does not have a minimum value and Double.POSITIVE_INFINITY if the region is empty.
Vector1D	project(Vector1D pt)
Split<RegionBSPTree1D>	split(Hyperplane<Vector1D> splitter)
protected boolean	swapsInsideOutside(Transform<Vector1D> transform) Returns true if the given transform would result in a swapping of the interior and exterior of the region if applied.
List<Interval>	toIntervals() Convert the region represented by this tree into a list of separate Intervals, arranged in order of ascending min value.

Methods inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractRegionBSPTree

boundaries, classify, complement, complement, condense, copyNodeProperties, createBoundaryIterable, createBoundaryList, difference, difference, getBoundaries, getCentroid, getRegionSizeProperties, getSize, getSubtreeInitializer, insert, insert, insert, insert, insert, insert, insert, insert, intersection, intersection, invalidate, isEmpty, isFull, setEmpty, setFull, split, union, union, xor, xor

Methods inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree

accept, accept, copy, copyNode, copySubtree, count, cutNode, extract, extractParentPath, findNode, findNode, getRoot, getVersion, height, importSubtree, insert, nodes, removeNodeCut, setNodeCut, setRoot, splitIntoTrees, splitSubtree, toString, transform, treeString, treeString, trimToNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.geometry.core.Region

contains

Methods inherited from interface org.apache.commons.geometry.core.Sized

isFinite, isInfinite

Methods inherited from interface org.apache.commons.geometry.core.partitioning.bsp.BSPTree

findNode

Constructor Detail

RegionBSPTree1D

public RegionBSPTree1D()

Create a new, empty region.

RegionBSPTree1D

public RegionBSPTree1D(boolean full)

Create a new region. If full is true, then the region will represent the entire number line. Otherwise, it will be empty.

Parameters:

full - whether or not the region should contain the entire number line or be empty

Method Detail

copy

public RegionBSPTree1D copy()

Return a deep copy of this instance.

Returns:

a deep copy of this instance.

See Also:

AbstractBSPTree.copy(org.apache.commons.geometry.core.partitioning.bsp.BSPTree)

add

public void add(Interval interval)

Add an interval to this region. The resulting region will be the union of the interval and the region represented by this instance.

Parameters:

interval - the interval to add

classify

public RegionLocation classify(double x)

Classify a point location with respect to the region.

Parameters:

x - the point to classify

Returns:

the location of the point with respect to the region

See Also:

AbstractRegionBSPTree.classify(org.apache.commons.geometry.core.Point)

contains

public boolean contains(double x)

Return true if the given point location is on the inside or boundary of the region.

Parameters:

x - the location to test

Returns:

true if the location is on the inside or boundary of the region

See Also:

Region.contains(org.apache.commons.geometry.core.Point)

getBoundarySize

public double getBoundarySize()

This method simply returns 0 because boundaries in one dimension do not have any size.

Specified by:

getBoundarySize in interface Region<Vector1D>

Overrides:

getBoundarySize in class AbstractRegionBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

project

public Vector1D project(Vector1D pt)

Specified by:

project in interface Region<Vector1D>

Overrides:

project in class AbstractRegionBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

split

public Split<RegionBSPTree1D> split(Hyperplane<Vector1D> splitter)

When splitting trees representing single points with a splitter lying directly on the point, the result point is placed on one side of the splitter based on its orientation: if the splitter is positive-facing, the point is placed on the plus side of the split; if the splitter is negative-facing, the point is placed on the minus side of the split.

getMin

public double getMin()

Get the minimum value on the inside of the region; returns Double.NEGATIVE_INFINITY if the region does not have a minimum value and Double.POSITIVE_INFINITY if the region is empty.

Returns:

the minimum value on the inside of the region

getMax

public double getMax()

Get the maximum value on the inside of the region; returns Double.POSITIVE_INFINITY if the region does not have a maximum value and Double.NEGATIVE_INFINITY if the region is empty.

Returns:

the maximum value on the inside of the region

toIntervals

public List<Interval> toIntervals()

Convert the region represented by this tree into a list of separate Intervals, arranged in order of ascending min value.

Returns:

list of Intervals representing this region in order of ascending min value

createNode

protected RegionBSPTree1D.RegionNode1D createNode()

Specified by:

createNode in class AbstractBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

computeRegionSizeProperties

protected AbstractRegionBSPTree.RegionSizeProperties<Vector1D> computeRegionSizeProperties()

Specified by:

computeRegionSizeProperties in class AbstractRegionBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

swapsInsideOutside

protected boolean swapsInsideOutside(Transform<Vector1D> transform)

Returns true if the given transform would result in a swapping of the interior and exterior of the region if applied.

This method always returns false since no swapping of this kind occurs in 1D.

Overrides:

swapsInsideOutside in class AbstractBSPTree<Vector1D,RegionBSPTree1D.RegionNode1D>

full

public static RegionBSPTree1D full()

Return a new RegionBSPTree1D instance containing the entire space.

Returns:

a new RegionBSPTree1D instance containing the entire space

empty

public static RegionBSPTree1D empty()

Return a new, empty RegionBSPTree1D instance.

Returns:

a new, empty RegionBSPTree1D instance

from

public static RegionBSPTree1D from(Interval interval,
                                   Interval... more)

Construct a new instance from one or more intervals. The returned tree represents the same region as the union of all of the input intervals.

Parameters:

interval - the input interval

more - additional intervals to add to the region

Returns:

a new instance representing the same region as the union of all of the given intervals

from

public static RegionBSPTree1D from(Iterable<Interval> intervals)

Construct a new instance from the given collection of intervals.

Parameters:

intervals - the intervals to populate the region with

Returns:

a new instance constructed from the given collection of intervals