Mercurial > hg > octave-nkf
annotate scripts/general/structfun.m @ 11471:994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 09 Jan 2011 16:01:05 -0800 |
parents | c776f063fefe |
children | fd0a3ac60b0e |
rev | line source |
---|---|
8920 | 1 ## Copyright (C) 2007, 2008, 2009 David Bateman |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
2 ## Copyright (C) 2010 VZLU Prague |
6863 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
6863 | 10 ## |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
6863 | 19 |
20 ## -*- texinfo -*- | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11190
diff
changeset
|
21 ## @deftypefn {Function File} {} structfun (@var{func}, @var{S}) |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
22 ## @deftypefnx {Function File} {[@var{A}, @dots{}] =} structfun (@dots{}) |
8507 | 23 ## @deftypefnx {Function File} {} structfun (@dots{}, "ErrorHandler", @var{errfunc}) |
24 ## @deftypefnx {Function File} {} structfun (@dots{}, "UniformOutput", @var{val}) | |
6863 | 25 ## |
26 ## Evaluate the function named @var{name} on the fields of the structure | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11190
diff
changeset
|
27 ## @var{S}. The fields of @var{S} are passed to the function @var{func} |
6863 | 28 ## individually. |
29 ## | |
30 ## @code{structfun} accepts an arbitrary function @var{func} in the form of | |
31 ## an inline function, function handle, or the name of a function (in a | |
9036
58604c45ca74
Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
32 ## character string). In the case of a character string argument, the |
6863 | 33 ## function must accept a single argument named @var{x}, and it must return |
9036
58604c45ca74
Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
34 ## a string value. If the function returns more than one argument, they are |
6863 | 35 ## returned as separate output variables. |
36 ## | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
37 ## If the parameter "UniformOutput" is set to true (the default), then the |
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
38 ## function |
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
7208
diff
changeset
|
39 ## must return a single element which will be concatenated into the |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
40 ## return value. If "UniformOutput" is false, the outputs are placed into a |
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
41 ## structure |
6863 | 42 ## with the same fieldnames as the input structure. |
43 ## | |
44 ## @example | |
45 ## @group | |
46 ## s.name1 = "John Smith"; | |
47 ## s.name2 = "Jill Jones"; | |
8507 | 48 ## structfun (@@(x) regexp (x, '(\w+)$', "matches")@{1@}, s, |
49 ## "UniformOutput", false) | |
10122
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
50 ## @result{} |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
51 ## @{ |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
52 ## name1 = Smith |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
53 ## name2 = Jones |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
54 ## @} |
6863 | 55 ## @end group |
56 ## @end example | |
57 ## | |
10122
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
58 ## Given the parameter "ErrorHandler", @var{errfunc} defines a function to |
9036
58604c45ca74
Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
59 ## call in case @var{func} generates an error. The form of the function is |
6863 | 60 ## |
61 ## @example | |
62 ## function [@dots{}] = errfunc (@var{se}, @dots{}) | |
63 ## @end example | |
64 ## | |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
65 ## @noindent |
6863 | 66 ## where there is an additional input argument to @var{errfunc} relative to |
9036
58604c45ca74
Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
67 ## @var{func}, given by @var{se}. This is a structure with the elements |
8507 | 68 ## "identifier", "message" and "index", giving respectively the error |
6863 | 69 ## identifier, the error message, and the index into the input arguments |
10122
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
70 ## of the element that caused the error. For an example on how to use |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
71 ## an error handler, @pxref{doc-cellfun, @code{cellfun}}. |
9d1a14e12431
Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
9036
diff
changeset
|
72 ## |
10687
a8ce6bdecce5
Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
73 ## @seealso{cellfun, arrayfun, spfun} |
6863 | 74 ## @end deftypefn |
75 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11190
diff
changeset
|
76 function varargout = structfun (func, S, varargin); |
10134
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
77 |
6863 | 78 if (nargin < 2) |
79 print_usage (); | |
80 endif | |
81 | |
10134
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
82 nargs = length (varargin); |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
83 |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
84 recognized_opts = {"UniformOutput", "ErrorHandler"}; |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
85 uo_str = recognized_opts{1}; |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
86 |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
87 uniform_output = true; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
88 |
10134
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
89 while (nargs >= 2) |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
90 opt_match = strcmpi (varargin{nargs-1}, recognized_opts); |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
91 if (opt_match(1)) |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
92 uniform_output = varargin{nargs}; |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
93 endif |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
94 if (any (opt_match)) |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
95 nargs -= 2; |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
96 else |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
97 break; |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
98 endif |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
99 endwhile |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
100 |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
101 if (nargs > 0) |
be13fa20656a
error on invalid opts in structfun
Jaroslav Hajek <highegg@gmail.com>
parents:
10132
diff
changeset
|
102 error ("structfun: invalid options"); |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
103 endif |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
104 |
6863 | 105 varargout = cell (max ([nargout, 1]), 1); |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11190
diff
changeset
|
106 [varargout{:}] = cellfun (func, struct2cell (S), varargin{:}); |
6863 | 107 |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
108 if (! uniform_output) |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11190
diff
changeset
|
109 varargout = cellfun (@cell2struct, varargout, {fieldnames(S)}, {1}, uo_str, false); |
6863 | 110 endif |
111 endfunction | |
112 | |
113 | |
114 %!test | |
115 %! s.name1 = "John Smith"; | |
116 %! s.name2 = "Jill Jones"; | |
117 %! l.name1 = "Smith"; | |
118 %! l.name2 = "Jones"; | |
8507 | 119 %! o = structfun (@(x) regexp (x, '(\w+)$', "matches"){1}, s, |
10549 | 120 %! "UniformOutput", false); |
6863 | 121 %! assert (o, l); |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
122 |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
123 %!function [a, b] = twoouts (x) |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
124 %! a = x + x; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
125 %! b = x * x; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
126 |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
127 %!test |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
128 %! s = struct ("a", {1, 2, 3}, "b", {4, 5, 6}); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
129 %! c(1:2, 1, 1) = [2; 8]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
130 %! c(1:2, 1, 2) = [4; 10]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
131 %! c(1:2, 1, 3) = [6; 12]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
132 %! d(1:2, 1, 1) = [1; 16]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
133 %! d(1:2, 1, 2) = [4; 25]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
134 %! d(1:2, 1, 3) = [9; 36]; |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
135 %! [aa, bb] = structfun(@twoouts, s); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
136 %! assert(aa, c); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
137 %! assert(bb, d); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
138 |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
139 %!test |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
140 %! s = struct ("a", {1, 2, 3}, "b", {4, 5, 6}); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
141 %! c = struct ("a", {2, 4, 6}, "b", {8, 10, 12}); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
142 %! d = struct ("a", {1, 4, 9}, "b", {16, 25, 36}); |
11190
b1f4bdc276b6
Use CamelCase for 'UniformOutput' option to cellfun.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
143 %! [aa, bb] = structfun(@twoouts, s, "UniformOutput", false); |
10132
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
144 %! assert(aa, c); |
aa0f575cf39b
improve structfun's Matlab compatibility
Jaroslav Hajek <highegg@gmail.com>
parents:
10122
diff
changeset
|
145 %! assert(bb, d); |