File: intNDArray.h

package info (click to toggle)
octave 10.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 145,484 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 660; xml: 192
file content (143 lines) | stat: -rw-r--r-- 4,299 bytes parent folder | download
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
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2004-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_intNDArray_h)
#define octave_intNDArray_h 1

#include "octave-config.h"

#include "intNDArray-fwd.h"
#include "mx-fwd.h"
#include "MArray.h"
#include "boolNDArray.h"

template <typename T>
class intNDArray : public MArray<T>
{
public:

  using typename MArray<T>::element_type;

  intNDArray () = default;

  intNDArray (const intNDArray<T>& a) = default;

  intNDArray& operator = (const intNDArray<T>& a) = default;

  ~intNDArray () = default;

  intNDArray (T val) : MArray<T> (dim_vector (1, 1), val) { }

  intNDArray (const dim_vector& dv) : MArray<T> (dv) { }

  intNDArray (const dim_vector& dv, T val)
    : MArray<T> (dv, val) { }

  template <typename U>
  intNDArray (const Array<U>& a) : MArray<T> (a) { }

  template <typename U>
  intNDArray (const MArray<U>& a) : MArray<T> (a) { }

  template <typename U>
  intNDArray (const intNDArray<U>& a) : MArray<T> (a) { }

  OCTAVE_API boolNDArray operator ! () const;

  bool any_element_is_nan () const { return false; }
  OCTAVE_API bool any_element_not_one_or_zero () const;

  OCTAVE_API intNDArray diag (octave_idx_type k = 0) const;

  OCTAVE_API intNDArray diag (octave_idx_type m, octave_idx_type n) const;

  intNDArray& changesign ()
  {
    MArray<T>::changesign ();
    return *this;
  }

  // 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 intNDArray max (int dim = -1) const;
  OCTAVE_API intNDArray
  max (Array<octave_idx_type>& index, int dim = -1) const;
  OCTAVE_API intNDArray min (int dim = -1) const;
  OCTAVE_API intNDArray
  min (Array<octave_idx_type>& index, int dim = -1) const;

  OCTAVE_API intNDArray cummax (int dim = -1) const;
  OCTAVE_API intNDArray
  cummax (Array<octave_idx_type>& index, int dim = -1) const;
  OCTAVE_API intNDArray cummin (int dim = -1) const;
  OCTAVE_API intNDArray
  cummin (Array<octave_idx_type>& index, int dim = -1) const;

  OCTAVE_API intNDArray prod (int dim) const;
  OCTAVE_API intNDArray sum (int dim) const;
  OCTAVE_API NDArray dsum (int dim) const;
  OCTAVE_API intNDArray cumsum (int dim) const;

  OCTAVE_API intNDArray diff (octave_idx_type order = 1, int dim = -1) const;

  OCTAVE_API intNDArray abs () const;
  OCTAVE_API intNDArray signum () const;

  intNDArray squeeze () const
  { return intNDArray<T> (MArray<T>::squeeze ()); }

  intNDArray transpose () const
  { return intNDArray<T> (MArray<T>::transpose ()); }

  OCTAVE_API intNDArray
  concat (const intNDArray<T>& rb, const Array<octave_idx_type>& ra_idx);

  OCTAVE_API intNDArray&
  insert (const intNDArray<T>& a, octave_idx_type r, octave_idx_type c);
  OCTAVE_API intNDArray&
  insert (const intNDArray<T>& a, const Array<octave_idx_type>& ra_idx);

  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

template <typename T>
OCTAVE_API std::ostream&
operator << (std::ostream& os, const intNDArray<T>& a);

template <typename T>
OCTAVE_API std::istream&
operator >> (std::istream& is, intNDArray<T>& a);

#endif