Bio/RangeI.pm

filter: Statementstmt 81.3% 170 / 209 Branchbran 58.3% 84 / 144 Conditioncond 60.4% 29 / 48 MC/DCmcdc 48.1% 13 / 27 Subroutinesub 100% 23 / 23 Podpod 100% 13 / 13 totaltotal 71.5% 332 / 464 CC 92 SCAR 31.8
CC
92
Cov
71%
overlap_extent
95.7
equals
56.7
intersection
25.2
CRAP 24.0
« Bio/SeqIO/swissdriver.pm ↑ Summary Bio/AlignIO/po.pm »
1 #
2 # BioPerl module for Bio::RangeI
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Lehvaslaiho <heikki-at-bioperl-dot-org>
7 #
8 # Copyright Matthew Pocock
9 #
10 # You may distribute this module under the same terms as perl itself
11 #
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::RangeI - Range interface
17  
18 =head1 SYNOPSIS
19  
20 #Do not run this module directly
21  
22 =head1 DESCRIPTION
23  
24 This provides a standard BioPerl range interface that should be
25 implemented by any object that wants to be treated as a range. This
26 serves purely as an abstract base class for implementers and can not
27 be instantiated.
28  
29 Ranges are modeled as having (start, end, length, strand). They use
30 Bio-coordinates - all points E<gt>= start and E<lt>= end are within the
31 range. End is always greater-than or equal-to start, and length is
32 greater than or equal to 1. The behaviour of a range is undefined if
33 ranges with negative numbers or zero are used.
34  
35 So, in summary:
36  
37 length = end - start + 1
38 end >= start
39 strand = (-1 | 0 | +1)
40  
41 =head1 FEEDBACK
42  
43 =head2 Mailing Lists
44  
45 User feedback is an integral part of the evolution of this and other
46 Bioperl modules. Send your comments and suggestions preferably to one
47 of the Bioperl mailing lists. Your participation is much appreciated.
48  
49 bioperl-l@bioperl.org - General discussion
50 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
51  
52 =head2 Support
53  
54 Please direct usage questions or support issues to the mailing list:
55  
56 I<bioperl-l@bioperl.org>
57  
58 rather than to the module maintainer directly. Many experienced and
59 reponsive experts will be able look at the problem and quickly
60 address it. Please include a thorough description of the problem
61 with code and data examples if at all possible.
62  
63 =head2 Reporting Bugs
64  
65 Report bugs to the Bioperl bug tracking system to help us keep track
66 the bugs and their resolution. Bug reports can be submitted via the
67 web:
68  
69 https://github.com/bioperl/bioperl-live/issues
70  
71 =head1 AUTHOR - Heikki Lehvaslaiho
72  
73 Email: heikki-at-bioperl-dot-org
74  
75 =head1 CONTRIBUTORS
76  
77 Juha Muilu (muilu@ebi.ac.uk)
78 Sendu Bala (bix@sendu.me.uk)
79 Malcolm Cook (mec@stowers-institute.org)
80 Stephen Montgomery (sm8 at sanger.ac.uk)
81  
82 =head1 APPENDIX
83  
84 The rest of the documentation details each of the object
85 methods. Internal methods are usually preceded with a _
86  
87 =cut
88  
89 package Bio::RangeI;
90 376 $Bio::RangeI::VERSION = '1.7.8';
91 376 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
92 376 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
93 376 ▶use integer;
Subroutine BEGIN: called CC=1 SCAR=0.0
94 376 ▶use vars qw(%STRAND_OPTIONS);
Subroutine BEGIN: called CC=1 SCAR=0.0
95  
96 376 ▶use base qw(Bio::Root::RootI);
Subroutine BEGIN: called CC=1 SCAR=0.0
97  
98 376 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
99 # STRAND_OPTIONS contains the legal values for the strand-testing options
100 376 %STRAND_OPTIONS = map { $_, '_' . $_ }
101 (
102 'strong', # ranges must have the same strand
103 'weak', # ranges must have the same strand or no strand
104 'ignore', # ignore strand information
105 );
106 }
107  
108 # utility methods
109 #
110  
111 # returns true if strands are equal and non-zero
112 8 ▶sub _strong {
Subroutine _strong: called CC=3 SCAR=11.0
113 8 my ($r1, $r2) = @_;
114 8 my ($s1, $s2) = ($r1->strand(), $r2->strand());
115  
116 8 ▶ return 1 if $s1 != 0 && $s1 == $s2;
Branch: 1 branch
BranchTrueFalseTotal
if $s1 != 0 and $s1 == $s2 1 7 8
Condition100%3/3
$s1 != 0 and $s1 == $s2
!ll&&!rl&&r
161
MC/DC100%2/2
$s1 != 0 and $s1 == $s2
$s1 != 0 $s1 == $s2
Truth table100%3/3
A and B
A= $s1 != 0B= $s1 == $s2
ABresult
0X0
100
111
117 }
118  
119 # returns true if strands are equal or either is zero
120 8 ▶sub _weak {
Subroutine _weak: called CC=4 SCAR=13.9
121 8 my ($r1, $r2) = @_;
122 8 my ($s1, $s2) = ($r1->strand(), $r2->strand());
123 8 ▶ return 1 if $s1 == 0 || $s2 == 0 || $s1 == $s2;
Branch: 1 branch
BranchTrueFalseTotal
if $s1 == 0 or $s2 == 0 or $s1 == $s2 4 4 8
Condition100%6/6
$s1 == 0 or $s2 == 0 or $s1 == $s2
l!l&&r!l&&!r
314
$s1 == 0 or $s2 == 0
l!l&&r!l&&!r
125
MC/DC100%3/3
$s1 == 0 or $s2 == 0 or $s1 == $s2
$s1 == 0 $s2 == 0 $s1 == $s2
Truth table100%4/4
A or B or C
A= $s1 == 0B= $s2 == 0C= $s1 == $s2
ABCresult
1XX1
01X1
0011
0000
124 }
125  
126 # returns true for any strandedness
127 1 ▶sub _ignore {
Subroutine _ignore: called CC=1 SCAR=0.0
128 1 return 1;
129 }
130  
131 # works out what test to use for the strictness and returns true/false
132 # e.g. $r1->_testStrand($r2, 'strong')
133 12720 ▶sub _testStrand() {
Subroutine _testStrand: called CC=2 SCAR=6.9
134 12720 my ($r1, $r2, $comp) = @_;
135 12720 ▶ return 1 unless $comp;
Branch: 1 branch
BranchTrueFalseTotal
unless $comp 12710 10 12720
136 10 my $func = $STRAND_OPTIONS{$comp};
137 10 return $r1->$func($r2);
138 }
139  
140 =head1 Abstract methods
141  
142 These methods must be implemented in all subclasses.
143  
144 =head2 start
145  
146 Title : start
147 Usage : $start = $range->start();
148 Function: get/set the start of this range
149 Returns : the start of this range
150 Args : optionally allows the start to be set
151 using $range->start($start)
152  
153 =cut
154  
155 1 ▶sub start {
Subroutine start: called CC=1 SCAR=0.0
Pod documented
156 1 shift->throw_not_implemented();
157 }
158  
159 =head2 end
160  
161 Title : end
162 Usage : $end = $range->end();
163 Function: get/set the end of this range
164 Returns : the end of this range
165 Args : optionally allows the end to be set
166 using $range->end($end)
167  
168 =cut
169  
170 1 ▶sub end {
Subroutine end: called CC=1 SCAR=0.0
Pod documented
171 1 shift->throw_not_implemented();
172 }
173  
174 =head2 length
175  
176 Title : length
177 Usage : $length = $range->length();
178 Function: get/set the length of this range
179 Returns : the length of this range
180 Args : optionally allows the length to be set
181 using $range->length($length)
182  
183 =cut
184  
185 1 ▶sub length {
Subroutine length: called CC=1 SCAR=0.0
Pod documented
186 1 shift->throw_not_implemented();
187 }
188  
189 =head2 strand
190  
191 Title : strand
192 Usage : $strand = $range->strand();
193 Function: get/set the strand of this range
194 Returns : the strandedness (-1, 0, +1)
195 Args : optionally allows the strand to be set
196 using $range->strand($strand)
197  
198 =cut
199  
200 1 ▶sub strand {
Subroutine strand: called CC=1 SCAR=0.0
Pod documented
201 1 shift->throw_not_implemented();
202 }
203  
204 =head1 Boolean Methods
205  
206 These methods return true or false. They throw an error if start and
207 end are not defined.
208  
209 $range->overlaps($otherRange) && print "Ranges overlap\n";
210  
211 =head2 overlaps
212  
213 Title : overlaps
214 Usage : if($r1->overlaps($r2)) { do stuff }
215 Function: tests if $r2 overlaps $r1
216 Args : arg #1 = a range to compare this one to (mandatory)
217 arg #2 = optional strand-testing arg ('strong', 'weak', 'ignore')
218 Returns : true if the ranges overlap, false otherwise
219  
220 =cut
221  
222 39 ▶sub overlaps {
Subroutine overlaps: called CC=9 SCAR=23.6
Pod documented
223 39 my ($self, $other, $so) = @_;
224  
225 39 ▶ $self->throw("start is undefined") unless defined $self->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->start 0 38 38
226 38 ▶ $self->throw("end is undefined") unless defined $self->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->end 0 38 38
227 38 ▶ $self->throw("not a Bio::RangeI object") unless defined $other &&
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other and $other->isa("Bio::RangeI") 0 38 38
Condition33%1/3
defined $other and $other->isa("Bio::RangeI")
!ll&&!rl&&r
0038
MC/DC0%0/2
defined $other and $other->isa("Bio::RangeI")
defined $other $other->isa("Bio::RangeI")
Truth table33%1/3
A and B
A= defined $otherB= $other->isa("Bio::RangeI")
ABresult
0X0
100
111
228 $other->isa('Bio::RangeI');
229 38 ▶ $other->throw("start is undefined") unless defined $other->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->start 0 38 38
230 38 ▶ $other->throw("end is undefined") unless defined $other->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->end 0 38 38
231  
232 return
233 38 ▶ ($self->_testStrand($other, $so)
Condition100%6/6
$self->_testStrand($other, $so) && !($self->start > $other->end || $self->end < $other->start)
!ll&&!rl&&r
61616
$self->start > $other->end || $self->end < $other->start
l!l&&r!l&&!r
8816
MC/DC100%3/3
$self->_testStrand($other, $so) && !($self->start > $other->end || $self->end < $other->start)
$self->_testStrand($other, $so) $self->start > $other->end $self->end < $other->start
Truth table100%4/4
A && not(B || C)
A= $self->_testStrand($other, $so)B= $self->start > $other->endC= $self->end < $other->start
ABCresult
0XX0
11X0
1010
1001
234 and not (
235 ($self->start() > $other->end() or
236 $self->end() < $other->start() )
237 ));
238 }
239  
240 =head2 contains
241  
242 Title : contains
243 Usage : if($r1->contains($r2) { do stuff }
244 Function: tests whether $r1 totally contains $r2
245 Args : arg #1 = a range to compare this one to (mandatory)
246 alternatively, integer scalar to test
247 arg #2 = optional strand-testing arg ('strong', 'weak', 'ignore')
248 Returns : true if the argument is totally contained within this range
249  
250 =cut
251  
252 8237 ▶sub contains {
Subroutine contains: called CC=12 SCAR=32.0
Pod documented
253 8237 my ($self, $other, $so) = @_;
254 8237 ▶ $self->throw("start is undefined") unless defined $self->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->start 0 8236 8236
255 8236 ▶ $self->throw("end is undefined") unless defined $self->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->end 0 8236 8236
256  
257 8236 ▶ if(defined $other && ref $other) { # a range object?
Branch: 1 branch
BranchTrueFalseTotal
if (defined $other and ref $other) { } 8236 0 8236
Condition33%1/3
defined $other and ref $other
!ll&&!rl&&r
008236
MC/DC0%0/2
defined $other and ref $other
defined $other ref $other
Truth table33%1/3
A and B
A= defined $otherB= ref $other
ABresult
0X0
100
111
258 8236 ▶ $other->throw("Not a Bio::RangeI object: $other") unless $other->isa('Bio::RangeI');
Branch: 1 branch
BranchTrueFalseTotal
unless $other->isa("Bio::RangeI") 0 8236 8236
259 8236 ▶ $other->throw("start is undefined") unless defined $other->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->start 0 8236 8236
260 8236 ▶ $other->throw("end is undefined") unless defined $other->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->end 0 8236 8236
261  
262 8236 ▶ return ($self->_testStrand($other, $so) and
Condition83%5/6
$self->_testStrand($other, $so) && $other->start >= $self->start && $other->end <= $self->end
!ll&&!rl&&r
428230
$self->_testStrand($other, $so) and $other->start >= $self->start
!ll&&!rl&&r
048232
MC/DC66%2/3
$self->_testStrand($other, $so) && $other->start >= $self->start && $other->end <= $self->end
$self->_testStrand($other, $so) $other->start >= $self->start $other->end <= $self->end
Truth table75%3/4
A and B && C
A= $self->_testStrand($other, $so)B= $other->start >= $self->startC= $other->end <= $self->end
ABCresult
0XX0
10X0
1100
1111
263 $other->start() >= $self->start() and
264 $other->end() <= $self->end());
265 } else { # a scalar?
266 0 ▶ $self->throw("'$other' is not an integer.\n") unless $other =~ /^[-+]?\d+$/;
Branch: 1 branch
BranchTrueFalseTotal
unless $other =~ /^[-+]?\d+$/ 0 0 0
267 0 ▶ return ($other >= $self->start() and $other <= $self->end());
Condition0%0/3
$other >= $self->start && $other <= $self->end
!ll&&!rl&&r
000
MC/DC0%0/2
$other >= $self->start && $other <= $self->end
$other >= $self->start $other <= $self->end
Truth table0%0/3
A && B
A= $other >= $self->startB= $other <= $self->end
ABresult
0X0
100
111
268 }
269 }
270  
271 =head2 equals
272  
273 Title : equals
274 Usage : if($r1->equals($r2))
275 Function: test whether $r1 has the same start, end, length as $r2
276 Args : arg #1 = a range to compare this one to (mandatory)
277 arg #2 = optional strand-testing arg ('strong', 'weak', 'ignore')
278 Returns : true if they are describing the same range
279  
280 =cut
281  
282 1 ▶sub equals {
Subroutine equals: called CC=8 SCAR=40.4
Pod documented
283 1 my ($self, $other, $so) = @_;
284  
285 1 ▶ $self->throw("start is undefined") unless defined $self->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->start 0 0 0
286 0 ▶ $self->throw("end is undefined") unless defined $self->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->end 0 0 0
287 0 ▶ $other->throw("Not a Bio::RangeI object") unless $other->isa('Bio::RangeI');
Branch: 1 branch
BranchTrueFalseTotal
unless $other->isa("Bio::RangeI") 0 0 0
288 0 ▶ $other->throw("start is undefined") unless defined $other->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->start 0 0 0
289 0 ▶ $other->throw("end is undefined") unless defined $other->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $other->end 0 0 0
290  
291 0 ▶ return ($self->_testStrand($other, $so) and
Condition0%0/6
$self->_testStrand($other, $so) && $self->start == $other->start && $self->end == $other->end
!ll&&!rl&&r
000
$self->_testStrand($other, $so) and $self->start == $other->start
!ll&&!rl&&r
000
MC/DC0%0/3
$self->_testStrand($other, $so) && $self->start == $other->start && $self->end == $other->end
$self->_testStrand($other, $so) $self->start == $other->start $self->end == $other->end
Truth table0%0/4
A and B && C
A= $self->_testStrand($other, $so)B= $self->start == $other->startC= $self->end == $other->end
ABCresult
0XX0
10X0
1100
1111
292 $self->start() == $other->start() and
293 $self->end() == $other->end() );
294 }
295  
296 =head1 Geometrical methods
297  
298 These methods do things to the geometry of ranges, and return
299 Bio::RangeI compliant objects or triplets (start, stop, strand) from
300 which new ranges could be built.
301  
302 =head2 intersection
303  
304 Title : intersection
305 Usage : ($start, $end, $strand) = $r1->intersection($r2); OR
306 ($start, $end, $strand) = Bio::Range->intersection(\@ranges); OR
307 my $containing_range = $r1->intersection($r2); OR
308 my $containing_range = Bio::Range->intersection(\@ranges);
309 Function: gives the range that is contained by all ranges
310 Returns : undef if they do not overlap or if @ranges has only a
311 single range, else returns the range that they do
312 overlap. In scalar contex, the return value is an object of
313 the same class as the calling one. In array context the
314 return value is a three element array.
315 Args : arg #1 = [REQUIRED] a Bio::RangeI to compare this one to,
316 or an array ref of ranges
317 arg #2 = optional strand-testing arg ('strong', 'weak', 'ignore')
318  
319 =cut
320  
321 4438 ▶sub intersection {
Subroutine intersection: called CC=22 SCAR=32.3
Pod documented
322 4438 my ($self, $given, $so) = @_;
323 4438 ▶ $self->throw("missing arg: you need to pass in another feature") unless $given;
Branch: 1 branch
BranchTrueFalseTotal
unless $given 1 4437 4438
324  
325 4437 my @ranges;
326 4437 ▶ if ($self eq "Bio::RangeI") {
Branch: 1 branch
BranchTrueFalseTotal
if ($self eq "Bio::RangeI") 0 4437 4437
327 0 $self = "Bio::Range";
328 0 $self->warn("calling static methods of an interface is deprecated; use $self instead");
329 }
330 4437 ▶ if (ref $self) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $self) 4436 1 4437
331 4436 push(@ranges, $self);
332 }
333 4437 ▶ ref($given) eq 'ARRAY' ? push(@ranges, @{$given}) : push(@ranges, $given);
Branch: 1 branch
BranchTrueFalseTotal
ref $given eq 'ARRAY' ? : 3 4434 4437
334 #$self->throw("Need at least 2 ranges") unless @ranges >= 2;
335 # Rather than the above, I think the following is more consistent
336 4437 ▶ return undef unless @ranges >= 2;
Branch: 1 branch
BranchTrueFalseTotal
unless @ranges >= 2 0 4437 4437
337  
338 4437 my $intersect;
339 4437 ▶ while (@ranges > 0) {
Branch: 1 branch
BranchTrueFalseTotal
if (@ranges > 0) 4440 4328 8768
340 4440 ▶ unless ($intersect) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($intersect) 4437 3 4440
341 4437 $intersect = shift(@ranges);
342 4437 ▶ $self->throw("Not an object: $intersect") unless ref($intersect);
Branch: 1 branch
BranchTrueFalseTotal
unless ref $intersect 0 4437 4437
343 4437 ▶ $self->throw("Not a Bio::RangeI object: $intersect") unless $intersect->isa('Bio::RangeI');
Branch: 1 branch
BranchTrueFalseTotal
unless $intersect->isa("Bio::RangeI") 0 4437 4437
344 4437 ▶ $self->throw("start is undefined") unless defined $intersect->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $intersect->start 0 4437 4437
345 4437 ▶ $self->throw("end is undefined") unless defined $intersect->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $intersect->end 0 4437 4437
346 }
347  
348 4440 my $compare = shift(@ranges);
349 4440 ▶ $self->throw("Not an object: $compare") unless ref($compare);
Branch: 1 branch
BranchTrueFalseTotal
unless ref $compare 0 4440 4440
350 4440 ▶ $self->throw("Not a Bio::RangeI object: $compare") unless $compare->isa('Bio::RangeI');
Branch: 1 branch
BranchTrueFalseTotal
unless $compare->isa("Bio::RangeI") 0 4440 4440
351 4440 ▶ $self->throw("start is undefined") unless defined $compare->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $compare->start 0 4440 4440
352 4440 ▶ $self->throw("end is undefined") unless defined $compare->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $compare->end 0 4440 4440
353 4440 ▶ return unless $compare->_testStrand($intersect, $so);
Branch: 1 branch
BranchTrueFalseTotal
unless $compare->_testStrand($intersect, $so) 0 4440 4440
354  
355 4440 my @starts = sort {$a <=> $b} ($intersect->start(), $compare->start());
356 4440 my @ends = sort {$a <=> $b} ($intersect->end(), $compare->end());
357  
358 4440 my $start = pop @starts; # larger of the 2 starts
359 4440 my $end = shift @ends; # smaller of the 2 ends
360  
361 4440 my $intersect_strand; # strand for the intersection
362 4440 ▶ if (defined($intersect->strand) && defined($compare->strand) && $intersect->strand == $compare->strand) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $intersect->strand and defined $compare->strand and $intersect->strand == $compare->strand) { } 4284 156 4440
Condition50%3/6
defined $intersect->strand and defined $compare->strand and $intersect->strand == $compare->strand
!ll&&!rl&&r
01564284
defined $intersect->strand and defined $compare->strand
!ll&&!rl&&r
004440
MC/DC33%1/3
defined $intersect->strand and defined $compare->strand and $intersect->strand == $compare->strand
defined $intersect->strand defined $compare->strand $intersect->strand == $compare->strand
Truth table50%2/4
A and B and C
A= defined $intersect->strandB= defined $compare->strandC= $intersect->strand == $compare->strand
ABCresult
0XX0
10X0
1100
1111
363 4284 $intersect_strand = $compare->strand;
364 }
365 else {
366 156 $intersect_strand = 0;
367 }
368  
369 4440 ▶ if ($start > $end) {
Branch: 1 branch
BranchTrueFalseTotal
if ($start > $end) { } 109 4331 4440
370 109 return;
371 }
372 else {
373 4331 $intersect = $self->new(-start => $start,
374 -end => $end,
375 -strand => $intersect_strand);
376 }
377 }
378  
379 4328 ▶ if (wantarray()) {
Branch: 1 branch
BranchTrueFalseTotal
if (wantarray) { } 4 4324 4328
380 4 return ($intersect->start, $intersect->end, $intersect->strand);
381 }
382 else {
383 4324 return $intersect;
384 }
385 }
386  
387 =head2 union
388  
389 Title : union
390 Usage : ($start, $end, $strand) = $r1->union($r2);
391 : ($start, $end, $strand) = Bio::Range->union(@ranges);
392 my $newrange = Bio::Range->union(@ranges);
393 Function: finds the minimal Range that contains all of the Ranges
394 Args : a Range or list of Range objects
395  
396 Returns : the range containing all of the range. In scalar contex,
397 the return value is an object of the same class as the
398 calling one. In array context the return value is a
399 three element array.
400  
401 =cut
402  
403 21025 ▶sub union {
Subroutine union: called CC=11 SCAR=24.4
Pod documented
404 21025 my $self = shift;
405 21025 my @ranges = @_;
406 21025 ▶ if ($self eq "Bio::RangeI") {
Branch: 1 branch
BranchTrueFalseTotal
if ($self eq "Bio::RangeI") 0 21025 21025
407 0 $self = "Bio::Range";
408 0 $self->warn("calling static methods of an interface is deprecated; use $self instead");
409 }
410 21025 ▶ if(ref $self) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $self) 21024 1 21025
411 21024 unshift @ranges, $self;
412 }
413  
414 21029 my @start = sort {$a<=>$b}
415 21025 map( { $_->start() } @ranges);
416 21029 my @end = sort {$a<=>$b}
417 21025 map( { $_->end() } @ranges);
418  
419 21025 my $start = shift @start;
420 21025 ▶ while( !defined $start ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $start) 0 21025 21025
421 0 $start = shift @start;
422 }
423  
424 21025 my $end = pop @end;
425  
426 21025 my $union_strand; # Strand for the union range object.
427  
428 21025 foreach(@ranges) {
429 42052 ▶ if(! defined $union_strand) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $union_strand) { } 21042 21010 42052
430 21042 $union_strand = $_->strand;
431 21042 next;
432 } else {
433 21010 ▶ if(not defined $_->strand or $union_strand ne $_->strand) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $_->strand or $union_strand ne $_->strand) 155 20855 21010
Condition100%3/3
not defined $_->strand or $union_strand ne $_->strand
l!l&&r!l&&!r
215320855
MC/DC100%2/2
not defined $_->strand or $union_strand ne $_->strand
not defined $_->strand $union_strand ne $_->strand
Truth table100%3/3
not(A) or B
A= not defined $_->strandB= $union_strand ne $_->strand
ABresult
1X1
011
000
434 155 $union_strand = 0;
435 155 last;
436 }
437 }
438 }
439 21025 ▶ return unless $start or $end;
Branch: 1 branch
BranchTrueFalseTotal
unless $start or $end 0 21025 21025
Condition33%1/3
$start or $end
l!l&&r!l&&!r
2102500
MC/DC0%0/2
$start or $end
$start $end
Truth table33%1/3
A or B
A= $startB= $end
ABresult
1X1
011
000
440 21025 ▶ if( wantarray() ) {
Branch: 1 branch
BranchTrueFalseTotal
if (wantarray) { } 16771 4254 21025
441 16771 return ( $start,$end,$union_strand);
442 } else {
443 4254 return $self->new('-start' => $start,
444 '-end' => $end,
445 '-strand' => $union_strand
446 );
447 }
448 }
449  
450 =head2 overlap_extent
451  
452 Title : overlap_extent
453 Usage : ($a_unique,$common,$b_unique) = $a->overlap_extent($b)
454 Function: Provides actual amount of overlap between two different
455 ranges
456 Example :
457 Returns : array of values containing the length unique to the calling
458 range, the length common to both, and the length unique to
459 the argument range
460 Args : a range
461  
462 =cut
463  
464 1 ▶sub overlap_extent{
Subroutine overlap_extent: called CC=10 SCAR=45.6
Pod documented
465 1 my ($a,$b) = @_;
466  
467 1 ▶ $a->throw("start is undefined") unless defined $a->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $a->start 0 0 0
468 0 ▶ $a->throw("end is undefined") unless defined $a->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $a->end 0 0 0
469 0 ▶ $b->throw("Not a Bio::RangeI object") unless $b->isa('Bio::RangeI');
Branch: 1 branch
BranchTrueFalseTotal
unless $b->isa("Bio::RangeI") 0 0 0
470 0 ▶ $b->throw("start is undefined") unless defined $b->start;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $b->start 0 0 0
471 0 ▶ $b->throw("end is undefined") unless defined $b->end;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $b->end 0 0 0
472  
473 0 ▶ if( ! $a->overlaps($b) ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($a->overlaps($b)) 0 0 0
474 0 return ($a->length,0,$b->length);
475 }
476  
477 0 my ($au,$bu) = (0, 0);
478 0 ▶ if( $a->start < $b->start ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($a->start < $b->start) { } 0 0 0
479 0 $au = $b->start - $a->start;
480 } else {
481 0 $bu = $a->start - $b->start;
482 }
483  
484 0 ▶ if( $a->end > $b->end ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($a->end > $b->end) { } 0 0 0
485 0 $au += $a->end - $b->end;
486 } else {
487 0 $bu += $b->end - $a->end;
488 }
489  
490 0 my $intersect = $a->intersection($b);
491 0 ▶ if( ! $intersect ) {
Branch: 1 branch
BranchTrueFalseTotal
if (not $intersect) { } 0 0 0
492 0 warn("no intersection\n");
493 0 return ($au, 0, $bu);
494 } else {
495 0 my $ie = $intersect->end;
496 0 my $is = $intersect->start;
497 0 return ($au,$ie-$is+1,$bu);
498 }
499 }
500  
501 =head2 disconnected_ranges
502  
503 Title : disconnected_ranges
504 Usage : my @disc_ranges = Bio::Range->disconnected_ranges(@ranges);
505 Function: finds the minimal set of ranges such that each input range
506 is fully contained by at least one output range, and none of
507 the output ranges overlap
508 Args : a list of ranges
509 Returns : a list of objects of the same type as the input
510 (conforms to RangeI)
511  
512 =cut
513  
514 2080 ▶sub disconnected_ranges {
Subroutine disconnected_ranges: called CC=8 SCAR=21.4
Pod documented
515 2080 my $self = shift;
516 2080 ▶ if ($self eq "Bio::RangeI") {
Branch: 1 branch
BranchTrueFalseTotal
if ($self eq "Bio::RangeI") 0 2080 2080
517 0 $self = "Bio::Range";
518 0 $self->warn("calling static methods of an interface is deprecated; use $self instead");
519 }
520 2080 my @inranges = @_;
521 2080 ▶ if(ref $self) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $self) 0 2080 2080
522 0 unshift @inranges, $self;
523 }
524  
525 2080 my @outranges = (); # disconnected ranges
526  
527 # iterate through all input ranges $inrange,
528 # adding each input range to the set of output ranges @outranges,
529 # provided $inrange does not overlap ANY range in @outranges
530 # - if it does overlap an outrange, then merge it
531 2080 foreach my $inrange (@inranges) {
532 6333 my $intersects = 0;
533 6333 my @outranges_new = ();
534 6333 my @intersecting_ranges = ();
535  
536 # iterate through all @outranges, testing if it intersects
537 # current $inrange; if it does, merge and add to list
538 # of @intersecting_ranges, otherwise add $outrange to
539 # the new list of outranges that do NOT intersect
540 6333 ▶ for (my $i=0; $i<@outranges; $i++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < @outranges) 4289 6333 10622
541 4289 my $outrange = $outranges[$i];
542 4289 my $intersection = $inrange->intersection($outrange);
543 4289 ▶ if ($intersection) {
Branch: 1 branch
BranchTrueFalseTotal
if ($intersection) { } 4250 39 4289
544 4250 $intersects = 1;
545 4250 my $union = $inrange->union($outrange);
546 4250 push(@intersecting_ranges, $union);
547 }
548 else {
549 39 push(@outranges_new, $outrange);
550 }
551 }
552 6333 @outranges = @outranges_new;
553 # @outranges now contains a list of non-overlapping ranges
554 # that do not intersect the current $inrange
555  
556 6333 ▶ if (@intersecting_ranges) {
Branch: 1 branch
BranchTrueFalseTotal
if (@intersecting_ranges) { } 4250 2083 6333
557 4250 ▶ if (@intersecting_ranges > 1) {
Branch: 1 branch
BranchTrueFalseTotal
if (@intersecting_ranges > 1) { } 0 4250 4250
558 # this sf intersected > 1 range, which means that
559 # all the ranges it intersects should be joined
560 # together in a new range
561 0 my $merged_range =
562 $self->union(@intersecting_ranges);
563 0 push(@outranges, $merged_range);
564  
565 }
566 else {
567 # exactly 1 intersecting range
568 4250 push(@outranges, @intersecting_ranges);
569 }
570 }
571 else {
572 # no intersections found - new range
573 2083 push(@outranges,
574 $self->new('-start'=>$inrange->start,
575 '-end'=>$inrange->end,
576 '-strand'=>$inrange->strand,
577 ));
578 }
579 }
580 2080 return @outranges;
581 }
582  
583 =head2 offsetStranded
584  
585 Title : offsetStranded
586 Usage : $rnge->ofsetStranded($fiveprime_offset, $threeprime_offset)
587 Function : destructively modifies RangeI implementing object to
588 offset its start and stop coordinates by values $fiveprime_offset and
589 $threeprime_offset (positive values being in the strand direction).
590 Args : two integer offsets: $fiveprime_offset and $threeprime_offset
591 Returns : $self, offset accordingly.
592  
593 =cut
594  
595 5 ▶sub offsetStranded {
Subroutine offsetStranded: called CC=2 SCAR=6.9
Pod documented
596 5 my ($self, $offset_fiveprime, $offset_threeprime) = @_;
597 5 ▶ my ($offset_start, $offset_end) = $self->strand() eq -1 ? (- $offset_threeprime, - $offset_fiveprime) : ($offset_fiveprime, $offset_threeprime);
Branch: 1 branch
BranchTrueFalseTotal
$self->strand eq -1 ? : 2 2 4
598 4 $self->start($self->start + $offset_start);
599 4 $self->end($self->end + $offset_end);
600 4 return $self;
601 };
602  
603 =head2 subtract
604  
605 Title : subtract
606 Usage : my @subtracted = $r1->subtract($r2)
607 Function: Subtract range r2 from range r1
608 Args : arg #1 = a range to subtract from this one (mandatory)
609 arg #2 = strand option ('strong', 'weak', 'ignore') (optional)
610 Returns : undef if they do not overlap or r2 contains this RangeI,
611 or an arrayref of Range objects (this is an array since some
612 instances where the subtract range is enclosed within this range
613 will result in the creation of two new disjoint ranges)
614  
615 =cut
616  
617 7 ▶sub subtract() {
Subroutine subtract: called CC=12 SCAR=24.9
Pod documented
618 7 my ($self, $range, $so) = @_;
619 7 ▶ $self->throw("missing arg: you need to pass in another feature")
Branch: 1 branch
BranchTrueFalseTotal
unless $range 1 6 7
620 unless $range;
621 6 ▶ return unless $self->_testStrand($range, $so);
Branch: 1 branch
BranchTrueFalseTotal
unless $self->_testStrand($range, $so) 2 4 6
622  
623 4 ▶ if ($self eq "Bio::RangeI") {
Branch: 1 branch
BranchTrueFalseTotal
if ($self eq "Bio::RangeI") 0 4 4
624 0 $self = "Bio::Range";
625 0 $self->warn("calling static methods of an interface is
626 deprecated; use $self instead");
627 }
628 4 ▶ $range->throw("Input a Bio::RangeI object") unless
Branch: 1 branch
BranchTrueFalseTotal
unless $range->isa("Bio::RangeI") 0 4 4
629 $range->isa('Bio::RangeI');
630  
631 4 my @sub_locations;
632 4 ▶ if ($self->location->isa('Bio::Location::SplitLocationI') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->location->isa('Bio::Location::SplitLocationI')) { } 1 3 4
633 1 @sub_locations = $self->location->sub_Location;
634 } else {
635 3 @sub_locations = $self;
636 }
637  
638 4 my @outranges;
639 4 foreach my $sl (@sub_locations) {
640 6 ▶ if (!$sl->overlaps($range)) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($sl->overlaps($range)) 1 5 6
641 1 push(@outranges,
642 $self->new('-start' =>$sl->start,
643 '-end' =>$sl->end,
644 '-strand'=>$sl->strand,
645 ));
646 1 next;
647 }
648
649 ##Subtracts everything
650 5 ▶ if ($range->contains($sl)) {
Branch: 1 branch
BranchTrueFalseTotal
if ($range->contains($sl)) 1 4 5
651 1 next;
652 }
653
654 4 my ($start, $end, $strand) = $sl->intersection($range, $so);
655 ##Subtract intersection from $self range
656
657 4 ▶ if ($sl->start < $start) {
Branch: 1 branch
BranchTrueFalseTotal
if ($sl->start < $start) 3 1 4
658 3 push(@outranges,
659 $self->new('-start' =>$sl->start,
660 '-end' =>$start - 1,
661 '-strand'=>$sl->strand,
662 ));
663 }
664 4 ▶ if ($sl->end > $end) {
Branch: 1 branch
BranchTrueFalseTotal
if ($sl->end > $end) 2 2 4
665 2 push(@outranges,
666 $self->new('-start' =>$end + 1,
667 '-end' =>$sl->end,
668 '-strand'=>$sl->strand,
669 ));
670 }
671 }
672  
673 4 ▶ if (@outranges) {
Branch: 1 branch
BranchTrueFalseTotal
if (@outranges) 3 1 4
674 3 return \@outranges;
675 }
676 1 return;
677 }
678  
679 376 1;
« Bio/SeqIO/swissdriver.pm ↑ Summary Bio/AlignIO/po.pm »