Mercurial > octave-antonio
view liboctave/array/intNDArray.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
// N-D Array manipulations. /* Copyright (C) 2004-2015 John W. Eaton Copyright (C) 2009 VZLU Prague, a.s. 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 "Array-util.h" #include "mx-base.h" #include "lo-ieee.h" #include "mx-inlines.cc" // unary operations template <class T> boolNDArray intNDArray<T>::operator ! (void) const { boolNDArray b (this->dims ()); for (octave_idx_type i = 0; i < this->length (); i++) b.elem (i) = ! this->elem (i); return b; } template <class T> bool intNDArray<T>::any_element_not_one_or_zero (void) const { octave_idx_type nel = this->nelem (); for (octave_idx_type i = 0; i < nel; i++) { T val = this->elem (i); if (val != 0.0 && val != 1.0) return true; } return false; } template <class T> intNDArray<T> intNDArray<T>::diag (octave_idx_type k) const { return MArray<T>::diag (k); } template <class T> intNDArray<T> intNDArray<T>::diag (octave_idx_type m, octave_idx_type n) const { return MArray<T>::diag (m, n); } // FIXME: this is not quite the right thing. template <class T> boolNDArray intNDArray<T>::all (int dim) const { return do_mx_red_op<bool, T > (*this, dim, mx_inline_all); } template <class T> boolNDArray intNDArray<T>::any (int dim) const { return do_mx_red_op<bool, T > (*this, dim, mx_inline_any); } template <class T> void intNDArray<T>::increment_index (Array<octave_idx_type>& ra_idx, const dim_vector& dimensions, int start_dimension) { ::increment_index (ra_idx, dimensions, start_dimension); } template <class T> octave_idx_type intNDArray<T>::compute_index (Array<octave_idx_type>& ra_idx, const dim_vector& dimensions) { return ::compute_index (ra_idx, dimensions); } template <class T> intNDArray<T> intNDArray<T>::concat (const intNDArray<T>& rb, const Array<octave_idx_type>& ra_idx) { if (rb.numel () > 0) insert (rb, ra_idx); return *this; } template <class T> intNDArray<T>& intNDArray<T>::insert (const intNDArray<T>& a, octave_idx_type r, octave_idx_type c) { Array<T>::insert (a, r, c); return *this; } template <class T> intNDArray<T>& intNDArray<T>::insert (const intNDArray<T>& a, const Array<octave_idx_type>& ra_idx) { Array<T>::insert (a, ra_idx); return *this; } // This contains no information on the array structure !!! template <class T> std::ostream& operator << (std::ostream& os, const intNDArray<T>& a) { octave_idx_type nel = a.nelem (); for (octave_idx_type i = 0; i < nel; i++) os << " " << a.elem (i) << "\n"; return os; } template <class T> std::istream& operator >> (std::istream& is, intNDArray<T>& a) { octave_idx_type nel = a.nelem (); if (nel > 0) { T tmp; for (octave_idx_type i = 0; i < nel; i++) { is >> tmp; if (is) a.elem (i) = tmp; else goto done; } } done: return is; } // FIXME: should abs and signum just be mapper functions? template <class T> intNDArray<T> intNDArray<T>::abs (void) const { octave_idx_type nel = this->nelem (); intNDArray<T> ret (this->dims ()); for (octave_idx_type i = 0; i < nel; i++) { T val = this->elem (i); ret.xelem (i) = val.abs (); } return ret; } template <class T> intNDArray<T> intNDArray<T>::signum (void) const { octave_idx_type nel = this->nelem (); intNDArray<T> ret (this->dims ()); for (octave_idx_type i = 0; i < nel; i++) { T val = this->elem (i); ret.xelem (i) = val.signum (); } return ret; } template <class T> intNDArray<T> intNDArray<T>::prod (int dim) const { return do_mx_red_op<T, T> (*this, dim, mx_inline_prod); } template <class T> intNDArray<T> intNDArray<T>::sum (int dim) const { return do_mx_red_op<T, T> (*this, dim, mx_inline_sum); } template <class T> NDArray intNDArray<T>::dsum (int dim) const { return do_mx_red_op<double, T> (*this, dim, mx_inline_dsum); } template <class T> intNDArray<T> intNDArray<T>::cumsum (int dim) const { return do_mx_cum_op<T, T> (*this, dim, mx_inline_cumsum); } template <class T> intNDArray<T> intNDArray<T>::max (int dim) const { return do_mx_minmax_op<T> (*this, dim, mx_inline_max); } template <class T> intNDArray<T> intNDArray<T>::max (Array<octave_idx_type>& idx_arg, int dim) const { return do_mx_minmax_op<T> (*this, idx_arg, dim, mx_inline_max); } template <class T> intNDArray<T> intNDArray<T>::min (int dim) const { return do_mx_minmax_op<T> (*this, dim, mx_inline_min); } template <class T> intNDArray<T> intNDArray<T>::min (Array<octave_idx_type>& idx_arg, int dim) const { return do_mx_minmax_op<T> (*this, idx_arg, dim, mx_inline_min); } template <class T> intNDArray<T> intNDArray<T>::cummax (int dim) const { return do_mx_cumminmax_op<T> (*this, dim, mx_inline_cummax); } template <class T> intNDArray<T> intNDArray<T>::cummax (Array<octave_idx_type>& idx_arg, int dim) const { return do_mx_cumminmax_op<T> (*this, idx_arg, dim, mx_inline_cummax); } template <class T> intNDArray<T> intNDArray<T>::cummin (int dim) const { return do_mx_cumminmax_op<T> (*this, dim, mx_inline_cummin); } template <class T> intNDArray<T> intNDArray<T>::cummin (Array<octave_idx_type>& idx_arg, int dim) const { return do_mx_cumminmax_op<T> (*this, idx_arg, dim, mx_inline_cummin); } template <class T> intNDArray<T> intNDArray<T>::diff (octave_idx_type order, int dim) const { return do_mx_diff_op<T> (*this, dim, order, mx_inline_diff); }