annotate scripts/general/arrayfun.m @ 6422:9b982dd07654

[project @ 2007-03-20 21:26:12 by dbateman]
author dbateman
date Tue, 20 Mar 2007 21:26:13 +0000
parents
children a37c427ae9d1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
1 ## Copyright (C) 2006 Bill Denney <denney@seas.upenn.edu>
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
2 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
6 ## (at your option) any later version.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
7 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
11 ## GNU General Public License for more details.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
12 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
16
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
17 ## -*- texinfo -*-
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
18 ## @deftypefn {Command} @var{a} = arrayfun(@var{name}, @var{c})
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
19 ## @deftypefnx {Command} @var{a} = arrayfun(@var{func}, @var{c})
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefnx {Command} @var{a} = arrayfun(@var{func}, @var{c}, @var{d})
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Command} @var{a} = arrayfun(@var{func}, @var{c}, @var{options})
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
22 ## @deftypefnx {Command} [@var{a}, @var{b}, @dots{}] = arrayfun(@var{func}, @var{c}, @dots{})
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
23 ## Execute a function on each element of an array. This is useful for
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
24 ## functions that do not accept array arguments. If the function does
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
25 ## accept array arguments it is better to call the function directly.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
26 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
27 ## See @code{cellfun} for complete usage instructions.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
28 ## @seealso{cellfun}
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
29 ## @end deftypefn
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
30
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
31 function [varargout] = arrayfun(func, varargin)
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
32
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
33 if (nargin < 2)
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
34 print_usage();
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
35 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
36
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
37 ## convert everything to cells and call cellfun (let cellfun error
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
38 ## check the options in case more options come available)
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
39 sizetomatch = size(varargin{1});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
40 m2cargs{1} = ones (size (varargin{1}, 1), 1);
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
41 m2cargs{2} = ones (size (varargin{1}, 2), 1);
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
42 cfarg{1} = mat2cell (varargin{1}, m2cargs{:});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
43 stillmatches = true;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
44 idx = 1;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
45 while stillmatches && (idx < length(varargin))
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
46 idx++;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
47 thissize = size (varargin{idx});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
48 if (length (thissize) == length (sizetomatch)) && \
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
49 all (thissize == sizetomatch)
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
50 if ischar (varargin{idx}) && \
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
51 (strcmpi (varargin{idx}, "UniformOutput") || \
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
52 strcmpi (varargin{idx}, "ErrorHandler"))
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
53 ## catch these strings just in case they happen to be the same
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
54 ## size as the other input.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
55 stillmatches = false;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
56 else
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
57 cfarg{idx} = mat2cell (varargin{idx}, m2cargs{:});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
58 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
59 else
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
60 stillmatches = false;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
61 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
62 endwhile
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
63
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
64 varargout = cell (max ([nargout, 1]), 1);
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
65 [varargout{:}] = cellfun (func, cfarg{:}, varargin{idx+1:length(varargin)});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
66 endfunction
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
67
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
68 %!test
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
69 %! fun = @(x,y) 2*x+y
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
70 %! A = [1,2;3,4];
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
71 %! assert(arrayfun(fun,A,A),fun(A,A))