1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2025 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
|