LICENSE

Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute Copyright [2016-2024] EMBL-European Bioinformatics Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CONTACT

Please email comments or questions to the public Ensembl
developers list at <http://lists.ensembl.org/mailman/listinfo/dev>.

Questions may also be sent to the Ensembl help desk at
<http://www.ensembl.org/Help/Contact>.

NAME

Bio::EnsEMBL::Utils::Tree::Interval::Mutable

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.

METHODS

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