Mercurial > hg > octave-lyh
diff scripts/miscellaneous/warning_ids.m @ 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 | 4aadd3e2c5bc |
children | 94e2a76f1e5a |
line wrap: on
line diff
--- a/scripts/miscellaneous/warning_ids.m +++ b/scripts/miscellaneous/warning_ids.m @@ -120,6 +120,11 @@ ## directory as the .oct file referred to by the autoload() command. ## By default, the @code{Octave:autoload-relative-file-name} warning is enabled. ## +## @item Octave:broadcast +## Warn when performing broadcasting operations. By default, this is +## enabled. See the Broadcasting section in the Vectorization and Faster +## Code Execution chapter in the manual. +## ## @item Octave:built-in-variable-assignment ## By default, the @code{Octave:built-in-variable-assignment} warning is ## enabled.