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::Immutable::Node

DESCRIPTION

Instances of this class represent nodes in a centered immutable interval tree.

METHODS

new

Arg [1]     : scalar, $x_center
              The mid point of the intervals represented by the node
Arg [2]     : Arrayref of Bio::EnsEMBL::Utils::Interval instances
              Represents the set of intervals overlapping $x_center
Arg [3]     : Bio::EnsEMBL::Utils::Tree::Interval::Immutable::Node
              The left subtree
Arg [4]     : Bio::EnsEMBL::Utils::Tree::Interval::Immutable::Node
              The right subtree
Description : Constructor. Creates a new centered immutable interval tree node instance
Returntype  : Bio::EnsEMBL::Utils::Tree::Interval::Immutable::Node
Exceptions  : if $x_center is not a number or the remaining args are not of the
              correct type
Caller      : general

x_center

Arg []      : none
Description : Return the center point of the intervals represented by the node
Returntype  : scalar
Exceptions  : none
Caller      : general

s_center_beg

Arg []      : none
Description : Returns the set of intervals containing the center point sorted by their start point
Returntype  : Arrayref of Bio::EnsEMBL::Utils::Interval
Exceptions  : none
Caller      : general

s_center_end

Arg []      : none
Description : Returns the set of intervals containing the center point sorted by their end point
Returntype  : Arrayref of Bio::EnsEMBL::Utils::Interval
Exceptions  : none
Caller      : general

left

Arg []      : none
Description : Returns the node's left child
Returntype  : Bio::EnsEMBL::Utils::Tree::Interval::Immutable::Node
Exceptions  : none
Caller      : general
Arg []      : none
Description : Returns the node's right child
Returntype  : Bio::EnsEMBL::Utils::Tree::Interval::Immutable::Node
Exceptions  : none
Caller      : general