Mercurial > octave-antonio
view liboctave/array/MArray.cc @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
/* Copyright (C) 1993-2015 John W. Eaton Copyright (C) 2009 VZLU Prague 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/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "MArray.h" #include "Array-util.h" #include "lo-error.h" #include "MArray-defs.h" #include "mx-inlines.cc" template <class T> struct _idxadds_helper { T *array; T val; _idxadds_helper (T *a, T v) : array (a), val (v) { } void operator () (octave_idx_type i) { array[i] += val; } }; template <class T> struct _idxadda_helper { T *array; const T *vals; _idxadda_helper (T *a, const T *v) : array (a), vals (v) { } void operator () (octave_idx_type i) { array[i] += *vals++; } }; template <class T> void MArray<T>::idx_add (const idx_vector& idx, T val) { octave_idx_type n = this->length (); octave_idx_type ext = idx.extent (n); if (ext > n) { this->resize1 (ext); n = ext; } octave_quit (); octave_idx_type len = idx.length (n); idx.loop (len, _idxadds_helper<T> (this->fortran_vec (), val)); } template <class T> void MArray<T>::idx_add (const idx_vector& idx, const MArray<T>& vals) { octave_idx_type n = this->length (); octave_idx_type ext = idx.extent (n); if (ext > n) { this->resize1 (ext); n = ext; } octave_quit (); octave_idx_type len = std::min (idx.length (n), vals.length ()); idx.loop (len, _idxadda_helper<T> (this->fortran_vec (), vals.data ())); } template <class T, T op (typename ref_param<T>::type, typename ref_param<T>::type)> struct _idxbinop_helper { T *array; const T *vals; _idxbinop_helper (T *a, const T *v) : array (a), vals (v) { } void operator () (octave_idx_type i) { array[i] = op (array[i], *vals++); } }; template <class T> void MArray<T>::idx_min (const idx_vector& idx, const MArray<T>& vals) { octave_idx_type n = this->length (); octave_idx_type ext = idx.extent (n); if (ext > n) { this->resize1 (ext); n = ext; } octave_quit (); octave_idx_type len = std::min (idx.length (n), vals.length ()); idx.loop (len, _idxbinop_helper<T, xmin> (this->fortran_vec (), vals.data ())); } template <class T> void MArray<T>::idx_max (const idx_vector& idx, const MArray<T>& vals) { octave_idx_type n = this->length (); octave_idx_type ext = idx.extent (n); if (ext > n) { this->resize1 (ext); n = ext; } octave_quit (); octave_idx_type len = std::min (idx.length (n), vals.length ()); idx.loop (len, _idxbinop_helper<T, xmax> (this->fortran_vec (), vals.data ())); } #include <iostream> template <class T> void MArray<T>::idx_add_nd (const idx_vector& idx, const MArray<T>& vals, int dim) { int nd = std::max (this->ndims (), vals.ndims ()); if (dim < 0) dim = vals.dims ().first_non_singleton (); else if (dim > nd) nd = dim; // Check dimensions. dim_vector ddv = Array<T>::dims ().redim (nd); dim_vector sdv = vals.dims ().redim (nd); octave_idx_type ext = idx.extent (ddv (dim)); if (ext > ddv(dim)) { ddv(dim) = ext; Array<T>::resize (ddv); ext = ddv(dim); } octave_idx_type l,n,u,ns; get_extent_triplet (ddv, dim, l, n, u); ns = sdv(dim); sdv(dim) = ddv(dim) = 0; if (ddv != sdv) (*current_liboctave_error_handler) ("accumdim: dimension mismatch"); T *dst = Array<T>::fortran_vec (); const T *src = vals.data (); octave_idx_type len = idx.length (ns); if (l == 1) { for (octave_idx_type j = 0; j < u; j++) { octave_quit (); idx.loop (len, _idxadda_helper<T> (dst + j*n, src + j*ns)); } } else { for (octave_idx_type j = 0; j < u; j++) { octave_quit (); for (octave_idx_type i = 0; i < len; i++) { octave_idx_type k = idx(i); mx_inline_add2 (l, dst + l*k, src + l*i); } dst += l*n; src += l*ns; } } } // N-dimensional array with math ops. template <class T> void MArray<T>::changesign (void) { if (Array<T>::is_shared ()) *this = - *this; else do_mx_inplace_op<T> (*this, mx_inline_uminus2); } // Element by element MArray by scalar ops. template <class T> MArray<T>& operator += (MArray<T>& a, const T& s) { if (a.is_shared ()) a = a + s; else do_ms_inplace_op<T, T> (a, s, mx_inline_add2); return a; } template <class T> MArray<T>& operator -= (MArray<T>& a, const T& s) { if (a.is_shared ()) a = a - s; else do_ms_inplace_op<T, T> (a, s, mx_inline_sub2); return a; } template <class T> MArray<T>& operator *= (MArray<T>& a, const T& s) { if (a.is_shared ()) a = a * s; else do_ms_inplace_op<T, T> (a, s, mx_inline_mul2); return a; } template <class T> MArray<T>& operator /= (MArray<T>& a, const T& s) { if (a.is_shared ()) a = a / s; else do_ms_inplace_op<T, T> (a, s, mx_inline_div2); return a; } // Element by element MArray by MArray ops. template <class T> MArray<T>& operator += (MArray<T>& a, const MArray<T>& b) { if (a.is_shared ()) a = a + b; else do_mm_inplace_op<T, T> (a, b, mx_inline_add2, mx_inline_add2, "+="); return a; } template <class T> MArray<T>& operator -= (MArray<T>& a, const MArray<T>& b) { if (a.is_shared ()) a = a - b; else do_mm_inplace_op<T, T> (a, b, mx_inline_sub2, mx_inline_sub2, "-="); return a; } template <class T> MArray<T>& product_eq (MArray<T>& a, const MArray<T>& b) { if (a.is_shared ()) return a = product (a, b); else do_mm_inplace_op<T, T> (a, b, mx_inline_mul2, mx_inline_mul2, ".*="); return a; } template <class T> MArray<T>& quotient_eq (MArray<T>& a, const MArray<T>& b) { if (a.is_shared ()) return a = quotient (a, b); else do_mm_inplace_op<T, T> (a, b, mx_inline_div2, mx_inline_div2, "./="); return a; } // Element by element MArray by scalar ops. #define MARRAY_NDS_OP(OP, FN) \ template <class T> \ MArray<T> \ operator OP (const MArray<T>& a, const T& s) \ { \ return do_ms_binary_op<T, T, T> (a, s, FN); \ } MARRAY_NDS_OP (+, mx_inline_add) MARRAY_NDS_OP (-, mx_inline_sub) MARRAY_NDS_OP (*, mx_inline_mul) MARRAY_NDS_OP (/, mx_inline_div) // Element by element scalar by MArray ops. #define MARRAY_SND_OP(OP, FN) \ template <class T> \ MArray<T> \ operator OP (const T& s, const MArray<T>& a) \ { \ return do_sm_binary_op<T, T, T> (s, a, FN); \ } MARRAY_SND_OP (+, mx_inline_add) MARRAY_SND_OP (-, mx_inline_sub) MARRAY_SND_OP (*, mx_inline_mul) MARRAY_SND_OP (/, mx_inline_div) // Element by element MArray by MArray ops. #define MARRAY_NDND_OP(FCN, OP, FN) \ template <class T> \ MArray<T> \ FCN (const MArray<T>& a, const MArray<T>& b) \ { \ return do_mm_binary_op<T, T, T> (a, b, FN, FN, FN, #FCN); \ } MARRAY_NDND_OP (operator +, +, mx_inline_add) MARRAY_NDND_OP (operator -, -, mx_inline_sub) MARRAY_NDND_OP (product, *, mx_inline_mul) MARRAY_NDND_OP (quotient, /, mx_inline_div) template <class T> MArray<T> operator + (const MArray<T>& a) { return a; } template <class T> MArray<T> operator - (const MArray<T>& a) { return do_mx_unary_op<T, T> (a, mx_inline_uminus); }