IntTreeRangeSet (tablesaw-core 0.8.0 API)

java.lang.Object
- tech.tablesaw.util.collections.IntTreeRangeSet

All Implemented Interfaces:

IntRangeSet
```
public class IntTreeRangeSet
extends Object
```
An implementation of IntRangeSet backed by a TreeMap.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(IntRange rangeToAdd)` Adds the specified range to this `IntRangeSet` (optional operation).
`void`	`addAll(IntRangeSet other)` Adds all of the ranges from the specified range set to this range set (optional operation).
`Set<IntRange>`	`asRanges()` Returns a view of the disconnected ranges that make up this range set.
`void`	`clear()` Removes all ranges from this `IntRangeSet` (optional operation).
`IntRangeSet`	`complement()` Returns a view of the complement of this `IntRangeSet`.
`boolean`	`contains(int value)` Determines whether any of this range set's member ranges contains `value`.
`static IntTreeRangeSet`	`create()` Creates an empty `IntTreeRangeSet` instance.
`static IntTreeRangeSet`	`create(IntRangeSet rangeSet)` Returns a `IntTreeRangeSet` initialized with the ranges in the specified range set.
`boolean`	`encloses(IntRange range)` Returns `true` if there exists a member range in this range set which encloses the specified range.
`boolean`	`enclosesAll(IntRangeSet other)` Returns `true` if for each member range in `other` there exists a member range in this range set which encloses it.
`boolean`	`equals(Object obj)` Returns `true` if `obj` is another `IntRangeSet` that contains the same ranges according to `IntRange.equals(Object)`.
`int`	`hashCode()` Returns `asRanges().hashCode()`.
`boolean`	`intersects(IntRange otherRange)` Returns `true` if there exists a non-empty range enclosed by both a member range in this range set and the specified range.
`boolean`	`isEmpty()` Returns `true` if this range set contains no ranges.
`IntRange`	`rangeContaining(int value)` Returns the unique range from this range set that contains `value`, or `null` if this range set does not contain `value`.
`void`	`remove(IntRange rangeToRemove)` Removes the specified range from this `IntRangeSet` (optional operation).
`void`	`removeAll(IntRangeSet other)` Removes all of the ranges from the specified range set from this range set (optional operation).
`IntRange`	`span()` Returns the minimal range which encloses all ranges in this range set.
`IntRangeSet`	`subRangeSet(IntRange view)` Returns a view of the intersection of this `IntRangeSet` with the specified range.
`String`	`toString()` Returns a readable string representation of this range set.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static IntTreeRangeSet create()
```
    Creates an empty IntTreeRangeSet instance.
  - create
```
public static IntTreeRangeSet create(IntRangeSet rangeSet)
```
    Returns a IntTreeRangeSet initialized with the ranges in the specified range set.
  - asRanges
```
public Set<IntRange> asRanges()
```
    Description copied from interface: IntRangeSet
    
    Returns a view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by its Iterable.iterator() method return the ranges in increasing order of lower bound (equivalently, of upper bound).
  - rangeContaining
```
@Nullable
public IntRange rangeContaining(int value)
```
    Description copied from interface: IntRangeSet
    
    Returns the unique range from this range set that contains value, or null if this range set does not contain value.
    
    Specified by:
    
    rangeContaining in interface IntRangeSet
  - encloses
```
public boolean encloses(IntRange range)
```
    Description copied from interface: IntRangeSet
    
    Returns true if there exists a member range in this range set which encloses the specified range.
    
    Specified by:
    
    encloses in interface IntRangeSet
  - span
```
public IntRange span()
```
    Description copied from interface: IntRangeSet
    
    Returns the minimal range which encloses all ranges in this range set.
  - add
```
public void add(IntRange rangeToAdd)
```
    Description copied from interface: IntRangeSet
    
    Adds the specified range to this IntRangeSet (optional operation). That is, for equal range sets a and b, the result of a.add(range) is that a will be the minimal range set for which both a.enclosesAll(b) and a.encloses(range).
    
    Note that range will be coalesced with any ranges in the range set that are connected with it. Moreover, if range is empty, this is a no-op.
    
    Specified by:
    
    add in interface IntRangeSet
  - remove
