Mercurial > octave-nkf
comparison src/DLD-FUNCTIONS/bsxfun.cc @ 14116:951eacaf9381 stable
Initial documentation for broadcasting and general vectorization guidelines
* vectorize.txi: New file.
* NEWS: Update with location of broadcasting documentation.
* Makefile.am: Add vectorize.texi
* arith.txi: Move accumarray and accumdim docstring to vectorize.txi
* container.txi: Move structfun docstring to vectorize.txi
* expr.txi: Mention broadcasting where relevant.
* func.txi: Move vectorize docstring to vectorize.txi
* matrix.txi: Move function application section to vectorize.txi
* octave.texi: Add vectorize.txi and its menu options
* sparse.txi: Move spfun to vectorize.txi
* tips.txi: Move and rewrite coding tips section in vectorize.txi
* bsxfun.h (is_valid_bsxfun, is_valid_inplace_bsxfun): Rename warning
to "Octave:broadcast"
* accumdim.m: Reformat to use @example in lieu of @smallexample
* warning_ids.m: Add Octave:broadcast
* bsxfun.cc: Reword docstring to mention broadcasting
* cellfun.cc: Move comment about efficiency from tips.txi
* version.h.in: Add a big startup warning about broadcasting
author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
---|---|
date | Tue, 27 Dec 2011 15:15:41 -0500 |
parents | 9cae456085c2 |
children | 72c96de7a403 |
comparison
equal
deleted
inserted
replaced
14115:0b3518c1228a | 14116:951eacaf9381 |
---|---|
310 } | 310 } |
311 | 311 |
312 DEFUN_DLD (bsxfun, args, , | 312 DEFUN_DLD (bsxfun, args, , |
313 "-*- texinfo -*-\n\ | 313 "-*- texinfo -*-\n\ |
314 @deftypefn {Loadable Function} {} bsxfun (@var{f}, @var{A}, @var{B})\n\ | 314 @deftypefn {Loadable Function} {} bsxfun (@var{f}, @var{A}, @var{B})\n\ |
315 The binary singleton expansion function applier does what its name\n\ | 315 The binary singleton expansion function applier performs broadcasting,\n\ |
316 suggests: applies a binary function @var{f} element-by-element to two\n\ | 316 that is, applies a binary function @var{f} element-by-element to two\n\ |
317 array arguments @var{A} and @var{B}, and expands as necessary\n\ | 317 array arguments @var{A} and @var{B}, and expands as necessary\n\ |
318 singleton dimensions in either input argument. @var{f} is a function\n\ | 318 singleton dimensions in either input argument. @var{f} is a function\n\ |
319 handle, inline function, or string containing the name of the function\n\ | 319 handle, inline function, or string containing the name of the function\n\ |
320 to evaluate. The function @var{f} must be capable of accepting two\n\ | 320 to evaluate. The function @var{f} must be capable of accepting two\n\ |
321 column-vector arguments of equal length, or one column vector argument\n\ | 321 column-vector arguments of equal length, or one column vector argument\n\ |