Mercurial > octave-nkf
comparison libinterp/corefcn/cellfun.cc @ 17281: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 | 7babcdb9bc13 |
| children | d63878346099 |
comparison
equal
deleted
inserted
replaced
| 17280:1a5407bae739 | 17281:bc924baa2c4e |
|---|---|
| 345 \n\ | 345 \n\ |
| 346 Note that per default the output argument(s) are arrays of the same size as\n\ | 346 Note that per default the output argument(s) are arrays of the same size as\n\ |
| 347 the input arguments. Input arguments that are singleton (1x1) cells will be\n\ | 347 the input arguments. Input arguments that are singleton (1x1) cells will be\n\ |
| 348 automatically expanded to the size of the other arguments.\n\ | 348 automatically expanded to the size of the other arguments.\n\ |
| 349 \n\ | 349 \n\ |
| 350 If the parameter \"UniformOutput\" is set to true (the default), then the\n\ | 350 If the parameter @qcode{\"UniformOutput\"} is set to true (the default),\n\ |
| 351 function must return scalars which will be concatenated into the return\n\ | 351 then the function must return scalars which will be concatenated into the\n\ |
| 352 array(s). If \"UniformOutput\" is false, the outputs are concatenated into a\n\ | 352 return array(s). If @qcode{\"UniformOutput\"} is false, the outputs are\n\ |
| 353 cell array (or cell arrays). For example:\n\ | 353 concatenated into a cell array (or cell arrays). For example:\n\ |
| 354 \n\ | 354 \n\ |
| 355 @example\n\ | 355 @example\n\ |
| 356 @group\n\ | 356 @group\n\ |
| 357 cellfun (\"tolower\", @{\"Foo\", \"Bar\", \"FooBar\"@},\n\ | 357 cellfun (\"tolower\", @{\"Foo\", \"Bar\", \"FooBar\"@},\n\ |
| 358 \"UniformOutput\", false)\n\ | 358 \"UniformOutput\", false)\n\ |
| 359 @result{} @{\"foo\", \"bar\", \"foobar\"@}\n\ | 359 @result{} @{\"foo\", \"bar\", \"foobar\"@}\n\ |
| 360 @end group\n\ | 360 @end group\n\ |
| 361 @end example\n\ | 361 @end example\n\ |
| 362 \n\ | 362 \n\ |
| 363 Given the parameter \"ErrorHandler\", then @var{errfunc} defines a function\n\ | 363 Given the parameter @qcode{\"ErrorHandler\"}, then @var{errfunc} defines a\n\ |
| 364 to call in case @var{func} generates an error. The form of the function is\n\ | 364 function to call in case @var{func} generates an error. The form of the\n\ |
| 365 function is\n\ | |
| 365 \n\ | 366 \n\ |
| 366 @example\n\ | 367 @example\n\ |
| 367 function [@dots{}] = errfunc (@var{s}, @dots{})\n\ | 368 function [@dots{}] = errfunc (@var{s}, @dots{})\n\ |
| 368 @end example\n\ | 369 @end example\n\ |
| 369 \n\ | 370 \n\ |
| 370 @noindent\n\ | 371 @noindent\n\ |
| 371 where there is an additional input argument to @var{errfunc} relative to\n\ | 372 where there is an additional input argument to @var{errfunc} relative to\n\ |
| 372 @var{func}, given by @var{s}. This is a structure with the elements\n\ | 373 @var{func}, given by @var{s}. This is a structure with the elements\n\ |
| 373 'identifier', 'message' and 'index', giving respectively the error\n\ | 374 @qcode{\"identifier\"}, @qcode{\"message\"} and @qcode{\"index\"}, giving\n\ |
| 374 identifier, the error message, and the index into the input arguments\n\ | 375 respectively the error identifier, the error message, and the index into the\n\ |
| 375 of the element that caused the error. For example:\n\ | 376 input arguments of the element that caused the error. For example:\n\ |
| 376 \n\ | 377 \n\ |
| 377 @example\n\ | 378 @example\n\ |
| 378 @group\n\ | 379 @group\n\ |
| 379 function y = foo (s, x), y = NaN; endfunction\n\ | 380 function y = foo (s, x), y = NaN; endfunction\n\ |
| 380 cellfun (\"factorial\", @{-1,2@}, \"ErrorHandler\", @@foo)\n\ | 381 cellfun (\"factorial\", @{-1,2@}, \"ErrorHandler\", @@foo)\n\ |
| 1068 @result{} [ 1.5708 0.0000 ]\n\ | 1069 @result{} [ 1.5708 0.0000 ]\n\ |
| 1069 @end group\n\ | 1070 @end group\n\ |
| 1070 @end example\n\ | 1071 @end example\n\ |
| 1071 \n\ | 1072 \n\ |
| 1072 If the parameter @var{val} after a further string input argument\n\ | 1073 If the parameter @var{val} after a further string input argument\n\ |
| 1073 \"UniformOutput\" is set @code{true} (the default), then the named\n\ | 1074 @qcode{\"UniformOutput\"} is set @code{true} (the default), then the named\n\ |
| 1074 function @var{func} must return a single element which then will be\n\ | 1075 function @var{func} must return a single element which then will be\n\ |
| 1075 concatenated into the return value and is of type matrix. Otherwise,\n\ | 1076 concatenated into the return value and is of type matrix. Otherwise,\n\ |
| 1076 if that parameter is set to @code{false}, then the outputs are\n\ | 1077 if that parameter is set to @code{false}, then the outputs are\n\ |
| 1077 concatenated in a cell array. For example:\n\ | 1078 concatenated in a cell array. For example:\n\ |
| 1078 \n\ | 1079 \n\ |
| 1113 @}\n\ | 1114 @}\n\ |
| 1114 @end group\n\ | 1115 @end group\n\ |
| 1115 @end example\n\ | 1116 @end example\n\ |
| 1116 \n\ | 1117 \n\ |
| 1117 If the parameter @var{errfunc} after a further string input argument\n\ | 1118 If the parameter @var{errfunc} after a further string input argument\n\ |
| 1118 \"ErrorHandler\" is another string, a function handle, an inline\n\ | 1119 @qcode{\"ErrorHandler\"} is another string, a function handle, an inline\n\ |
| 1119 function, or an anonymous function, then @var{errfunc} defines a\n\ | 1120 function, or an anonymous function, then @var{errfunc} defines a\n\ |
| 1120 function to call in the case that @var{func} generates an error.\n\ | 1121 function to call in the case that @var{func} generates an error.\n\ |
| 1121 The definition of the function must be of the form\n\ | 1122 The definition of the function must be of the form\n\ |
| 1122 \n\ | 1123 \n\ |
| 1123 @example\n\ | 1124 @example\n\ |
| 1125 @end example\n\ | 1126 @end example\n\ |
| 1126 \n\ | 1127 \n\ |
| 1127 @noindent\n\ | 1128 @noindent\n\ |
| 1128 where there is an additional input argument to @var{errfunc}\n\ | 1129 where there is an additional input argument to @var{errfunc}\n\ |
| 1129 relative to @var{func}, given by @var{s}. This is a structure with\n\ | 1130 relative to @var{func}, given by @var{s}. This is a structure with\n\ |
| 1130 the elements \"identifier\", \"message\", and \"index\" giving,\n\ | 1131 the elements @qcode{\"identifier\"}, @qcode{\"message\"}, and\n\ |
| 1131 respectively, the error identifier, the error message, and the index of\n\ | 1132 @qcode{\"index\"} giving, respectively, the error identifier, the error\n\ |
| 1132 the array elements that caused the error. The size of the output\n\ | 1133 message, and the index of the array elements that caused the error. The\n\ |
| 1133 argument of @var{errfunc} must have the same size as the output\n\ | 1134 size of the output argument of @var{errfunc} must have the same size as the\n\ |
| 1134 argument of @var{func}, otherwise a real error is thrown. For\n\ | 1135 output argument of @var{func}, otherwise a real error is thrown. For\n\ |
| 1135 example:\n\ | 1136 example:\n\ |
| 1136 \n\ | 1137 \n\ |
| 1137 @example\n\ | 1138 @example\n\ |
| 1138 @group\n\ | 1139 @group\n\ |
| 1139 function y = ferr (s, x), y = \"MyString\"; endfunction\n\ | 1140 function y = ferr (s, x), y = \"MyString\"; endfunction\n\ |