annotate scripts/general/arrayfun.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 81a73cdd87c0
children a1dbe9d80eee
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 ##
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
3 ## This file is part of Octave.
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
4 ##
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
8 ## your option) any later version.
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
9 ##
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
13 ## General Public License for more details.
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
14 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6714
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
18
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
6714
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6439
diff changeset
20 ## @deftypefn {Function File} {@var{a} =} arrayfun (@var{name}, @var{c})
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6439
diff changeset
21 ## @deftypefnx {Function File} {@var{a} =} arrayfun (@var{func}, @var{c})
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6439
diff changeset
22 ## @deftypefnx {Function File} {@var{a} =} arrayfun (@var{func}, @var{c}, @var{d})
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6439
diff changeset
23 ## @deftypefnx {Function File} {@var{a} =} arrayfun (@var{func}, @var{c}, @var{options})
81a73cdd87c0 [project @ 2007-06-13 10:49:28 by dbateman]
dbateman
parents: 6439
diff changeset
24 ## @deftypefnx {Function File} {[@var{a}, @var{b}, @dots{}] =} arrayfun (@var{func}, @var{c}, @dots{})
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
25 ## Execute a function on each element of an array. This is useful for
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
26 ## functions that do not accept array arguments. If the function does
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
27 ## 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
28 ##
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
29 ## See @code{cellfun} for complete usage instructions.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
30 ## @seealso{cellfun}
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
31 ## @end deftypefn
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
32
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
33 function varargout = arrayfun (func, varargin)
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
34
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
35 if (nargin < 2)
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
36 print_usage ();
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
37 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
38
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
39 ## Convert everything to cells and call cellfun (let cellfun error
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
40 ## check the options in case more options come available).
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
41 sizetomatch = size (varargin{1});
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
42 m2cargs{1} = ones (size (varargin{1}, 1), 1);
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
43 m2cargs{2} = ones (size (varargin{1}, 2), 1);
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
44 cfarg{1} = mat2cell (varargin{1}, m2cargs{:});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
45 stillmatches = true;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
46 idx = 1;
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
47 while (stillmatches && idx < numel (varargin))
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
48 idx++;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
49 thissize = size (varargin{idx});
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
50 if (numel (thissize) == numel (sizetomatch)
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
51 && all (thissize == sizetomatch))
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
52 if (ischar (varargin{idx})
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
53 && (strcmpi (varargin{idx}, "UniformOutput")
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
54 || strcmpi (varargin{idx}, "ErrorHandler")))
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
55 ## Catch these strings just in case they happen to be the same
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
56 ## size as the other input.
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
57 stillmatches = false;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
58 else
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
59 cfarg{idx} = mat2cell (varargin{idx}, m2cargs{:});
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
60 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
61 else
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
62 stillmatches = false;
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
63 endif
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
64 endwhile
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
65
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
66 varargout = cell (max ([nargout, 1]), 1);
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
67 [varargout{:}] = cellfun (func, cfarg{:}, varargin{idx+1:numel(varargin)});
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
68 endfunction
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
69
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
70 %!test
6439
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe]
jwe
parents: 6422
diff changeset
71 %! fun = @(x,y) 2*x+y;
6422
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
72 %! A = [1,2;3,4];
9b982dd07654 [project @ 2007-03-20 21:26:12 by dbateman]
dbateman
parents:
diff changeset
73 %! assert(arrayfun(fun,A,A),fun(A,A))