| 1 | # | ||||||||||
| 2 | # BioPerl module for Bio::Location::WidestCoordPolicy | ||||||||||
| 3 | # | ||||||||||
| 4 | # Please direct questions and support issues to <bioperl-l@bioperl.org> | ||||||||||
| 5 | # | ||||||||||
| 6 | # Cared for by Hilmar Lapp <hlapp@gmx.net> | ||||||||||
| 7 | # and Jason Stajich <jason@bioperl.org> | ||||||||||
| 8 | # | ||||||||||
| 9 | # Copyright Hilmar Lapp, Jason Stajich | ||||||||||
| 10 | # | ||||||||||
| 11 | # You may distribute this module under the same terms as perl itself | ||||||||||
| 12 | # POD documentation - main docs before the code | ||||||||||
| 13 | |||||||||||
| 14 | =head1 NAME | ||||||||||
| 15 | |||||||||||
| 16 | Bio::Location::WidestCoordPolicy - class implementing | ||||||||||
| 17 | Bio::Location::CoordinatePolicy as the widest possible and reasonable range | ||||||||||
| 18 | |||||||||||
| 19 | =head1 SYNOPSIS | ||||||||||
| 20 | |||||||||||
| 21 | See Bio::Location::CoordinatePolicyI | ||||||||||
| 22 | |||||||||||
| 23 | =head1 DESCRIPTION | ||||||||||
| 24 | |||||||||||
| 25 | CoordinatePolicyI implementing objects are used by Bio::LocationI | ||||||||||
| 26 | implementing objects to determine integer-valued coordinates when | ||||||||||
| 27 | asked for it. | ||||||||||
| 28 | |||||||||||
| 29 | This class will compute the coordinates such that always the widest possible | ||||||||||
| 30 | range is returned, but by using some common sense. This means that e.g. | ||||||||||
| 31 | locations like "E<lt>5..100" (start before position 5) will return 5 as start | ||||||||||
| 32 | (returned values have to be positive integers). | ||||||||||
| 33 | |||||||||||
| 34 | =head1 FEEDBACK | ||||||||||
| 35 | |||||||||||
| 36 | User feedback is an integral part of the evolution of this and other | ||||||||||
| 37 | Bioperl modules. Send your comments and suggestions preferably to one | ||||||||||
| 38 | of the Bioperl mailing lists. Your participation is much appreciated. | ||||||||||
| 39 | |||||||||||
| 40 | bioperl-l@bioperl.org - General discussion | ||||||||||
| 41 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||||||||||
| 42 | |||||||||||
| 43 | =head2 Support | ||||||||||
| 44 | |||||||||||
| 45 | Please direct usage questions or support issues to the mailing list: | ||||||||||
| 46 | |||||||||||
| 47 | I<bioperl-l@bioperl.org> | ||||||||||
| 48 | |||||||||||
| 49 | rather than to the module maintainer directly. Many experienced and | ||||||||||
| 50 | reponsive experts will be able look at the problem and quickly | ||||||||||
| 51 | address it. Please include a thorough description of the problem | ||||||||||
| 52 | with code and data examples if at all possible. | ||||||||||
| 53 | |||||||||||
| 54 | =head2 Reporting Bugs | ||||||||||
| 55 | |||||||||||
| 56 | Report bugs to the Bioperl bug tracking system to help us keep track | ||||||||||
| 57 | the bugs and their resolution. Bug reports can be submitted via the | ||||||||||
| 58 | web: | ||||||||||
| 59 | |||||||||||
| 60 | https://github.com/bioperl/bioperl-live/issues | ||||||||||
| 61 | |||||||||||
| 62 | =head1 AUTHOR - Hilmar Lapp, Jason Stajich | ||||||||||
| 63 | |||||||||||
| 64 | Email E<lt>hlapp-at-gmx-dot-netE<gt>, E<lt>jason-at-bioperl-dot-orgE<gt> | ||||||||||
| 65 | |||||||||||
| 66 | =head1 APPENDIX | ||||||||||
| 67 | |||||||||||
| 68 | The rest of the documentation details each of the object | ||||||||||
| 69 | methods. Internal methods are usually preceded with a _ | ||||||||||
| 70 | |||||||||||
| 71 | =cut | ||||||||||
| 72 | |||||||||||
| 73 | # Let the code begin... | ||||||||||
| 74 | |||||||||||
| 75 | |||||||||||
| 76 | package Bio::Location::WidestCoordPolicy; | ||||||||||
| 77 | 329 | $Bio::Location::WidestCoordPolicy::VERSION = '1.7.8'; | |||||||||
| 78 | 329 | ▶ | use strict; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 79 | |||||||||||
| 80 | |||||||||||
| 81 | 329 | ▶ | use base qw(Bio::Root::Root Bio::Location::CoordinatePolicyI); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 82 | |||||||||||
| 83 | 329 | ▶ | sub new { | ||||||||
|
Subroutine
new: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 84 | 329 | my ($class, @args) = @_; | |||||||||
| 85 | 329 | my $self = $class->SUPER::new(@args); | |||||||||
| 86 | |||||||||||
| 87 | 329 | return $self; | |||||||||
| 88 | } | ||||||||||
| 89 | |||||||||||
| 90 | |||||||||||
| 91 | |||||||||||
| 92 | =head2 start | ||||||||||
| 93 | |||||||||||
| 94 | Title : start | ||||||||||
| 95 | Usage : $start = $policy->start($location); | ||||||||||
| 96 | Function: Get the integer-valued start coordinate of the given location as | ||||||||||
| 97 | computed by this computation policy. | ||||||||||
| 98 | Returns : A positive integer number. | ||||||||||
| 99 | Args : A Bio::LocationI implementing object. | ||||||||||
| 100 | |||||||||||
| 101 | =cut | ||||||||||
| 102 | |||||||||||
| 103 | 38889 | ▶ | sub start { | ||||||||
|
Subroutine
start: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||
| 104 | 38889 | my ($self,$loc) = @_; | |||||||||
| 105 | |||||||||||
| 106 | # For performance reasons we don't check that it's indeed a Bio::LocationI | ||||||||||
| 107 | # object. Hopefully, Location-object programmers are smart enough. | ||||||||||
| 108 | 38889 | my $pos = $loc->min_start(); | |||||||||
| 109 | # if min is not defined or equals 0 we resort to max | ||||||||||
| 110 | 38889 | ▶ | $pos = $loc->max_start() if(! $pos); | ||||||||
|
Branch: 1 branch
| |||||||||||
| 111 | 38889 | return $pos; | |||||||||
| 112 | } | ||||||||||
| 113 | |||||||||||
| 114 | =head2 end | ||||||||||
| 115 | |||||||||||
| 116 | Title : end | ||||||||||
| 117 | Usage : $end = $policy->end($location); | ||||||||||
| 118 | Function: Get the integer-valued end coordinate of the given location as | ||||||||||
| 119 | computed by this computation policy. | ||||||||||
| 120 | Returns : A positive integer number. | ||||||||||
| 121 | Args : A Bio::LocationI implementing object. | ||||||||||
| 122 | |||||||||||
| 123 | =cut | ||||||||||
| 124 | |||||||||||
| 125 | 35224 | ▶ | sub end { | ||||||||
|
Subroutine
end: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||
| 126 | 35224 | my ($self,$loc) = @_; | |||||||||
| 127 | |||||||||||
| 128 | # For performance reasons we don't check that it's indeed a Bio::LocationI | ||||||||||
| 129 | # object. Hopefully, Location-object programmers are smart enough. | ||||||||||
| 130 | 35224 | my $pos = $loc->max_end(); | |||||||||
| 131 | # if max is not defined or equals 0 we resort to min | ||||||||||
| 132 | 35224 | ▶ | $pos = $loc->min_end() if(! $pos); | ||||||||
|
Branch: 1 branch
| |||||||||||
| 133 | 35224 | return $pos; | |||||||||
| 134 | } | ||||||||||
| 135 | |||||||||||
| 136 | 329 | 1; | |||||||||
| 137 | |||||||||||