Bio/Location/NarrowestCoordPolicy.pm

filter: Statementstmt 100% 19 / 19 Branchbran 50.0% 2 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 5 / 5 Podpod 100% 3 / 3 totaltotal 93.5% 29 / 31 CC 3 SCAR 4.6
CC
3
Cov
91%
start
2.0
end
2.0
BEGIN
1.0
CRAP 1.6
« Bio/Tools/Tmhmm.pm ↑ Summary Bio/Factory/ObjectBuilderI.pm »
1 #
2 # BioPerl module for Bio::Location::NarrowestCoordPolicy
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::NarrowestCoordPolicy - class implementing
17 Bio::Location::CoordinatePolicy as the narrowest 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 narrowest possible
30 range is returned, but by using some common sense. This means that e.g.
31 locations like "E<gt>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.netE<gt>, E<lt>jason@bioperl.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::NarrowestCoordPolicy;
77 2 $Bio::Location::NarrowestCoordPolicy::VERSION = '1.7.8';
78 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
79  
80  
81 2 ▶use base qw(Bio::Root::Root Bio::Location::CoordinatePolicyI);
Subroutine BEGIN: called CC=1 SCAR=0.0
82  
83 1 ▶sub new {
Subroutine new: called CC=1 SCAR=0.0
Pod documented
84 1 my ($class, @args) = @_;
85 1 my $self = $class->SUPER::new(@args);
86  
87 1 return $self;
88 }
89  
90  
91 =head2 start
92  
93 Title : start
94 Usage : $start = $policy->start($location);
95 Function: Get the integer-valued start coordinate of the given location as
96 computed by this computation policy.
97 Returns : A positive integer number.
98 Args : A Bio::LocationI implementing object.
99  
100 =cut
101  
102 3 ▶sub start {
Subroutine start: called CC=2 SCAR=7.0
Pod documented
103 3 my ($self,$loc) = @_;
104  
105 # For performance reasons we don't check that it's indeed a Bio::LocationI
106 # object. Hopefully, Location-object programmers are smart enough.
107 3 my $pos = $loc->max_start();
108 # if max is not defined or equals 0 we resort to min
109 3 ▶ $pos = $loc->min_start() if(! $pos);
Branch: 1 branch
BranchTrueFalseTotal
unless $pos 0 3 3
110 3 return $pos;
111 }
112  
113 =head2 end
114  
115 Title : end
116 Usage : $end = $policy->end($location);
117 Function: Get the integer-valued end coordinate of the given location as
118 computed by this computation policy.
119 Returns : A positive integer number.
120 Args : A Bio::LocationI implementing object.
121  
122 =cut
123  
124 3 ▶sub end {
Subroutine end: called CC=2 SCAR=7.0
Pod documented
125 3 my ($self,$loc) = @_;
126  
127 # For performance reasons we don't check that it's indeed a Bio::LocationI
128 # object. Hopefully, Location-object programmers are smart enough.
129 3 my $pos = $loc->min_end();
130 # if min is not defined or equals 0 we resort to max
131 3 ▶ $pos = $loc->max_end() if(! $pos);
Branch: 1 branch
BranchTrueFalseTotal
unless $pos 0 3 3
132 3 return $pos;
133 }
134  
135 2 1;
136  
« Bio/Tools/Tmhmm.pm ↑ Summary Bio/Factory/ObjectBuilderI.pm »