Mercurial > octave
view liboctave/array/MArray.h @ 32628:ae4e19c0a2b1
maint: Place class name and class keyword on one line.
* libinterp/corefcn/Cell.h, libinterp/corefcn/__magick_read__.cc,
libinterp/corefcn/auto-shlib.h, libinterp/corefcn/base-text-renderer.h,
libinterp/corefcn/c-file-ptr-stream.h, libinterp/corefcn/call-stack.h,
libinterp/corefcn/dynamic-ld.h, libinterp/corefcn/event-manager.h,
libinterp/corefcn/event-queue.h, libinterp/corefcn/ft-text-renderer.cc,
libinterp/corefcn/gl-render.cc, libinterp/corefcn/gl-render.h,
libinterp/corefcn/gl2ps-print.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/input.cc,
libinterp/corefcn/latex-text-renderer.cc, libinterp/corefcn/load-path.h,
libinterp/corefcn/mx-type-traits.h, libinterp/corefcn/oct-errno.h,
libinterp/corefcn/oct-fstrm.h, libinterp/corefcn/oct-iostrm.h,
libinterp/corefcn/oct-prcstrm.h, libinterp/corefcn/oct-procbuf.h,
libinterp/corefcn/oct-process.h, libinterp/corefcn/oct-stdstrm.h,
libinterp/corefcn/oct-stream.cc, libinterp/corefcn/oct-stream.h,
libinterp/corefcn/oct-strstrm.h, libinterp/corefcn/pager.h,
libinterp/corefcn/pr-flt-fmt.h, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pr-output.h, libinterp/corefcn/procstream.h,
libinterp/corefcn/syminfo.h, libinterp/corefcn/text-engine.h,
libinterp/corefcn/text-renderer.h, libinterp/corefcn/utils.h,
libinterp/octave-value/cdef-class.h, libinterp/octave-value/cdef-manager.h,
libinterp/octave-value/cdef-method.h, libinterp/octave-value/cdef-object.h,
libinterp/octave-value/cdef-package.h, libinterp/octave-value/cdef-property.h,
libinterp/octave-value/ov-base-diag.h, libinterp/octave-value/ov-base-int.h,
libinterp/octave-value/ov-base-mat.h, libinterp/octave-value/ov-base-scalar.h,
libinterp/octave-value/ov-base-sparse.h, libinterp/octave-value/ov-base.h,
libinterp/octave-value/ov-bool-mat.h, libinterp/octave-value/ov-bool-sparse.h,
libinterp/octave-value/ov-bool.h, libinterp/octave-value/ov-builtin.h,
libinterp/octave-value/ov-cell.h, libinterp/octave-value/ov-ch-mat.h,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-class.h,
libinterp/octave-value/ov-classdef.h, libinterp/octave-value/ov-colon.h,
libinterp/octave-value/ov-complex.h, libinterp/octave-value/ov-cs-list.h,
libinterp/octave-value/ov-cx-diag.h, libinterp/octave-value/ov-cx-mat.h,
libinterp/octave-value/ov-cx-sparse.h, libinterp/octave-value/ov-dld-fcn.h,
libinterp/octave-value/ov-fcn-handle.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-float.h, libinterp/octave-value/ov-flt-complex.h,
libinterp/octave-value/ov-flt-cx-diag.h,
libinterp/octave-value/ov-flt-cx-mat.h,
libinterp/octave-value/ov-flt-re-diag.h,
libinterp/octave-value/ov-flt-re-mat.h, libinterp/octave-value/ov-int-traits.h,
libinterp/octave-value/ov-intx.h, libinterp/octave-value/ov-lazy-idx.h,
libinterp/octave-value/ov-legacy-range.cc,
libinterp/octave-value/ov-legacy-range.h,
libinterp/octave-value/ov-magic-int.h, libinterp/octave-value/ov-mex-fcn.h,
libinterp/octave-value/ov-null-mat.h, libinterp/octave-value/ov-perm.h,
libinterp/octave-value/ov-range-traits.h, libinterp/octave-value/ov-range.h,
libinterp/octave-value/ov-re-diag.h, libinterp/octave-value/ov-re-mat.h,
libinterp/octave-value/ov-re-sparse.h, libinterp/octave-value/ov-scalar.h,
libinterp/octave-value/ov-str-mat.h, libinterp/octave-value/ov-struct.h,
libinterp/octave-value/ov-typeinfo.h, libinterp/octave-value/ov-usr-fcn.h,
libinterp/octave-value/ov.h, libinterp/octave-value/ovl.h,
libinterp/parse-tree/comment-list.h, libinterp/parse-tree/lex.h,
libinterp/parse-tree/profiler.h, libinterp/parse-tree/pt-anon-scopes.h,
liboctave/array/Array.h, liboctave/array/CColVector.h,
liboctave/array/CDiagMatrix.h, liboctave/array/CMatrix.h,
liboctave/array/CNDArray.h, liboctave/array/CRowVector.h,
liboctave/array/CSparse.h, liboctave/array/DiagArray2.h,
liboctave/array/MArray.h, liboctave/array/MDiagArray2.h,
liboctave/array/MSparse.h, liboctave/array/MatrixType.h,
liboctave/array/Range.h, liboctave/array/Sparse.h,
liboctave/array/boolMatrix.h, liboctave/array/boolNDArray.h,
liboctave/array/boolSparse.h, liboctave/array/chMatrix.h,
liboctave/array/chNDArray.h, liboctave/array/dColVector.h,
liboctave/array/dDiagMatrix.h, liboctave/array/dMatrix.h,
liboctave/array/dNDArray.h, liboctave/array/dRowVector.h,
liboctave/array/dSparse.h, liboctave/array/dim-vector.h,
liboctave/array/fCColVector.h, liboctave/array/fCDiagMatrix.h,
liboctave/array/fCMatrix.h, liboctave/array/fCNDArray.h,
liboctave/array/fCRowVector.h, liboctave/array/fColVector.h,
liboctave/array/fDiagMatrix.h, liboctave/array/fMatrix.h,
liboctave/array/fNDArray.h, liboctave/array/fRowVector.h,
liboctave/array/idx-vector.h, liboctave/array/intNDArray.h,
liboctave/numeric/DAE.h, liboctave/numeric/DAEFunc.h,
liboctave/numeric/DAERT.h, liboctave/numeric/DAERTFunc.h,
liboctave/numeric/DASPK.h, liboctave/numeric/DASRT.h,
liboctave/numeric/DASSL.h, liboctave/numeric/DET.h, liboctave/numeric/EIG.h,
liboctave/numeric/LSODE.h, liboctave/numeric/ODE.h,
liboctave/numeric/ODEFunc.h, liboctave/numeric/ODES.h,
liboctave/numeric/ODESFunc.h, liboctave/numeric/Quad.h,
liboctave/numeric/aepbalance.h, liboctave/numeric/base-dae.h,
liboctave/numeric/base-de.h, liboctave/numeric/chol.h,
liboctave/numeric/fEIG.h, liboctave/numeric/gepbalance.h,
liboctave/numeric/gsvd.h, liboctave/numeric/hess.h, liboctave/numeric/lu.h,
liboctave/numeric/oct-fftw.h, liboctave/numeric/qr.h, liboctave/numeric/qrp.h,
liboctave/numeric/schur.h, liboctave/numeric/sparse-chol.h,
liboctave/numeric/sparse-lu.h, liboctave/numeric/sparse-qr.cc,
liboctave/numeric/sparse-qr.h, liboctave/numeric/svd.cc,
liboctave/numeric/svd.h, liboctave/system/dir-ops.h,
liboctave/system/file-stat.h, liboctave/system/oct-env.h,
liboctave/system/oct-group.h, liboctave/system/oct-password.h,
liboctave/system/oct-time.h, liboctave/system/oct-uname.h,
liboctave/util/action-container.h, liboctave/util/base-list.h,
liboctave/util/cmd-edit.cc, liboctave/util/cmd-edit.h,
liboctave/util/cmd-hist.cc, liboctave/util/cmd-hist.h,
liboctave/util/data-conv.h, liboctave/util/glob-match.h,
liboctave/util/lo-regexp.h, liboctave/util/oct-inttypes.h,
liboctave/util/oct-mutex.cc, liboctave/util/oct-mutex.h,
liboctave/util/oct-shlib.cc, liboctave/util/oct-shlib.h,
liboctave/util/oct-sort.h, liboctave/util/oct-string.h,
liboctave/util/octave-preserve-stream-state.h, liboctave/util/pathsearch.h,
liboctave/util/singleton-cleanup.h, liboctave/util/str-vec.h,
liboctave/util/unwind-prot.h, liboctave/util/url-transfer.h:
Place class name and class keyword on one line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 21 Dec 2023 11:22:26 -0800 |
| parents | 21f9b34eb893 |
| children | 4b601ca024d5 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-2023 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_MArray_h) #define octave_MArray_h 1 #include "octave-config.h" #include "Array.h" #include "MArray-fwd.h" #include "mx-inlines.cc" template <typename T> OCTARRAY_API MArray<T>& operator += (MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T>& operator -= (MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T>& operator *= (MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T>& operator /= (MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T>& operator += (MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T>& operator -= (MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T>& product_eq (MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T>& quotient_eq (MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator + (const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator - (const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator + (const MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T> operator - (const MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T> operator * (const MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T> operator / (const MArray<T>&, const T&); template <typename T> OCTARRAY_API MArray<T> operator + (const T&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator - (const T&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator * (const T&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator / (const T&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator + (const MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> operator - (const MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> quotient (const MArray<T>&, const MArray<T>&); template <typename T> OCTARRAY_API MArray<T> product (const MArray<T>&, const MArray<T>&); //! Template for N-dimensional array classes with like-type math operators. template <typename T> class OCTARRAY_API MArray : public Array<T> { public: MArray () : 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 <typename U> MArray (const Array<U>& a) : Array<T> (a) { } ~MArray () = default; 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 () const { return Array<T>::squeeze (); } MArray<T> transpose () const { return Array<T>::transpose (); } MArray<T> hermitian (T (*fcn) (const T&) = nullptr) const { return Array<T>::hermitian (fcn); } //! Performs indexed accumulative addition. //@{ OCTARRAY_API void idx_add (const octave::idx_vector& idx, T val); OCTARRAY_API void idx_add (const octave::idx_vector& idx, const MArray<T>& vals); //@} OCTARRAY_API void idx_min (const octave::idx_vector& idx, const MArray<T>& vals); OCTARRAY_API void idx_max (const octave::idx_vector& idx, const MArray<T>& vals); OCTARRAY_API void idx_add_nd (const octave::idx_vector& idx, const MArray<T>& vals, int dim = -1); OCTARRAY_API void changesign (); private: OCTARRAY_API static void instantiation_guard (); }; // Define all the MArray forwarding functions for return type R and // MArray element type T #define MARRAY_FORWARD_DEFS(B, R, T) \ inline R operator += (R& x, const T& y) \ { \ return R (operator += (dynamic_cast<B<T>&> (x), (y))); \ } \ inline R operator -= (R& x, const T& y) \ { \ return R (operator -= (dynamic_cast<B<T>&> (x), (y))); \ } \ inline R operator *= (R& x, const T& y) \ { \ return R (operator *= (dynamic_cast<B<T>&> (x), (y))); \ } \ inline R operator /= (R& x, const T& y) \ { \ return R (operator /= (dynamic_cast<B<T>&> (x), (y))); \ } \ inline R operator += (R& x, const R& y) \ { \ return R (operator += (dynamic_cast<B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R operator -= (R& x, const R& y) \ { \ return R (operator -= (dynamic_cast<B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R product_eq (R& x, const R& y) \ { \ return R (product_eq (dynamic_cast<B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R quotient_eq (R& x, const R& y) \ { \ return R (quotient_eq (dynamic_cast<B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R operator + (const R& x) \ { \ return R (operator + (dynamic_cast<const B<T>&> (x))); \ } \ inline R operator - (const R& x) \ { \ return R (operator - (dynamic_cast<const B<T>&> (x))); \ } \ inline R operator + (const R& x, const T& y) \ { \ return R (operator + (dynamic_cast<const B<T>&> (x), (y))); \ } \ inline R operator - (const R& x, const T& y) \ { \ return R (operator - (dynamic_cast<const B<T>&> (x), (y))); \ } \ inline R operator * (const R& x, const T& y) \ { \ return R (operator * (dynamic_cast<const B<T>&> (x), (y))); \ } \ inline R operator / (const R& x, const T& y) \ { \ return R (operator / (dynamic_cast<const B<T>&> (x), (y))); \ } \ inline R operator + (const T& x, const R& y) \ { \ return R (operator + ( (x), dynamic_cast<const B<T>&> (y))); \ } \ inline R operator - (const T& x, const R& y) \ { \ return R (operator - ( (x), dynamic_cast<const B<T>&> (y))); \ } \ inline R operator * (const T& x, const R& y) \ { \ return R (operator * ( (x), dynamic_cast<const B<T>&> (y))); \ } \ inline R operator / (const T& x, const R& y) \ { \ return R (operator / ( (x), dynamic_cast<const B<T>&> (y))); \ } \ inline R operator + (const R& x, const R& y) \ { \ return R (operator + (dynamic_cast<const B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R operator - (const R& x, const R& y) \ { \ return R (operator - (dynamic_cast<const B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R product (const R& x, const R& y) \ { \ return R (product (dynamic_cast<const B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } \ inline R quotient (const R& x, const R& y) \ { \ return R (quotient (dynamic_cast<const B<T>&> (x), \ dynamic_cast<const B<T>&> (y))); \ } // Instantiate all the MArray friends for MArray element type T. #define INSTANTIATE_MARRAY_FRIENDS(T, API) \ template API MArray<T>& operator += (MArray<T>&, const T&); \ template API MArray<T>& operator -= (MArray<T>&, const T&); \ template API MArray<T>& operator *= (MArray<T>&, const T&); \ template API MArray<T>& operator /= (MArray<T>&, const T&); \ template API MArray<T>& operator += (MArray<T>&, const MArray<T>&); \ template API MArray<T>& operator -= (MArray<T>&, const MArray<T>&); \ template API MArray<T>& product_eq (MArray<T>&, const MArray<T>&); \ template API MArray<T>& quotient_eq (MArray<T>&, const MArray<T>&); \ template API MArray<T> operator + (const MArray<T>&); \ template API MArray<T> operator - (const MArray<T>&); \ template API MArray<T> operator + (const MArray<T>&, const T&); \ template API MArray<T> operator - (const MArray<T>&, const T&); \ template API MArray<T> operator * (const MArray<T>&, const T&); \ template API MArray<T> operator / (const MArray<T>&, const T&); \ template API MArray<T> operator + (const T&, const MArray<T>&); \ template API MArray<T> operator - (const T&, const MArray<T>&); \ template API MArray<T> operator * (const T&, const MArray<T>&); \ template API MArray<T> operator / (const T&, const MArray<T>&); \ template API MArray<T> operator + (const MArray<T>&, const MArray<T>&); \ template API MArray<T> operator - (const MArray<T>&, const MArray<T>&); \ template API MArray<T> quotient (const MArray<T>&, const MArray<T>&); \ template API MArray<T> product (const MArray<T>&, const MArray<T>&); // Instantiate all the MDiagArray2 friends for MDiagArray2 element type T. #define INSTANTIATE_MDIAGARRAY2_FRIENDS(T, API) \ template API MDiagArray2<T> operator + (const MDiagArray2<T>&); \ template API MDiagArray2<T> operator - (const MDiagArray2<T>&); \ template API MDiagArray2<T> operator * (const MDiagArray2<T>&, const T&); \ template API MDiagArray2<T> operator / (const MDiagArray2<T>&, const T&); \ template API MDiagArray2<T> operator * (const T&, const MDiagArray2<T>&); \ template API MDiagArray2<T> operator + (const MDiagArray2<T>&, \ const MDiagArray2<T>&); \ template API MDiagArray2<T> operator - (const MDiagArray2<T>&, \ const MDiagArray2<T>&); \ template API MDiagArray2<T> product (const MDiagArray2<T>&, \ const MDiagArray2<T>&); #endif