comparison src/DLD-FUNCTIONS/max.cc @ 13789:4de1e8778d48

Fix typo in @var macro in cset 8bb7bdbe9c69. * max.cc (min, max): Change @vary{y} to @var{y}. Add additional calling form of function to demonstrate use of empty ([]) argument.
author Rik <octave@nomad.inbox5.com>
date Wed, 02 Nov 2011 09:20:35 -0700
parents 40dab5d70115
children 5fa482628bf6
comparison
equal deleted inserted replaced
13788:9ab64f063c96 13789:4de1e8778d48
307 307
308 DEFUN_DLD (min, args, nargout, 308 DEFUN_DLD (min, args, nargout,
309 "-*- texinfo -*-\n\ 309 "-*- texinfo -*-\n\
310 @deftypefn {Loadable Function} {} min (@var{x})\n\ 310 @deftypefn {Loadable Function} {} min (@var{x})\n\
311 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y})\n\ 311 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y})\n\
312 @deftypefnx {Loadable Function} {} min (@var{x}, [], @var{dim})\n\
312 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y}, @var{dim})\n\ 313 @deftypefnx {Loadable Function} {} min (@var{x}, @var{y}, @var{dim})\n\
313 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} min (@var{x})\n\ 314 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} min (@var{x})\n\
314 For a vector argument, return the minimum value. For a matrix\n\ 315 For a vector argument, return the minimum value. For a matrix\n\
315 argument, return the minimum value from each column, as a row\n\ 316 argument, return the minimum value from each column, as a row\n\
316 vector, or over the dimension @var{dim} if defined, in which case @vary{y} \n\ 317 vector, or over the dimension @var{dim} if defined, in which case @var{y} \n\
317 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\ 318 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\
318 (or a matrix and scalar), return the pair-wise minimum.\n\ 319 (or a matrix and scalar), return the pair-wise minimum.\n\
319 Thus,\n\ 320 Thus,\n\
320 \n\ 321 \n\
321 @example\n\ 322 @example\n\
385 386
386 DEFUN_DLD (max, args, nargout, 387 DEFUN_DLD (max, args, nargout,
387 "-*- texinfo -*-\n\ 388 "-*- texinfo -*-\n\
388 @deftypefn {Loadable Function} {} max (@var{x})\n\ 389 @deftypefn {Loadable Function} {} max (@var{x})\n\
389 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y})\n\ 390 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y})\n\
391 @deftypefnx {Loadable Function} {} max (@var{x}, [], @var{dim})\n\
390 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y}, @var{dim})\n\ 392 @deftypefnx {Loadable Function} {} max (@var{x}, @var{y}, @var{dim})\n\
391 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} max (@var{x})\n\ 393 @deftypefnx {Loadable Function} {[@var{w}, @var{iw}] =} max (@var{x})\n\
392 For a vector argument, return the maximum value. For a matrix\n\ 394 For a vector argument, return the maximum value. For a matrix\n\
393 argument, return the maximum value from each column, as a row\n\ 395 argument, return the maximum value from each column, as a row\n\
394 vector, or over the dimension @var{dim} if defined, in which case @vary{y} \n\ 396 vector, or over the dimension @var{dim} if defined, in which case @var{y} \n\
395 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\ 397 should be set to the empty matrix (it's ignored otherwise). For two matrices\n\
396 (or a matrix and scalar), return the pair-wise maximum.\n\ 398 (or a matrix and scalar), return the pair-wise maximum.\n\
397 Thus,\n\ 399 Thus,\n\
398 \n\ 400 \n\
399 @example\n\ 401 @example\n\