octave-lyh: scripts/general/structfun.m annotate

annotate scripts/general/structfun.m @ 17289:bc924baa2c4e

doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.

author	Rik <rik@octave.org>
date	Mon, 19 Aug 2013 20:46:38 -0700
parents	e7a059a9a644
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13305 diff changeset	1 ## Copyright (C) 2007-2012 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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	3 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	4 ## This file is part of Octave.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	5 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	7 ## 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: 7001 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	9 ## your option) any later version.
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	10 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	14 ## General Public License for more details.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	15 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	16 ## 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: 7001 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	18 ## <http://www.gnu.org/licenses/>.
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	19
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	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 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	23 ## @deftypefnx {Function File} {} structfun (@dots{}, "ErrorHandler", @var{errfunc})
cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	24 ## @deftypefnx {Function File} {} structfun (@dots{}, "UniformOutput", @var{val})
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	25 ##
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	28 ## individually.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	29 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	30 ## @code{structfun} accepts an arbitrary function @var{func} in the form of
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	31 ## an inline function, function handle, or the name of a function (in a
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	32 ## character string). In the case of a character string argument, the
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	35 ## returned as separate output variables.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	36 ##
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	37 ## If the parameter @qcode{"UniformOutput"} is set to true (the default),
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	38 ## then the function must return a single element which will be concatenated
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	39 ## into the return value. If @qcode{"UniformOutput"} is false, the outputs
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	40 ## are placed into a structure with the same fieldnames as the input
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	41 ## structure.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	42 ##
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	43 ## @example
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	44 ## @group
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	45 ## s.name1 = "John Smith";
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46 ## s.name2 = "Jill Jones";
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	47 ## structfun (@@(x) regexp (x, '(\w+)$', "matches")@{1@}, s,
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 8347 diff changeset	48 ## "UniformOutput", false)
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	49 ## @result{}
10122 9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9036 diff changeset	50 ## @{
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9036 diff changeset	51 ## name1 = Smith
9d1a14e12431 Update docs and add tests for container functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 9036 diff changeset	52 ## name2 = Jones
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	53 ## @}
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	54 ## @end group
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	55 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56 ##
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	57 ## Given the parameter @qcode{"ErrorHandler"}, @var{errfunc} defines a
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	58 ## function to call in case @var{func} generates an error. The form of the
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	59 ## function is
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	60 ##
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	61 ## @example
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	62 ## function [@dots{}] = errfunc (@var{se}, @dots{})
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	63 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	64 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	65 ## @noindent
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	66 ## where there is an additional input argument to @var{errfunc} relative to
16826 a4969508008e doc: Periodic spellcheck of the documentation. Rik <rik@octave.org> parents: 16772 diff changeset	67 ## @var{func}, given by @nospell{@var{se}}. This is a structure with the
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	68 ## elements @qcode{"identifier"}, @qcode{"message"} and @qcode{"index"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	69 ## giving respectively the error identifier, the error message, and the index
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	70 ## into the input arguments of the element that caused the error. For an
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17101 diff changeset	71 ## example on how to use an error handler, @pxref{XREFcellfun,,cellfun}.
10122 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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	74 ## @end deftypefn
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	78 if (nargin < 2)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	79 print_usage ();
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	80 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	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 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	107
10132 aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	108 if (! uniform_output)
12931 cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	109 varargout = cellfun ("cell2struct", varargout, {fieldnames(S)}, {1}, uo_str, false);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	110 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	111 endfunction
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	112
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	113
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	114 %!test
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	115 %! s.name1 = "John Smith";
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	116 %! s.name2 = "Jill Jones";
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	117 %! l.name1 = "Smith";
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	118 %! l.name2 = "Jones";
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	119 %! o = structfun (@(x) regexp (x, '(\w+)$', "matches"){1}, s,
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 10134 diff changeset	120 %! "UniformOutput", false);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	121 %! assert (o, l);
10132 aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	122
13305 63463570d9fe Add %!endfunction block keyword to test.m Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	123 %!function [a, b] = __twoouts (x)
10132 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;
13305 63463570d9fe Add %!endfunction block keyword to test.m Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	126 %!endfunction
10132 aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	127
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	128 %!test
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	129 %! 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	130 %! c(1:2, 1, 1) = [2; 8];
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	131 %! c(1:2, 1, 2) = [4; 10];
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	132 %! c(1:2, 1, 3) = [6; 12];
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	133 %! d(1:2, 1, 1) = [1; 16];
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	134 %! d(1:2, 1, 2) = [4; 25];
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	135 %! d(1:2, 1, 3) = [9; 36];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	136 %! [aa, bb] = structfun (@__twoouts, s);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	137 %! assert (aa, c);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	138 %! assert (bb, d);
10132 aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	139
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	140 %!test
aa0f575cf39b improve structfun's Matlab compatibility Jaroslav Hajek <highegg@gmail.com> parents: 10122 diff changeset	141 %! 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	142 %! 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	143 %! d = struct ("a", {1, 4, 9}, "b", {16, 25, 36});
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	144 %! [aa, bb] = structfun (@__twoouts, s, "UniformOutput", false);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	145 %! assert (aa, c);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	146 %! assert (bb, d);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	147

Mercurial > hg > octave-lyh

annotate scripts/general/structfun.m @ 17289:bc924baa2c4e