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
|
////////////////////////////////////////////////////////////////////////
//
// 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_DiagArray2_h)
#define octave_DiagArray2_h 1
#include "octave-config.h"
#include <cstdlib>
#include "Array.h"
// Array<T> is inherited privately so that some methods, like index, don't
// produce unexpected results.
template <typename T>
class OCTAVE_API DiagArray2 : protected Array<T>
{
protected:
octave_idx_type m_d1, m_d2;
public:
using typename Array<T>::element_type;
DiagArray2 ()
: Array<T> (), m_d1 (0), m_d2 (0) { }
DiagArray2 (octave_idx_type r, octave_idx_type c)
: Array<T> (dim_vector (std::min (r, c), 1)), m_d1 (r), m_d2 (c) { }
DiagArray2 (octave_idx_type r, octave_idx_type c, const T& val)
: Array<T> (dim_vector (std::min (r, c), 1), val), m_d1 (r), m_d2 (c) { }
explicit DiagArray2 (const Array<T>& a)
: Array<T> (a.as_column ()), m_d1 (a.numel ()), m_d2 (a.numel ()) { }
DiagArray2 (const Array<T>& a, octave_idx_type r, octave_idx_type c);
DiagArray2 (const DiagArray2<T>& a)
: Array<T> (a), m_d1 (a.m_d1), m_d2 (a.m_d2) { }
template <typename U>
DiagArray2 (const DiagArray2<U>& a)
: Array<T> (a.extract_diag ()), m_d1 (a.dim1 ()), m_d2 (a.dim2 ()) { }
~DiagArray2 () = default;
DiagArray2<T>& operator = (const DiagArray2<T>& a)
{
if (this != &a)
{
Array<T>::operator = (a);
m_d1 = a.m_d1;
m_d2 = a.m_d2;
}
return *this;
}
octave_idx_type dim1 () const { return m_d1; }
octave_idx_type dim2 () const { return m_d2; }
octave_idx_type rows () const { return dim1 (); }
octave_idx_type cols () const { return dim2 (); }
octave_idx_type columns () const { return dim2 (); }
octave_idx_type diag_length () const { return Array<T>::numel (); }
// FIXME: a dangerous ambiguity?
octave_idx_type length () const { return Array<T>::numel (); }
octave_idx_type nelem () const { return dim1 () * dim2 (); }
octave_idx_type numel () const { return nelem (); }
std::size_t byte_size () const { return Array<T>::byte_size (); }
dim_vector dims () const { return dim_vector (m_d1, m_d2); }
bool isempty () const { return numel () == 0; }
int ndims () const { return 2; }
OCTAVE_API Array<T> extract_diag (octave_idx_type k = 0) const;
DiagArray2<T> build_diag_matrix () const
{
return DiagArray2<T> (array_value ());
}
// Warning: the non-const two-index versions will silently ignore assignments
// to off-diagonal elements.
T elem (octave_idx_type r, octave_idx_type c) const
{
return (r == c) ? Array<T>::elem (r) : T (0);
}
OCTAVE_API T& elem (octave_idx_type r, octave_idx_type c);
T dgelem (octave_idx_type i) const
{ return Array<T>::elem (i); }
T& dgelem (octave_idx_type i)
{ return Array<T>::elem (i); }
T checkelem (octave_idx_type r, octave_idx_type c) const
{ return check_idx (r, c) ? elem (r, c) : T (0); }
T operator () (octave_idx_type r, octave_idx_type c) const
{
return elem (r, c);
}
T& checkelem (octave_idx_type r, octave_idx_type c);
T& operator () (octave_idx_type r, octave_idx_type c)
{
return elem (r, c);
}
// No checking.
T xelem (octave_idx_type r, octave_idx_type c) const
{
return (r == c) ? Array<T>::xelem (r) : T (0);
}
T& dgxelem (octave_idx_type i)
{ return Array<T>::xelem (i); }
T dgxelem (octave_idx_type i) const
{ return Array<T>::xelem (i); }
OCTAVE_API void resize (octave_idx_type n, octave_idx_type m, const T& rfv);
void resize (octave_idx_type n, octave_idx_type m)
{
resize (n, m, Array<T>::resize_fill_value ());
}
OCTAVE_API DiagArray2<T> transpose () const;
OCTAVE_API DiagArray2<T> hermitian (T (*fcn) (const T&) = nullptr) const;
OCTAVE_API Array<T> array_value () const;
const T * data () const { return Array<T>::data (); }
T * rwdata () { return Array<T>::rwdata (); }
inline T * fortran_vec () { return rwdata (); }
void print_info (std::ostream& os, const std::string& prefix) const
{ Array<T>::print_info (os, prefix); }
private:
bool check_idx (octave_idx_type r, octave_idx_type c) const;
};
#endif
|
