Mercurial > hg > octave-lyh
view liboctave/bsxfun.h @ 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 | c3d401562410 |
children | 72c96de7a403 |
line wrap: on
line source
/* Copyright (C) 2011 Jordi GutiƩrrez Hermoso <jordigh@octave.org> This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if !defined (bsxfun_h) #define bsxfun_h 1 #include <algorithm> #include "Array.h" #include "dim-vector.h" #include "lo-error.h" inline bool is_valid_bsxfun (const std::string& name, const dim_vector& dx, const dim_vector& dy) { for (int i = 0; i < std::min (dx.length (), dy.length ()); i++) { octave_idx_type xk = dx(i), yk = dy(i); // Check the three conditions for valid bsxfun dims if (! ( (xk == yk) || (xk == 1 && yk > 1) || (xk > 1 && yk == 1))) return false; } (*current_liboctave_warning_with_id_handler) ("Octave:broadcast", "%s: automatic broadcasting operation applied", name.c_str ()); return true; } // since we can't change the size of the assigned-to matrix, we cannot // apply singleton expansion to it, so the conditions to check are // different here. inline bool is_valid_inplace_bsxfun (const std::string& name, const dim_vector& dr, const dim_vector& dx) { octave_idx_type drl = dr.length (), dxl = dx.length (); if (drl < dxl) return false; for (int i = 0; i < drl; i++) { octave_idx_type rk = dr(i), xk = dx(i); // Only two valid canditions to check; can't stretch rk if (! ( (rk == xk) || (rk > 1 && xk == 1))) return false; } (*current_liboctave_warning_with_id_handler) ("Octave:broadcast", "%s: automatic broadcasting operation applied", name.c_str ()); return true; } #include "bsxfun-defs.cc" #endif