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
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-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_dNDArray_h)
#define octave_dNDArray_h 1
#include "octave-config.h"
#include "intNDArray-fwd.h"
#include "MArray.h"
#include "bsxfun-decl.h"
#include "mx-defs.h"
#include "mx-op-decl.h"
class OCTAVE_API NDArray : public MArray<double>
{
public:
NDArray () : MArray<double> () { }
NDArray (const dim_vector& dv) : MArray<double> (dv) { }
NDArray (const dim_vector& dv, double val)
: MArray<double> (dv, val) { }
NDArray (const NDArray& a) : MArray<double> (a) { }
NDArray (const Array<octave_idx_type>& a, bool zero_based = false,
bool negative_to_nan = false);
template <typename U>
NDArray (const MArray<U>& a) : MArray<double> (a) { }
template <typename U>
NDArray (const Array<U>& a) : MArray<double> (a) { }
template <typename U>
explicit NDArray (const intNDArray<U>& a) : MArray<double> (a) { }
NDArray (const charNDArray&);
NDArray& operator = (const NDArray& a)
{
MArray<double>::operator = (a);
return *this;
}
~NDArray () = default;
// unary operations
OCTAVE_API boolNDArray operator ! () const;
OCTAVE_API bool any_element_is_negative (bool = false) const;
OCTAVE_API bool any_element_is_positive (bool = false) const;
OCTAVE_API bool any_element_is_nan () const;
OCTAVE_API bool any_element_is_inf_or_nan () const;
OCTAVE_API bool any_element_not_one_or_zero () const;
OCTAVE_API bool all_elements_are_zero () const;
OCTAVE_API bool all_elements_are_int_or_inf_or_nan () const;
OCTAVE_API bool all_integers (double& max_val, double& min_val) const;
OCTAVE_API bool all_integers () const;
OCTAVE_API bool too_large_for_float () const;
// FIXME: this is not quite the right thing.
OCTAVE_API boolNDArray all (int dim = -1) const;
OCTAVE_API boolNDArray any (int dim = -1) const;
OCTAVE_API NDArray cumprod (int dim = -1) const;
OCTAVE_API NDArray cumsum (int dim = -1) const;
OCTAVE_API NDArray prod (int dim = -1) const;
OCTAVE_API NDArray sum (int dim = -1) const;
OCTAVE_API NDArray xsum (int dim = -1) const;
OCTAVE_API NDArray sumsq (int dim = -1) const;
OCTAVE_API NDArray
concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx);
OCTAVE_API ComplexNDArray
concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx);
OCTAVE_API charNDArray
concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx);
OCTAVE_API NDArray max (int dim = -1) const;
OCTAVE_API NDArray max (Array<octave_idx_type>& index, int dim = -1) const;
OCTAVE_API NDArray min (int dim = -1) const;
OCTAVE_API NDArray min (Array<octave_idx_type>& index, int dim = -1) const;
OCTAVE_API NDArray cummax (int dim = -1) const;
OCTAVE_API NDArray
cummax (Array<octave_idx_type>& index, int dim = -1) const;
OCTAVE_API NDArray cummin (int dim = -1) const;
OCTAVE_API NDArray
cummin (Array<octave_idx_type>& index, int dim = -1) const;
OCTAVE_API NDArray diff (octave_idx_type order = 1, int dim = -1) const;
OCTAVE_API NDArray&
insert (const NDArray& a, octave_idx_type r, octave_idx_type c);
OCTAVE_API NDArray&
insert (const NDArray& a, const Array<octave_idx_type>& ra_idx);
OCTAVE_API NDArray abs () const;
OCTAVE_API boolNDArray isnan () const;
OCTAVE_API boolNDArray isinf () const;
OCTAVE_API boolNDArray isfinite () const;
OCTAVE_API ComplexNDArray fourier (int dim = 1) const;
OCTAVE_API ComplexNDArray ifourier (int dim = 1) const;
OCTAVE_API ComplexNDArray fourier2d () const;
OCTAVE_API ComplexNDArray ifourier2d () const;
OCTAVE_API ComplexNDArray fourierNd () const;
OCTAVE_API ComplexNDArray ifourierNd () const;
friend OCTAVE_API NDArray real (const ComplexNDArray& a);
friend OCTAVE_API NDArray imag (const ComplexNDArray& a);
friend class ComplexNDArray;
NDArray squeeze () const { return MArray<double>::squeeze (); }
static OCTAVE_API void
increment_index (Array<octave_idx_type>& ra_idx,
const dim_vector& dimensions, int start_dimension = 0);
static OCTAVE_API octave_idx_type
compute_index (Array<octave_idx_type>& ra_idx, const dim_vector& dimensions);
// i/o
friend OCTAVE_API std::ostream&
operator << (std::ostream& os, const NDArray& a);
friend OCTAVE_API std::istream& operator >> (std::istream& is, NDArray& a);
OCTAVE_API NDArray diag (octave_idx_type k = 0) const;
OCTAVE_API NDArray diag (octave_idx_type m, octave_idx_type n) const;
NDArray& changesign ()
{
MArray<double>::changesign ();
return *this;
}
};
// Publish externally used friend functions.
extern OCTAVE_API NDArray real (const ComplexNDArray& a);
extern OCTAVE_API NDArray imag (const ComplexNDArray& a);
MINMAX_DECLS (NDArray, double, OCTAVE_API)
NDS_CMP_OP_DECLS (NDArray, double, OCTAVE_API)
NDS_BOOL_OP_DECLS (NDArray, double, OCTAVE_API)
SND_CMP_OP_DECLS (double, NDArray, OCTAVE_API)
SND_BOOL_OP_DECLS (double, NDArray, OCTAVE_API)
NDND_CMP_OP_DECLS (NDArray, NDArray, OCTAVE_API)
NDND_BOOL_OP_DECLS (NDArray, NDArray, OCTAVE_API)
MARRAY_FORWARD_DEFS (MArray, NDArray, double)
BSXFUN_STDOP_DECLS (NDArray, OCTAVE_API)
BSXFUN_STDREL_DECLS (NDArray, OCTAVE_API)
BSXFUN_OP_DECL (pow, NDArray, OCTAVE_API)
BSXFUN_OP2_DECL (pow, ComplexNDArray, ComplexNDArray,
NDArray, OCTAVE_API)
BSXFUN_OP2_DECL (pow, ComplexNDArray, NDArray,
ComplexNDArray, OCTAVE_API)
#endif
|