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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------------
//! \addtogroup SpSubview
//! @{
template<typename eT>
class SpSubview : public SpBase< eT, SpSubview<eT> >
{
public:
const SpMat<eT>& m;
typedef eT elem_type;
typedef typename get_pod_type<elem_type>::result pod_type;
static constexpr bool is_row = false;
static constexpr bool is_col = false;
static constexpr bool is_xvec = false;
const uword aux_row1;
const uword aux_col1;
const uword n_rows;
const uword n_cols;
const uword n_elem;
const uword n_nonzero;
protected:
inline SpSubview(const SpMat<eT>& in_m, const uword in_row1, const uword in_col1, const uword in_n_rows, const uword in_n_cols);
public:
inline ~SpSubview();
inline SpSubview() = delete;
inline SpSubview(const SpSubview& in);
inline SpSubview( SpSubview&& in);
inline const SpSubview& operator+= (const eT val);
inline const SpSubview& operator-= (const eT val);
inline const SpSubview& operator*= (const eT val);
inline const SpSubview& operator/= (const eT val);
inline const SpSubview& operator=(const SpSubview& x);
template<typename T1> inline const SpSubview& operator= (const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator+=(const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator-=(const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator*=(const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator%=(const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator/=(const Base<eT, T1>& x);
template<typename T1> inline const SpSubview& operator_equ_common(const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator= (const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator+=(const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator-=(const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator*=(const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator%=(const SpBase<eT, T1>& x);
template<typename T1> inline const SpSubview& operator/=(const SpBase<eT, T1>& x);
/*
inline static void extract(SpMat<eT>& out, const SpSubview& in);
inline static void plus_inplace(Mat<eT>& out, const subview& in);
inline static void minus_inplace(Mat<eT>& out, const subview& in);
inline static void schur_inplace(Mat<eT>& out, const subview& in);
inline static void div_inplace(Mat<eT>& out, const subview& in);
*/
template<typename functor> inline void for_each(functor F);
template<typename functor> inline void for_each(functor F) const;
template<typename functor> inline void transform(functor F);
inline void replace(const eT old_val, const eT new_val);
inline void clean(const pod_type threshold);
inline void clamp(const eT min_val, const eT max_val);
inline void fill(const eT val);
inline void zeros();
inline void ones();
inline void eye();
inline void randu();
inline void randn();
arma_warn_unused inline SpSubview_MapMat_val<eT> operator[](const uword i);
arma_warn_unused inline eT operator[](const uword i) const;
arma_warn_unused inline SpSubview_MapMat_val<eT> operator()(const uword i);
arma_warn_unused inline eT operator()(const uword i) const;
arma_warn_unused inline SpSubview_MapMat_val<eT> operator()(const uword in_row, const uword in_col);
arma_warn_unused inline eT operator()(const uword in_row, const uword in_col) const;
arma_warn_unused inline SpSubview_MapMat_val<eT> at(const uword i);
arma_warn_unused inline eT at(const uword i) const;
arma_warn_unused inline SpSubview_MapMat_val<eT> at(const uword in_row, const uword in_col);
arma_warn_unused inline eT at(const uword in_row, const uword in_col) const;
inline bool check_overlap(const SpSubview& x) const;
arma_warn_unused inline bool is_vec() const;
inline SpSubview_row<eT> row(const uword row_num);
inline const SpSubview_row<eT> row(const uword row_num) const;
inline SpSubview_col<eT> col(const uword col_num);
inline const SpSubview_col<eT> col(const uword col_num) const;
inline SpSubview rows(const uword in_row1, const uword in_row2);
inline const SpSubview rows(const uword in_row1, const uword in_row2) const;
inline SpSubview cols(const uword in_col1, const uword in_col2);
inline const SpSubview cols(const uword in_col1, const uword in_col2) const;
inline SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2);
inline const SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const;
inline SpSubview submat(const span& row_span, const span& col_span);
inline const SpSubview submat(const span& row_span, const span& col_span) const;
inline SpSubview operator()(const uword row_num, const span& col_span);
inline const SpSubview operator()(const uword row_num, const span& col_span) const;
inline SpSubview operator()(const span& row_span, const uword col_num);
inline const SpSubview operator()(const span& row_span, const uword col_num) const;
inline SpSubview operator()(const span& row_span, const span& col_span);
inline const SpSubview operator()(const span& row_span, const span& col_span) const;
inline void swap_rows(const uword in_row1, const uword in_row2);
inline void swap_cols(const uword in_col1, const uword in_col2);
// Forward declarations.
class iterator_base;
class const_iterator;
class iterator;
class const_row_iterator;
class row_iterator;
// Similar to SpMat iterators but automatically iterates past and ignores values not in the subview.
class iterator_base
{
public:
inline iterator_base(const SpSubview& in_M);
inline iterator_base(const SpSubview& in_M, const uword col, const uword pos);
arma_inline uword col() const { return internal_col; }
arma_inline uword pos() const { return internal_pos; }
arma_aligned const SpSubview* M;
arma_aligned uword internal_col;
arma_aligned uword internal_pos;
typedef std::bidirectional_iterator_tag iterator_category;
typedef eT value_type;
typedef std::ptrdiff_t difference_type; // TODO: not certain on this one
typedef const eT* pointer;
typedef const eT& reference;
};
class const_iterator : public iterator_base
{
public:
inline const_iterator(const SpSubview& in_M, uword initial_pos = 0);
inline const_iterator(const SpSubview& in_M, uword in_row, uword in_col);
inline const_iterator(const SpSubview& in_M, uword in_row, uword in_col, uword in_pos, uword skip_pos);
inline const_iterator(const const_iterator& other);
arma_inline eT operator*() const;
// Don't hold location internally; call "dummy" methods to get that information.
arma_inline uword row() const { return iterator_base::M->m.row_indices[iterator_base::internal_pos + skip_pos] - iterator_base::M->aux_row1; }
arma_hot inline const_iterator& operator++();
arma_warn_unused inline const_iterator operator++(int);
arma_hot inline const_iterator& operator--();
arma_warn_unused inline const_iterator operator--(int);
arma_hot inline bool operator!=(const const_iterator& rhs) const;
arma_hot inline bool operator==(const const_iterator& rhs) const;
arma_hot inline bool operator!=(const typename SpMat<eT>::const_iterator& rhs) const;
arma_hot inline bool operator==(const typename SpMat<eT>::const_iterator& rhs) const;
arma_hot inline bool operator!=(const const_row_iterator& rhs) const;
arma_hot inline bool operator==(const const_row_iterator& rhs) const;
arma_hot inline bool operator!=(const typename SpMat<eT>::const_row_iterator& rhs) const;
arma_hot inline bool operator==(const typename SpMat<eT>::const_row_iterator& rhs) const;
arma_aligned uword skip_pos; // not used in row_iterator or const_row_iterator
};
class iterator : public const_iterator
{
public:
inline iterator(SpSubview& in_M, const uword initial_pos = 0) : const_iterator(in_M, initial_pos) { }
inline iterator(SpSubview& in_M, const uword in_row, const uword in_col) : const_iterator(in_M, in_row, in_col) { }
inline iterator(SpSubview& in_M, const uword in_row, const uword in_col, const uword in_pos, const uword in_skip_pos) : const_iterator(in_M, in_row, in_col, in_pos, in_skip_pos) { }
inline iterator(const iterator& other) : const_iterator(other) { }
arma_hot inline SpValProxy< SpSubview<eT> > operator*();
// overloads needed for return type correctness
arma_hot inline iterator& operator++();
arma_warn_unused inline iterator operator++(int);
arma_hot inline iterator& operator--();
arma_warn_unused inline iterator operator--(int);
// This has a different value_type than iterator_base.
typedef SpValProxy< SpSubview<eT> > value_type;
typedef const SpValProxy< SpSubview<eT> >* pointer;
typedef const SpValProxy< SpSubview<eT> >& reference;
};
class const_row_iterator : public iterator_base
{
public:
inline const_row_iterator();
inline const_row_iterator(const SpSubview& in_M, uword initial_pos = 0);
inline const_row_iterator(const SpSubview& in_M, uword in_row, uword in_col);
inline const_row_iterator(const const_row_iterator& other);
arma_hot inline const_row_iterator& operator++();
arma_warn_unused inline const_row_iterator operator++(int);
arma_hot inline const_row_iterator& operator--();
arma_warn_unused inline const_row_iterator operator--(int);
uword internal_row; // Hold row internally because we use internal_pos differently.
uword actual_pos; // Actual position in subview's parent matrix.
arma_inline eT operator*() const { return iterator_base::M->m.values[actual_pos]; }
arma_inline uword row() const { return internal_row; }
arma_hot inline bool operator!=(const const_iterator& rhs) const;
arma_hot inline bool operator==(const const_iterator& rhs) const;
arma_hot inline bool operator!=(const typename SpMat<eT>::const_iterator& rhs) const;
arma_hot inline bool operator==(const typename SpMat<eT>::const_iterator& rhs) const;
arma_hot inline bool operator!=(const const_row_iterator& rhs) const;
arma_hot inline bool operator==(const const_row_iterator& rhs) const;
arma_hot inline bool operator!=(const typename SpMat<eT>::const_row_iterator& rhs) const;
arma_hot inline bool operator==(const typename SpMat<eT>::const_row_iterator& rhs) const;
};
class row_iterator : public const_row_iterator
{
public:
inline row_iterator(SpSubview& in_M, uword initial_pos = 0) : const_row_iterator(in_M, initial_pos) { }
inline row_iterator(SpSubview& in_M, uword in_row, uword in_col) : const_row_iterator(in_M, in_row, in_col) { }
inline row_iterator(const row_iterator& other) : const_row_iterator(other) { }
arma_hot inline SpValProxy< SpSubview<eT> > operator*();
// overloads needed for return type correctness
arma_hot inline row_iterator& operator++();
arma_warn_unused inline row_iterator operator++(int);
arma_hot inline row_iterator& operator--();
arma_warn_unused inline row_iterator operator--(int);
// This has a different value_type than iterator_base.
typedef SpValProxy< SpSubview<eT> > value_type;
typedef const SpValProxy< SpSubview<eT> >* pointer;
typedef const SpValProxy< SpSubview<eT> >& reference;
};
inline iterator begin();
inline const_iterator begin() const;
inline const_iterator cbegin() const;
inline iterator begin_col(const uword col_num);
inline const_iterator begin_col(const uword col_num) const;
inline row_iterator begin_row(const uword row_num = 0);
inline const_row_iterator begin_row(const uword row_num = 0) const;
inline iterator end();
inline const_iterator end() const;
inline const_iterator cend() const;
inline row_iterator end_row();
inline const_row_iterator end_row() const;
inline row_iterator end_row(const uword row_num);
inline const_row_iterator end_row(const uword row_num) const;
//! don't use this unless you're writing internal Armadillo code
arma_inline bool is_alias(const SpMat<eT>& X) const;
private:
friend class SpMat<eT>;
friend class SpSubview_col<eT>;
friend class SpSubview_row<eT>;
friend class SpValProxy< SpSubview<eT> >; // allow SpValProxy to call insert_element() and delete_element()
arma_warn_unused inline eT& insert_element(const uword in_row, const uword in_col, const eT in_val = eT(0));
inline void delete_element(const uword in_row, const uword in_col);
inline void invalidate_cache() const;
};
template<typename eT>
class SpSubview_col : public SpSubview<eT>
{
public:
typedef eT elem_type;
typedef typename get_pod_type<elem_type>::result pod_type;
static constexpr bool is_row = false;
static constexpr bool is_col = true;
static constexpr bool is_xvec = false;
inline void operator= (const SpSubview<eT>& x);
inline void operator= (const SpSubview_col& x);
template<typename T1> inline void operator= (const SpBase<eT,T1>& x);
template<typename T1> inline void operator= (const Base<eT,T1>& x);
arma_warn_unused inline const SpOp<SpSubview_col<eT>,spop_htrans> t() const;
arma_warn_unused inline const SpOp<SpSubview_col<eT>,spop_htrans> ht() const;
arma_warn_unused inline const SpOp<SpSubview_col<eT>,spop_strans> st() const;
protected:
inline SpSubview_col(const SpMat<eT>& in_m, const uword in_col);
inline SpSubview_col(const SpMat<eT>& in_m, const uword in_col, const uword in_row1, const uword in_n_rows);
inline SpSubview_col() = delete;
private:
friend class SpMat<eT>;
friend class SpSubview<eT>;
};
template<typename eT>
class SpSubview_row : public SpSubview<eT>
{
public:
typedef eT elem_type;
typedef typename get_pod_type<elem_type>::result pod_type;
static constexpr bool is_row = true;
static constexpr bool is_col = false;
static constexpr bool is_xvec = false;
inline void operator= (const SpSubview<eT>& x);
inline void operator= (const SpSubview_row& x);
template<typename T1> inline void operator= (const SpBase<eT,T1>& x);
template<typename T1> inline void operator= (const Base<eT,T1>& x);
arma_warn_unused inline const SpOp<SpSubview_row<eT>,spop_htrans> t() const;
arma_warn_unused inline const SpOp<SpSubview_row<eT>,spop_htrans> ht() const;
arma_warn_unused inline const SpOp<SpSubview_row<eT>,spop_strans> st() const;
protected:
inline SpSubview_row(const SpMat<eT>& in_m, const uword in_row);
inline SpSubview_row(const SpMat<eT>& in_m, const uword in_row, const uword in_col1, const uword in_n_cols);
inline SpSubview_row() = delete;
private:
friend class SpMat<eT>;
friend class SpSubview<eT>;
};
//! @}
|
