Bio::EnsEMBL::Utils::Tree::Interval::Mutable Class Reference

Public Member Functions
public Bio::EnsEMBL::Utils::Tree::Interval::Mutable	new ()
protected	_load_xs ()
protected	_load_pp ()
protected	_load ()

Detailed Description

Synopsis

# start with an empty tree
my $tree = Bio::EnsEMBL::Utils::Tree::Interval::Mutable->new();
 
# add a few intervals (i.e. Bio::EnsEMBL::Utils::Interval)
$tree->insert($i1);
$tree->insert($i2);
$tree->insert($i3);
 
# query the tree
my $result = $tree->search(85, 100);
if (scalar @{$result}) {
  print "Found overlapping interval: [", $result->[0]->start, ', ', $result->[0]->end, "\n";
}

Description

Class representing a dynamic, i.e. mutable, interval tree implemented as an augmented AVL balanced binary tree.

This module is a wrapper around two possible implementations: one using the Perl extension (XS) mechanisms, and
a pure Perl (PP) one. 

The module is capable of detecting whether the XS module is available and it loads it in that
case; it falls back to the PP implementation otherwise.
 

Definition at line 37 of file Mutable.pm.

Member Function Documentation

_load()

protected Bio::EnsEMBL::Utils::Tree::Interval::Mutable::_load

(

)

Undocumented method

Code:

_load_pp()

protected Bio::EnsEMBL::Utils::Tree::Interval::Mutable::_load_pp

(

)

Undocumented method

Code:

_load_xs()

protected Bio::EnsEMBL::Utils::Tree::Interval::Mutable::_load_xs

(

)

Undocumented method

Code:

new()

public Bio::EnsEMBL::Utils::Tree::Interval::Mutable Bio::EnsEMBL::Utils::Tree::Interval::Mutable::new

(

)

  Arg []      : none
  Example     :

my $tree = Bio::EnsEMBL::Utils::Tree::Mutable();

  Description : Constructor. Creates a new mutable tree instance
  Returntype  : Bio::EnsEMBL::Utils::Tree::Interval::Mutable
  Exceptions  : none
  Caller      : general

Code:

---

The documentation for this class was generated from the following file:

• ensembl/modules/Bio/EnsEMBL/Utils/Tree/Interval/Mutable.pm