```
public void remove(IntRange rangeToRemove)
```
    Description copied from interface: IntRangeSet
    
    Removes the specified range from this IntRangeSet (optional operation). After this operation, if range.contains(c), this.contains(c) will return false.
    
    If range is empty, this is a no-op.
    
    Specified by:
    
    remove in interface IntRangeSet
  - complement
```
public IntRangeSet complement()
```
    Description copied from interface: IntRangeSet
    
    Returns a view of the complement of this IntRangeSet.
    
    The returned view supports the IntRangeSet.add(tech.tablesaw.util.collections.IntRange) operation if this IntRangeSet supports IntRangeSet.remove(tech.tablesaw.util.collections.IntRange), and vice versa.
  - subRangeSet
```
public IntRangeSet subRangeSet(IntRange view)
```
    Description copied from interface: IntRangeSet
    
    Returns a view of the intersection of this IntRangeSet with the specified range.
    
    The returned view supports all optional operations supported by this IntRangeSet, with the caveat that an IllegalArgumentException is thrown on an attempt to add any range not enclosed by view.
  - contains
```
public boolean contains(int value)
```
    Description copied from interface: IntRangeSet
    
    Determines whether any of this range set's member ranges contains value.
    
    Specified by:
    
    contains in interface IntRangeSet
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: IntRangeSet
    
    Returns true if this range set contains no ranges.
    
    Specified by:
    
    isEmpty in interface IntRangeSet
  - clear
```
public void clear()
```
    Description copied from interface: IntRangeSet
    
    Removes all ranges from this IntRangeSet (optional operation). After this operation, this.contains(c) will return false for all c.
    
    This is equivalent to remove(IntRange.all()).
    
    Specified by:
    
    clear in interface IntRangeSet
  - enclosesAll
```
public boolean enclosesAll(IntRangeSet other)
```
    Description copied from interface: IntRangeSet
    
    Returns true if for each member range in other there exists a member range in this range set which encloses it. It follows that this.contains(value) whenever other.contains(value). Returns true if other is empty.
    
    This is equivalent to checking if this range set IntRangeSet.encloses(tech.tablesaw.util.collections.IntRange) each of the ranges in other.
    
    Specified by:
    
    enclosesAll in interface IntRangeSet
  - addAll
```
public void addAll(IntRangeSet other)
```
    Description copied from interface: IntRangeSet
    
    Adds all of the ranges from the specified range set to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set and other.
    
    This is equivalent to calling IntRangeSet.add(tech.tablesaw.util.collections.IntRange) on each of the ranges in other in turn.
    
    Specified by:
    
    addAll in interface IntRangeSet
  - removeAll
```
public void removeAll(IntRangeSet other)
```
    Description copied from interface: IntRangeSet
    
    Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, if other.contains(c), this.contains(c) will return false.
    
    This is equivalent to calling IntRangeSet.remove(tech.tablesaw.util.collections.IntRange) on each of the ranges in other in turn.
    
    Specified by:
    
    removeAll in interface IntRangeSet
  - intersects
```
public boolean intersects(IntRange otherRange)
```
    Description copied from interface: IntRangeSet
    
    Returns true if there exists a non-empty range enclosed by both a member range in this range set and the specified range. This is equivalent to calling subRangeSet(otherRange) and testing whether the resulting range set is non-empty.
    
    Specified by:
    
    intersects in interface IntRangeSet
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Description copied from interface: IntRangeSet
    
    Returns true if obj is another IntRangeSet that contains the same ranges according to IntRange.equals(Object).
    
    Specified by:
    
    equals in interface IntRangeSet
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Description copied from interface: IntRangeSet
    
    Returns asRanges().hashCode().
    
    Specified by:
    
    hashCode in interface IntRangeSet
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public final String toString()
```
    Description copied from interface: IntRangeSet
    
    Returns a readable string representation of this range set. For example, if this IntRangeSet consisted of IntRange.closed(1, 3) and IntRange.greaterThan(4), this might return " [1..3](4..+∞)"}.
    
    Specified by:
    
    toString in interface IntRangeSet
    
    Overrides:
    
    toString in class Object

Class IntTreeRangeSet

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

asRanges

rangeContaining

encloses

span

add

remove

complement

subRangeSet

contains

isEmpty

clear

enclosesAll

addAll

removeAll

intersects

equals

hashCode

toString