| 1 | package Bio::Phylo::Matrices; | ||
| 2 | 1 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 3 | 1 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | ▶ | use base 'Bio::Phylo::Listable'; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | 1 | ▶ | use Bio::Phylo::Util::CONSTANT qw'_NONE_ _MATRICES_'; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | |||
| 7 | =begin comment | ||
| 8 | |||
| 9 | This class has no internal state, no cleanup is necessary. | ||
| 10 | |||
| 11 | =end comment | ||
| 12 | |||
| 13 | =cut | ||
| 14 | |||
| 15 | { | ||
| 16 | 1 | my $TYPE = _MATRICES_; | |
| 17 | 1 | my $CONTAINER = _NONE_; | |
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Bio::Phylo::Matrices - Container of matrix objects | ||
| 22 | |||
| 23 | =head1 SYNOPSIS | ||
| 24 | |||
| 25 | use Bio::Phylo::Matrices; | ||
| 26 | use Bio::Phylo::Matrices::Matrix; | ||
| 27 | |||
| 28 | my $matrices = Bio::Phylo::Matrices->new; | ||
| 29 | my $matrix = Bio::Phylo::Matrices::Matrix->new; | ||
| 30 | |||
| 31 | $matrices->insert($matrix); | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | The L<Bio::Phylo::Matrices> object models a set of matrices. It inherits from | ||
| 36 | the L<Bio::Phylo::Listable> object, and so the filtering methods of that object | ||
| 37 | are available to apply to a set of matrices. | ||
| 38 | |||
| 39 | =begin comment | ||
| 40 | |||
| 41 | Type : Internal method | ||
| 42 | Title : _container | ||
| 43 | Usage : $matrices->_container; | ||
| 44 | Function: | ||
| 45 | Returns : CONSTANT | ||
| 46 | Args : | ||
| 47 | |||
| 48 | =end comment | ||
| 49 | |||
| 50 | =cut | ||
| 51 | |||
| 52 | 1 | ▶ | sub _container { $CONTAINER } |
|
Subroutine
_container: called CC=1 SCAR=0.0
| |||
| 53 | |||
| 54 | =begin comment | ||
| 55 | |||
| 56 | Type : Internal method | ||
| 57 | Title : _type | ||
| 58 | Usage : $matrices->_type; | ||
| 59 | Function: | ||
| 60 | Returns : CONSTANT | ||
| 61 | Args : | ||
| 62 | |||
| 63 | =end comment | ||
| 64 | |||
| 65 | =cut | ||
| 66 | |||
| 67 | 5 | ▶ | sub _type { $TYPE } |
|
Subroutine
_type: called CC=1 SCAR=0.0
| |||
| 68 | |||
| 69 | # podinherit_insert_token | ||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo> | ||
| 74 | for any user or developer questions and discussions. | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item L<Bio::Phylo::Listable> | ||
| 79 | |||
| 80 | The L<Bio::Phylo::Matrices> object inherits from the L<Bio::Phylo::Listable> | ||
| 81 | object. Look there for more methods applicable to the matrices object. | ||
| 82 | |||
| 83 | =item L<Bio::Phylo::Manual> | ||
| 84 | |||
| 85 | Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>. | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | =head1 CITATION | ||
| 90 | |||
| 91 | If you use Bio::Phylo in published research, please cite it: | ||
| 92 | |||
| 93 | B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen> | ||
| 94 | and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. | ||
| 95 | I<BMC Bioinformatics> B<12>:63. | ||
| 96 | L<http://dx.doi.org/10.1186/1471-2105-12-63> | ||
| 97 | |||
| 98 | =cut | ||
| 99 | |||
| 100 | } | ||
| 101 | 1 | 1; | |