| 1 | package Bio::Phylo::Matrices::Datatype::Restriction; | ||
| 2 | use strict; | ||
| 3 | use warnings; | ||
| 4 | use base 'Bio::Phylo::Matrices::Datatype'; | ||
| 5 | our ( $LOOKUP, $MISSING, $GAP ); | ||
| 6 | |||
| 7 | =head1 NAME | ||
| 8 | |||
| 9 | Bio::Phylo::Matrices::Datatype::Restriction - Validator subclass, | ||
| 10 | no serviceable parts inside | ||
| 11 | |||
| 12 | =head1 DESCRIPTION | ||
| 13 | |||
| 14 | The Bio::Phylo::Matrices::Datatype::* classes are used to validate data | ||
| 15 | contained by L<Bio::Phylo::Matrices::Matrix> and L<Bio::Phylo::Matrices::Datum> | ||
| 16 | objects. | ||
| 17 | |||
| 18 | =head2 METHODS | ||
| 19 | |||
| 20 | =over | ||
| 21 | |||
| 22 | =item get_ids_for_special_symbols() | ||
| 23 | |||
| 24 | Gets state-to-id mapping for missing and gap symbols | ||
| 25 | |||
| 26 | Type : Accessor | ||
| 27 | Title : get_ids_for_special_symbols | ||
| 28 | Usage : my %ids = %{ $obj->get_ids_for_special_symbols }; | ||
| 29 | Function: Returns state-to-id mapping | ||
| 30 | Returns : An empty hash reference | ||
| 31 | Args : None | ||
| 32 | Notes : This method is here as an override | ||
| 33 | because restriction site data has | ||
| 34 | no missing or gap symbols, just | ||
| 35 | presence/absence | ||
| 36 | |||
| 37 | =cut | ||
| 38 | |||
| 39 | sub get_ids_for_special_symbols { | ||
| 40 | return {}; | ||
| 41 | } | ||
| 42 | |||
| 43 | =back | ||
| 44 | |||
| 45 | =cut | ||
| 46 | |||
| 47 | # podinherit_insert_token | ||
| 48 | |||
| 49 | =head1 SEE ALSO | ||
| 50 | |||
| 51 | There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo> | ||
| 52 | for any user or developer questions and discussions. | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item L<Bio::Phylo::Matrices::Datatype> | ||
| 57 | |||
| 58 | This class subclasses L<Bio::Phylo::Matrices::Datatype>. | ||
| 59 | |||
| 60 | =item L<Bio::Phylo::Manual> | ||
| 61 | |||
| 62 | Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>. | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | =head1 CITATION | ||
| 67 | |||
| 68 | If you use Bio::Phylo in published research, please cite it: | ||
| 69 | |||
| 70 | B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen> | ||
| 71 | and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. | ||
| 72 | I<BMC Bioinformatics> B<12>:63. | ||
| 73 | L<http://dx.doi.org/10.1186/1471-2105-12-63> | ||
| 74 | |||
| 75 | =cut | ||
| 76 | |||
| 77 | $LOOKUP = { | ||
| 78 | '0' => ['0'], | ||
| 79 | '1' => ['1'], | ||
| 80 | }; | ||
| 81 | 1; |