beagleutil

Interface IntIntervalTree<E extends IntInterval>

Type Parameters:

E - the type of objected stored in this

All Known Implementing Classes:

CenteredIntIntervalTree

public interface IntIntervalTree<E extends IntInterval>

Interface IntIntervalTree represents an interval tree whose elements are IntInterval objects.

Method Summary

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.

Method Detail

start

int start()

Returns the minimum start (inclusive) of an interval that can be stored in this interval tree.

Returns:

the minimum start (inclusive) of an interval that can be stored in this interval tree

end

int end()

Returns the maximum end (inclusive) of an interval that can be stored in this interval tree.

Returns:

the maximum end (inclusive) of an interval that can be stored in this interval tree

clear

void clear()

Removes all of the elements from this interval tree.

add

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. The method returns false if this.contains(E) == true when the method is invoked.

Parameters:

element - the element to be added

Returns:

true if the interval tree changed as a result of the call

Throws:

java.lang.IllegalArgumentException - if element.start() < this.start() || element.end() > this.end()

java.lang.NullPointerException - if element == null

contains

boolean contains(E element)

Returns true if the interval tree contains the specified element, and returns false otherwise.

Parameters:

element - the element whose presence in the interval tree is to be tested

Returns:

true if the interval tree contains the specified element

Throws:

java.lang.NullPointerException - if element == null

remove

boolean remove(E element)

Removes the specified element from this interval tree if the specified element is found in the interval tree.

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

Throws:

java.lang.NullPointerException - if element == null

intersect

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.

Parameters:

point - a point

collection - a collection to which will be added the elements of this interval tree that intersect the specified point

Throws:

java.lang.NullPointerException - if collection == null

intersectPart

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.

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

Throws:

java.lang.NullPointerException - if collection == null.

intersectAll

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.

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

Throws:

java.lang.NullPointerException - if collection == null

isEmpty

boolean isEmpty()

Returns true if this interval tree contains no elements.

Returns:

true if this interval tree contains no elements

size

int size()

Returns the number of elements in this interval tree.

Returns:

the number of elements in this interval tree

toArray

E[] toArray()

Returns an array containing all of the elements of this interval tree.

Returns:

an array containing all of the elements of this interval tree