Mercurial > octave-antonio
view liboctave/array/MArray.h @ 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
// Template array classes with like-type math ops /* Copyright (C) 1993-2015 John W. Eaton Copyright (C) 2010 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/>. */ #if !defined (octave_MArray_h) #define octave_MArray_h 1 #include "Array.h" // N-dimensional array with math ops. // But first, some preprocessor abuse... #include "MArray-decl.h" MARRAY_OPS_FORWARD_DECLS (MArray, ) template <class T> class MArray : public Array<T> { protected: // For jit support MArray (T *sdata, octave_idx_type slen, octave_idx_type *adims, void *arep) : Array<T> (sdata, slen, adims, arep) { } public: MArray (void) : Array<T> () { } explicit MArray (const dim_vector& dv) : Array<T> (dv) { } explicit MArray (const dim_vector& dv, const T& val) : Array<T> (dv, val) { } MArray (const MArray<T>& a) : Array<T> (a) { } template <class U> MArray (const Array<U>& a) : Array<T> (a) { } ~MArray (void) { } MArray<T>& operator = (const MArray<T>& a) { Array<T>::operator = (a); return *this; } MArray<T> reshape (const dim_vector& new_dims) const { return Array<T>::reshape (new_dims); } MArray<T> permute (const Array<octave_idx_type>& vec, bool inv = false) const { return Array<T>::permute (vec, inv); } MArray<T> ipermute (const Array<octave_idx_type>& vec) const { return Array<T>::ipermute (vec); } MArray squeeze (void) const { return Array<T>::squeeze (); } MArray<T> transpose (void) const { return Array<T>::transpose (); } MArray<T> hermitian (T (*fcn) (const T&) = 0) const { return Array<T>::hermitian (fcn); } // Performs indexed accumulative addition. void idx_add (const idx_vector& idx, T val); void idx_add (const idx_vector& idx, const MArray<T>& vals); void idx_min (const idx_vector& idx, const MArray<T>& vals); void idx_max (const idx_vector& idx, const MArray<T>& vals); void idx_add_nd (const idx_vector& idx, const MArray<T>& vals, int dim = -1); void changesign (void); }; #endif