blib/lib/PDL/Reduce.pm

filter: Statementstmt 97.6% 42 / 43 Branchbran 77.2% 17 / 22 Conditioncond 50.0% 6 / 12 MC/DCmcdc 12.5% 1 / 8 Subroutinesub 83.3% 5 / 6 Podpod 0.0% 0 / 2 totaltotal 76.3% 71 / 93 CC 17 SCAR 27.1
CC
17
Cov
84%
reduce
19.1
canreduce
2.0
BEGIN
1.0
CRAP 15.0
« lib/PDL/ImageND.pd ↑ Summary blib/lib/PDL/AutoLoader.pm »
1 =head1 NAME
2  
3 PDL::Reduce -- a C<reduce> function for PDL
4  
5 =head1 DESCRIPTION
6  
7 Many languages have a C<reduce> function used to reduce
8 the rank of an N-D array by one. It works by applying a selected
9 operation along a specified dimension. This module implements
10 such a function for PDL by providing a simplified interface
11 to the existing projection functions (e.g. C<sumover>,
12 C<maximum>, C<average>, etc).
13  
14 =head1 SYNOPSIS
15  
16 use PDL::Reduce;
17 $x = sequence 5,5;
18 # reduce by adding all
19 # elements along 2nd dimension
20 $y = $x->reduce('add',1);
21 @ops = $x->canreduce; # return a list of all allowed operations
22  
23 =head1 FUNCTIONS
24  
25 =cut
26  
27 # in a very similar vein we want the following methods
28 # (1) accumulate
29 # (2) outer
30 # what's reduceat ??
31  
32 # TODO
33 # - aliases (e.g. plus -> add)
34 # - other binary ops?
35 # - allow general subs?
36  
37 package PDL::Reduce;
38 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
39 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
40 1 ▶use PDL::Core ''; # barf
Subroutine BEGIN: called CC=1 SCAR=0.0
41 1 ▶use PDL::Exporter;
Subroutine BEGIN: called CC=1 SCAR=0.0
42  
43 1 our @ISA = qw/PDL::Exporter/;
44 1 our @EXPORT_OK = qw/reduce canreduce/;
45 1 our %EXPORT_TAGS = (Func=>[@PDL::Reduce::EXPORT_OK]);
46  
47 # maps operations onto underlying PDL primitives
48 1 my %reduce = (
49 add => 'sumover',
50 '+' => 'sumover',
51 plus => 'sumover',
52 mult => 'prodover',
53 '*' => 'prodover',
54 dadd => 'dsumover',
55 dmult => 'dprodover',
56 avg => 'average',
57 davg => 'daverage',
58 and => 'andover',
59 band => 'bandover',
60 bor => 'borover',
61 or => 'orover',
62 median => 'medover',
63 integral => 'intover',
64 max => 'maximum',
65 min => 'minimum',
66 oddmedian => 'oddmedover',
67 iszero => 'zcover',
68 );
69  
70 =head2 reduce
71  
72 =for ref
73  
74 reduce dimension of ndarray by one by applying an operation
75 along the specified dimension
76  
77 =for example
78  
79 $x = sequence 5,5;
80 # reduce by adding all
81 # elements along 2nd dimension
82 $y = $x->reduce('add',1);
83 $y = $x->reduce('plus',1);
84 $y = $x->reduce('+',1); # three ways to do the same thing
85  
86 [ As an aside: if you are familiar with broadcasting you will see that
87 this is actually the same as
88  
89 $y = $x->mv(1,0)->sumover
90  
91 ]
92  
93 NOTE: You should quote the name of the operation (1st arg) that
94 you want C<reduce> to perform. This is important since some of the
95 names are identical to the names of the actual PDL functions
96 which might be imported into your namespace. And you definitely
97 want a string as argument, not a function invocation! For example,
98 this will probably fail:
99  
100 $y = $x->reduce(avg,1); # gives an error from invocation of 'avg'
101  
102 Rather use
103  
104 $y = $x->reduce('avg',1);
105  
106 C<reduce> provides a simple and unified interface to the
107 I<projection> functions and makes people coming from other
108 data/array languages hopefully feel more at home.
109  
110 =for usage
111  
112 $result = $pdl->reduce($operation [,@dims]);
113  
114 C<reduce> applies the named operation along the specified
115 dimension(s) reducing the input ndarray dimension by as many
116 dimensions as supplied as arguments. If the
117 dimension(s) argument is omitted the operation is applied along the first
118 dimension. To get a list of valid operations see L</canreduce>.
119  
120 NOTE - new power user feature: you can now supply a code
121 reference as operation to reduce with.
122  
123 =for example
124  
125 # reduce by summing over dims 0 and 2
126 $result = $pdl->reduce(\&sumover, 0, 2);
127  
128 It is your responsibility to ensure that this is indeed a
129 PDL projection operation that turns vectors into scalars!
130 You have been warned.
131  
132 =cut
133  
134 1 *reduce = \&PDL::reduce;
135 5 ▶sub PDL::reduce ($$;$) {
Subroutine reduce: called CC=17 SCAR=29.5
Pod undocumented
136 5 my ($pdl, $op, @dims) = @_;
137 barf "trying to reduce using unknown operation"
138 5 ▶ unless exists $reduce{$op} || ref $op eq 'CODE';
Branch: 1 branch
BranchTrueFalseTotal
unless exists $reduce{$op} or ref $op eq "CODE" 0 5 5
Condition66%2/3
exists $reduce{$op} or ref $op eq "CODE"
l!l&&r!l&&!r
410
MC/DC0%0/2
exists $reduce{$op} or ref $op eq "CODE"
exists $reduce{$op} ref $op eq "CODE"
Truth table66%2/3
A or B
A= exists $reduce{$op}B= ref $op eq "CODE"
ABresult
1X1
011
000
139 5 my $dim;
140 5 ▶ if (@dims > 1) {
Branch: 1 branch
BranchTrueFalseTotal
if (@dims > 1) { } 1 4 5
141 1 my $n = $pdl->getndims;
142 1 ▶ @dims = map { $_ < 0 ? $_ + $n : $_ } @dims;
Branch: 1 branch
BranchTrueFalseTotal
$_ < 0 ? : 0 2 2
143 1 my $min = $n;
144 1 my $max = 0;
145 1 ▶ for (@dims) { $min = $_ if $_ < $min; $max = $_ if $_ > $max }
Branch: 2 branches
BranchTrueFalseTotal
if $_ < $min 1 1 2
if $_ > $max 1 1 2
146 1 ▶ barf "dimension out of bounds (one of @dims >= $n)"
Branch: 1 branch
BranchTrueFalseTotal
if $min >= $n or $max >= $n 0 1 1
Condition33%1/3
$min >= $n or $max >= $n
l!l&&r!l&&!r
001
MC/DC0%0/2
$min >= $n or $max >= $n
$min >= $n $max >= $n
Truth table33%1/3
A or B
A= $min >= $nB= $max >= $n
ABresult
1X1
011
000
147 if $min >= $n || $max >= $n;
148 1 $dim = $min; # this will be the resulting dim of the clumped ndarray
149 1 $pdl = $pdl->clump(@dims);
150 } else {
151 4 ▶ $dim = @dims > 0 ? $dims[0] : 0;
Branch: 1 branch
BranchTrueFalseTotal
@dims > 0 ? : 3 1 4
152 }
153 5 ▶ if (defined $dim && $dim != 0) { # move the target dim to the front
Branch: 1 branch
BranchTrueFalseTotal
if (defined $dim and $dim != 0) 2 3 5
Condition66%2/3
defined $dim and $dim != 0
!ll&&!rl&&r
032
MC/DC50%1/2
defined $dim and $dim != 0
defined $dim $dim != 0
Truth table66%2/3
A and B
A= defined $dimB= $dim != 0
ABresult
0X0
100
111
154 2 my $n = $pdl->getndims;
155 2 ▶ $dim += $n if $dim < 0;
Branch: 1 branch
BranchTrueFalseTotal
if $dim < 0 0 2 2
156 2 ▶ barf "dimension out of bounds" if $dim <0 || $dim >= $n;
Branch: 1 branch
BranchTrueFalseTotal
if $dim < 0 or $dim >= $n 0 2 2
Condition33%1/3
$dim < 0 or $dim >= $n
l!l&&r!l&&!r
002
MC/DC0%0/2
$dim < 0 or $dim >= $n
$dim < 0 $dim >= $n
Truth table33%1/3
A or B
A= $dim < 0B= $dim >= $n
ABresult
1X1
011
000
157 2 $pdl = $pdl->mv($dim,0);
158 }
159 5 ▶ my $method = ref $op eq 'CODE' ? $op : $reduce{$op};
Branch: 1 branch
BranchTrueFalseTotal
ref $op eq 'CODE' ? : 1 4 5
160 5 return $pdl->$method();
161 }
162  
163 =head2 canreduce
164  
165 =for ref
166  
167 return list of valid named C<reduce> operations
168 Some common operations can be accessed using a
169 number of names, e.g. C<'+'>, C<add> and C<plus>
170 all sum the elements along the chosen dimension.
171  
172 =for example
173  
174 @ops = PDL->canreduce;
175  
176 This list is useful if you want to make sure which
177 operations can be used with C<reduce>.
178  
179 =cut
180  
181 1 *canreduce = \&PDL::canreduce;
182 0 ▶sub PDL::canreduce {
Subroutine canreduce: not called CC=1 SCAR=6.9
Pod undocumented
183 0 sort keys %reduce;
184 }
185  
186 =head1 AUTHOR
187  
188 Copyright (C) 2000 Christian Soeller (c.soeller@auckland.ac.nz). All
189 rights reserved. There is no warranty. You are allowed to redistribute
190 this software / documentation under certain conditions. For details,
191 see the file COPYING in the PDL distribution. If this file is
192 separated from the PDL distribution, the copyright notice should be
193 included in the file.
194  
195 =cut
196  
197 1 1;
« lib/PDL/ImageND.pd ↑ Summary blib/lib/PDL/AutoLoader.pm »