Bio::Phylo::Matrices - Container of matrix objects


Bio-Phylo documentation Contained in the Bio-Phylo distribution.

Index


Code Index:

NAME

Top

Bio::Phylo::Matrices - Container of matrix objects

SYNOPSIS

Top

 use Bio::Phylo::Matrices;
 use Bio::Phylo::Matrices::Matrix;

 my $matrices = Bio::Phylo::Matrices->new;
 my $matrix   = Bio::Phylo::Matrices::Matrix->new;

 $matrices->insert($matrix);

DESCRIPTION

Top

The Bio::Phylo::Matrices object models a set of matrices. It inherits from the Bio::Phylo::Listable object, and so the filtering methods of that object are available to apply to a set of matrices.

METHODS

Top

CONSTRUCTOR

new()

Matrices constructor.

 Type    : Constructor
 Title   : new
 Usage   : my $matrices = Bio::Phylo::Matrices->new;
 Function: Initializes a Bio::Phylo::Matrices object.
 Returns : A Bio::Phylo::Matrices object.
 Args    : None required.

SEE ALSO

Top

Bio::Phylo::Listable

The Bio::Phylo::Matrices object inherits from the Bio::Phylo::Listable object. Look there for more methods applicable to the matrices object.

Bio::Phylo::Manual

Also see the manual: Bio::Phylo::Manual and http://rutgervos.blogspot.com.

CITATION

Top

If you use Bio::Phylo in published research, please cite it:

Rutger A Vos, Jason Caravas, Klaas Hartmann, Mark A Jensen and Chase Miller, 2011. Bio::Phylo - phyloinformatic analysis using Perl. BMC Bioinformatics 12:63. http://dx.doi.org/10.1186/1471-2105-12-63

REVISION

Top

 $Id: Matrices.pm 1660 2011-04-02 18:29:40Z rvos $


Bio-Phylo documentation Contained in the Bio-Phylo distribution.
# $Id: Matrices.pm 1660 2011-04-02 18:29:40Z rvos $
package Bio::Phylo::Matrices;
use strict;
use base 'Bio::Phylo::Listable';
use Bio::Phylo::Util::CONSTANT qw'_NONE_ _MATRICES_';

{
    my $TYPE      = _MATRICES_;
    my $CONTAINER = _NONE_;
    my $logger    = __PACKAGE__->get_logger;

    #    sub new {
    #        # could be child class
    #        my $class = shift;
    #
    #        # notify user
    #        $logger->info("constructor called for '$class'");
    #
    #        # recurse up inheritance tree, get ID
    #        my $self = $class->SUPER::new( @_ );
    #
    #        # local fields would be set here
    #
    #        return $self;
    #    }

    sub _container { $CONTAINER }

    sub _type { $TYPE }

    # podinherit_insert_token

}
1;