CenteredIntIntervalTree

java.lang.Object
- beagleutil.CenteredIntIntervalTree<E>

Type Parameters:

E - the objects stored by this.

All Implemented Interfaces:

IntIntervalTree<E>
```
public class CenteredIntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
extends java.lang.Object
implements IntIntervalTree<E>
```
Class CenteredIntIntervalTree implements a centered interval tree that stores IntInterval objects.
Instances of class CenteredIntIntervalTree are not thread-safe.

Constructor Summary

Constructors
Constructor and Description

CenteredIntIntervalTree(int start, int end)
Creates a new CenteredIntIntervalTree instance for the specified range.

Constructors
Constructor and Description
`CenteredIntIntervalTree(int start, int end)` Creates a new `CenteredIntIntervalTree` instance for the specified range.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)` Adds the specified element to this interval tree, and returns `true` if the interval tree is changed as a result of the call.
`void`	`clear()` Removes all of the elements from this interval tree.
`boolean`	`contains(E element)` Returns `true` if the interval tree contains the specified element, and returns `false` otherwise.
`int`	`end()` Returns the maximum end (inclusive) of an interval that can be stored in this interval tree.
`void`	`intersect(int point, java.util.Collection<E> collection)` Adds the elements in this interval tree that intersect the specified point to the specified collection.
`void`	`intersectAll(int start, int end, java.util.Collection<E> collection)` Adds the elements in this interval tree that contain the specified interval to the specified collection.
`void`	`intersectPart(int start, int end, java.util.Collection<E> collection)` Adds the elements in this interval tree that intersect any part of the specified interval to the specified collection.
`boolean`	`isEmpty()` Returns `true` if this interval tree contains no elements.
`boolean`	`remove(E element)` Removes the specified element from this interval tree if the specified element is found in the interval tree.
`int`	`size()` Returns the number of elements in this interval tree.
`int`	`start()` Returns the minimum start (inclusive) of an interval that can be stored in this interval tree.
`E[]`	`toArray()` Returns an array containing all of the elements of this interval tree.
`java.lang.String`	`toString()` Returns a string representation of `this`.

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

- Constructor Detail
  - CenteredIntIntervalTree
```
public CenteredIntIntervalTree(int start,
                               int end)
```
    Creates a new CenteredIntIntervalTree instance for the specified range.
    
    Parameters:
    
    start - the minimum start value (inclusive) for intervals stored in this interval tree
    
    end - the maximum end value (inclusive) for intervals stored in this interval tree
    
    Throws:
    
    java.lang.IllegalArgumentException - if end < start
- Method Detail
  - start
```
public int start()
```
    Description copied from interface: IntIntervalTree
    
    Returns the minimum start (inclusive) of an interval that can be stored in this interval tree.
    
    Specified by:
    
    start in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Returns:
    
    the minimum start (inclusive) of an interval that can be stored in this interval tree
  - end
```
public int end()
```
    Description copied from interface: IntIntervalTree
    
    Returns the maximum end (inclusive) of an interval that can be stored in this interval tree.
    
    Specified by:
    
    end in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Returns:
    
    the maximum end (inclusive) of an interval that can be stored in this interval tree
  - clear
```
public void clear()
```
    Description copied from interface: IntIntervalTree
    
    Removes all of the elements from this interval tree.
    
    Specified by:
    
    clear in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
  - add
```
public boolean add(E element)
```
    Description copied from interface: IntIntervalTree
    
    Adds the specified element to this interval tree, and returns true if the interval tree is changed as a result of the call. The method returns false if this.contains(E) == true when the method is invoked.
    
    Specified by:
    
    add in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    element - the element to be added
    
    Returns:
    
    true if the interval tree changed as a result of the call
  - contains
```
public boolean contains(E element)
```
    Description copied from interface: IntIntervalTree
    
    Returns true if the interval tree contains the specified element, and returns false otherwise.
    
    Specified by:
    
    contains in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    element - the element whose presence in the interval tree is to be tested
    
    Returns:
    
    true if the interval tree contains the specified element
  - remove
```
public boolean remove(E element)
```
    Description copied from interface: IntIntervalTree
    
    Removes the specified element from this interval tree if the specified element is found in the interval tree.
    
    Specified by:
    
    remove in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    element - the element to be removed from this interval tree
    
    Returns:
    
    true if the interval tree is changed as a result of the call
  - intersect
```
public void intersect(int point,
                      java.util.Collection<E> collection)
```
    Description copied from interface: IntIntervalTree
    
    Adds the elements in this interval tree that intersect the specified point to the specified collection.
    
    Specified by:
    
    intersect in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    point - a point
    
    collection - a collection to which will be added the elements of this interval tree that intersect the specified point
  - intersectPart
```
public void intersectPart(int start,
                          int end,
                          java.util.Collection<E> collection)
```
    Description copied from interface: IntIntervalTree
    
    Adds the elements in this interval tree that intersect any part of the specified interval to the specified collection.
    
    Specified by:
    
    intersectPart in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    start - the start (inclusive) of the specified interval
    
    end - the end (inclusive) of the specified interval
    
    collection - a collection to which will be added the elements of this interval tree that intersect any part of the specified interval
  - intersectAll
```
public void intersectAll(int start,
                         int end,
                         java.util.Collection<E> collection)
```
    Description copied from interface: IntIntervalTree
    
    Adds the elements in this interval tree that contain the specified interval to the specified collection.
    
    Specified by:
    
    intersectAll in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Parameters:
    
    start - the start (inclusive) of the specified interval
    
    end - the end (inclusive) of the specified interval
    
    collection - a collection to which will be added the elements of this interval tree that contain the specified interval
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: IntIntervalTree
    
    Returns true if this interval tree contains no elements.
    
    Specified by:
    
    isEmpty in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Returns:
    
    true if this interval tree contains no elements
  - size
```
public int size()
```
    Description copied from interface: IntIntervalTree
    
    Returns the number of elements in this interval tree.
    
    Specified by:
    
    size in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Returns:
    
    the number of elements in this interval tree
  - toArray
```
public E[] toArray()
```
    Description copied from interface: IntIntervalTree
    
    Returns an array containing all of the elements of this interval tree.
    
    Specified by:
    
    toArray in interface IntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>
    
    Returns:
    
    an array containing all of the elements of this interval tree
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this. The exact details of the representation are unspecified and subject to change.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this

Class CenteredIntIntervalTree<E extends IntInterval & java.lang.Comparable<E>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CenteredIntIntervalTree

Method Detail

start

end

clear

add

contains

remove

intersect

intersectPart

intersectAll

isEmpty

size

toArray

toString