Package org.dishevelled.bio.range.entrytree

Class AbstractRangeTree<C extends Comparable,V>

java.lang.Object
org.dishevelled.bio.range.entrytree.AbstractRangeTree<C,V>
Type Parameters:
C - range endpoint type
V - value type
All Implemented Interfaces:
RangeTree<C,V>
Direct Known Subclasses:
CenteredRangeTree
public abstract class AbstractRangeTree<C extends Comparable,V> extends Object implements RangeTree<C,V>
Abstract implementation of range tree. Most methods will need to be overridden to improve performance.
Author:
Michael Heuer

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.dishevelled.bio.range.entrytree.RangeTree

    RangeTree.Entry<C extends Comparable,V>

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractRangeTree()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(C location)
    Return true if the specified location intersects with any range entries in this range tree.
    int
    count(C location)
    Return the number of range entries in this range tree at the specified location.
    int
    count(com.google.common.collect.Range<C> query)
    Return the number of range entries in this range tree that intersect the specified query range.
    boolean
    intersects(com.google.common.collect.Range<C> query)
    Return true if the specified query range intersects with any range entries in this range tree.
    boolean
    intersects(Iterable<com.google.common.collect.Range<C>> query)
    Return true if any range in the specified query list of ranges intersects with any range entries in this range tree.
    boolean
    isEmpty()
    Return true if the number of range entries in this range tree is zero.
    Iterable<RangeTree.Entry<C,V>>
    query(C location)
    Return the range entries in this range tree at the specified location, if any.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.dishevelled.bio.range.entrytree.RangeTree

    intersect, size

  • Constructor Details

    • AbstractRangeTree

      public AbstractRangeTree()

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: RangeTree
      Return true if the number of range entries in this range tree is zero.
      Specified by:
      isEmpty in interface RangeTree<C extends Comparable,V>
      Returns:
      true if the number of range entries in this range tree is zero

    • contains

      public boolean contains(C location)
      Description copied from interface: RangeTree
      Return true if the specified location intersects with any range entries in this range tree.
      Specified by:
      contains in interface RangeTree<C extends Comparable,V>
      Parameters:
      location - location to intersect
      Returns:
      true if the specified location intersects with any range entries in this range tree

    • count

      public int count(C location)
      Description copied from interface: RangeTree
      Return the number of range entries in this range tree at the specified location.
      Specified by:
      count in interface RangeTree<C extends Comparable,V>
      Parameters:
      location - location
      Returns:
      the number of range entries in this range tree at the specified location

    • query

      public Iterable<RangeTree.Entry<C,V>> query(C location)
      Description copied from interface: RangeTree
      Return the range entries in this range tree at the specified location, if any.
      Specified by:
      query in interface RangeTree<C extends Comparable,V>
      Parameters:
      location - location
      Returns:
      the range entries in this range tree at the specified location, if any

    • count

      public int count(com.google.common.collect.Range<C> query)
      Description copied from interface: RangeTree
      Return the number of range entries in this range tree that intersect the specified query range.
      Specified by:
      count in interface RangeTree<C extends Comparable,V>
      Parameters:
      query - range to intersect, must not be null
      Returns:
      the number of range entries in this range tree that intersect the specified query range

    • intersects

      public boolean intersects(com.google.common.collect.Range<C> query)
      Description copied from interface: RangeTree
      Return true if the specified query range intersects with any range entries in this range tree.
      Specified by:
      intersects in interface RangeTree<C extends Comparable,V>
      Parameters:
      query - range to intersect, must not be null
      Returns:
      true if the specified query range intersects with any range entries in this range tree

    • intersects

      public boolean intersects(Iterable<com.google.common.collect.Range<C>> query)
      Description copied from interface: RangeTree
      Return true if any range in the specified query list of ranges intersects with any range entries in this range tree.
      Specified by:
      intersects in interface RangeTree<C extends Comparable,V>
      Parameters:
      query - list of ranges to intersect, must not be null
      Returns:
      true if any range in the specified query list of ranges intersects with any range entries in this range tree