annotate scripts/general/accumarray.m @ 6971:0a9d97cf2e13

[project @ 2007-10-07 19:44:53 by dbateman]
author dbateman
date Sun, 07 Oct 2007 19:44:53 +0000
parents babcbcc11ab6
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6770
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
1 ## Copyright (C) 2007 David Bateman
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
2 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
6 ## (at your option) any later version.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
7 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
11 ## GNU General Public License for more details.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
12 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
15 ## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
16 ## 02110-1301 USA
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
17
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
18 ## -*- texinfo -*-
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
19 ## @deftypefn {Function File} {} accumarray (@var{subs}, @var{vals}, @var{sz}, @var{fun}, @var{fillval}, @var{issparse})
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefnx {Function File} {} accumarray (@var{csubs}, @var{vals}, @dots{})
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
21 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
22 ## Creates an array by accumulating the elements of a vector into the
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
23 ## positions of defined by their subscripts. The subscripts are defined by
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
24 ## the rows of the matrix @var{subs} and the values by @var{vals}. Each row
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
25 ## of @var{subs} corresponds to one of the values in @var{vals}.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
26 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
27 ## The size of the matrix will be determined by the subscripts themselves.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
28 ## However, if @var{sz} is defined it determines the matrix size. The length
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
29 ## of @var{sz} must correspond to the number of columns in @var{subs}.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
30 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
31 ## The default action of @code{accumarray} is to sum the elements with the
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
32 ## same subscripts. This behavior can be modified by defining the @var{fun}
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
33 ## function. This should be a function or function handle that accepts a
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
34 ## column vector and returns a scalar. The result of the function should not
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
35 ## depend on the order of the subscripts.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
36 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
37 ## The elements of the returned array that have no subscripts assoicated with
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
38 ## them are set to zero. Defining @var{fillval} to some other value allows
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
39 ## these values to be defined.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
40 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
41 ## By default @code{accumarray} returns a full matrix. If @var{issparse} is
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
42 ## logically true, then a sparse matrix is returned instead.
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
43 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
44 ## An example of the use of @code{accumarray} is:
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
45 ##
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
46 ## @example
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
47 ## @group
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
48 ## accumarray ([1,1,1;2,1,2;2,3,2;2,1,2;2,3,2],101:105)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
49 ## @result{} ans(:,:,1) = [101, 0, 0; 0, 0, 0]
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
50 ## ans(:,:,2) = [0, 0, 0; 206, 0, 208]
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
51 ## @end group
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
52 ## @end example
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
53 ## @end deftypefn
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
54
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
55 function A = accumarray (subs, val, sz, fun, fillval, isspar)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
56
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
57 if (nargin < 2 || nargin > 6)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
58 print_usage ();
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
59 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
60
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
61 if (iscell(subs))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
62 subs = cell2mat (cellfun (@(x) x(:), subs, 'UniformOutput', false));
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
63 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
64 ndims = size (subs, 2);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
65
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
66 if (nargin < 3 || isempty (sz))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
67 sz = max (subs);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
68 if (isscalar(sz))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
69 sz = [sz, 1];
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
70 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
71 else
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
72 if (length (sz) != ndims)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
73 error ("accumarray: inconsistent dimensions");
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
74 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
75 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
76
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
77 if (nargin < 4 || isempty (fun))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
78 fun = @sum;
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
79 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
80
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
81 if (nargin < 5 || isempty (fillval))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
82 fillval = 0;
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
83 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
84
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
85 if (nargin < 6 || isempty (isspar))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
86 isspar = false;
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
87 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
88 if (isspar)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
89 if (ndims > 2)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
90 error ("Can not have more than 2 dimensions in a sparse matrix");
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
91 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
92 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
93
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
94 [subs, idx] = sortrows (subs);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
95 if (isscalar (val))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
96 val = val * ones (size (idx));
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
97 else
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
98 val = val(idx);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
99 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
100 cidx = find([true; (sum (abs (diff (subs)), 2) != 0)]);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
101 idx = cell (1, ndims);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
102 for i = 1:ndims
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
103 idx{i} = subs (cidx, i);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
104 endfor
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
105 x = cellfun (fun, mat2cell (val(:), diff ([cidx; length(val) + 1])));
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
106 if (isspar && fillval == 0)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
107 A = sparse (idx{1}, idx{2}, x, sz(1), sz(2));
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
108 else
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
109 if (iscell (x))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
110 ## Why did matlab choose to reverse the order of the elements
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
111 x = cellfun (@(x) flipud(x(:)), x, 'UniformOutput', false);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
112 A = cell (sz);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
113 elseif (fillval == 0)
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
114 A = zeros (sz, class(x));
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
115 else
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
116 A = fillval .* ones (sz);
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
117 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
118 A (sub2ind (sz, idx{:})) = x;
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
119 endif
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
120 endfunction
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
121
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
122 %!error (accumarray (1:5))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
123 %!error (accumarray ([1,2,3],1:2))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
124 %!assert (accumarray ([1;2;4;2;4],101:105), [101;206;0;208])
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
125 %!assert (accumarray ([1,1,1;2,1,2;2,3,2;2,1,2;2,3,2],101:105),cat(3, [101,0,0;0,0,0],[0,0,0;206,0,208]))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
126 %!assert (accumarray ([1,1,1;2,1,2;2,3,2;2,1,2;2,3,2],101:105,[],@(x)sin(sum(x))),sin(cat(3, [101,0,0;0,0,0],[0,0,0;206,0,208])))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
127 %!assert (accumarray ({[1 3 3 2 3 1 2 2 3 3 1 2],[3 4 2 1 4 3 4 2 2 4 3 4],[1 1 2 2 1 1 2 1 1 1 2 2]},101:112),cat(3,[0,0,207,0;0,108,0,0;0,109,0,317],[0,0,111,0;104,0,0,219;0,103,0,0]))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
128 %!assert (accumarray ([1,1;2,1;2,3;2,1;2,3],101:105,[2,4],@max,NaN),[101,NaN,NaN,NaN;104,NaN,105,NaN])
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
129 %!assert (accumarray ([1 1; 2 1; 2 3; 2 1; 2 3],101:105,[2 4],@prod,0,true),sparse([1,2,2],[1,1,3],[101,10608,10815],2,4))
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
130 %!assert (accumarray ([1 1; 2 1; 2 3; 2 1; 2 3],1,[2,4]), [1,0,0,0;2,0,2,0])
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
131 %!assert (accumarray ([1 1; 2 1; 2 3; 2 1; 2 3],101:105,[2,4],@(x)length(x)>1),[false,false,false,false;true,false,true,false])
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
132 %!test
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
133 %! A = accumarray ([1 1; 2 1; 2 3; 2 1; 2 3],101:105,[2,4],@(x){x});
babcbcc11ab6 [project @ 2007-07-06 08:44:04 by dbateman]
dbateman
parents:
diff changeset
134 %! assert (A{2},[104;102])