File Coverage

blib/lib/Bio/Phylo/Matrices.pm
Criterion Covered Total %
statement 11 11 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod n/a
total 16 16 100.0


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