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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
|
// 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 Mat
//! @{
//! Dense matrix class
template<typename eT>
class Mat : public Base< eT, Mat<eT> >
{
public:
typedef eT elem_type; //!< the type of elements stored in the matrix
typedef typename get_pod_type<eT>::result pod_type; //!< if eT is std::complex<T>, pod_type is T; otherwise pod_type is eT
const uword n_rows; //!< number of rows (read-only)
const uword n_cols; //!< number of columns (read-only)
const uword n_elem; //!< number of elements (read-only)
const uword n_alloc; //!< number of allocated elements (read-only); NOTE: n_alloc can be 0, even if n_elem > 0
const uhword vec_state; //!< 0: matrix layout; 1: column vector layout; 2: row vector layout
const uhword mem_state;
// mem_state = 0: normal matrix which manages its own memory
// mem_state = 1: use auxiliary memory until a size change
// mem_state = 2: use auxiliary memory and don't allow the number of elements to be changed
// mem_state = 3: fixed size (eg. via template based size specification)
arma_aligned const eT* const mem; //!< pointer to the memory used for storing elements (memory is read-only)
protected:
arma_align_mem eT mem_local[ arma_config::mat_prealloc ]; // local storage, for small vectors and matrices
public:
static constexpr bool is_col = false;
static constexpr bool is_row = false;
static constexpr bool is_xvec = false;
inline ~Mat();
inline Mat();
inline explicit Mat(const uword in_rows, const uword in_cols);
inline explicit Mat(const SizeMat& s);
template<typename fill_type> inline Mat(const uword in_rows, const uword in_cols, const fill::fill_class<fill_type>& f);
template<typename fill_type> inline Mat(const SizeMat& s, const fill::fill_class<fill_type>& f);
inline arma_cold Mat(const char* text);
inline arma_cold Mat& operator=(const char* text);
inline arma_cold Mat(const std::string& text);
inline arma_cold Mat& operator=(const std::string& text);
inline Mat(const std::vector<eT>& x);
inline Mat& operator=(const std::vector<eT>& x);
inline Mat(const std::initializer_list<eT>& list);
inline Mat& operator=(const std::initializer_list<eT>& list);
inline Mat(const std::initializer_list< std::initializer_list<eT> >& list);
inline Mat& operator=(const std::initializer_list< std::initializer_list<eT> >& list);
inline Mat(Mat&& m);
inline Mat& operator=(Mat&& m);
inline Mat( eT* aux_mem, const uword aux_n_rows, const uword aux_n_cols, const bool copy_aux_mem = true, const bool strict = false);
inline Mat(const eT* aux_mem, const uword aux_n_rows, const uword aux_n_cols);
inline Mat& operator= (const eT val);
inline Mat& operator+=(const eT val);
inline Mat& operator-=(const eT val);
inline Mat& operator*=(const eT val);
inline Mat& operator/=(const eT val);
inline Mat(const Mat& m);
inline Mat& operator= (const Mat& m);
inline Mat& operator+=(const Mat& m);
inline Mat& operator-=(const Mat& m);
inline Mat& operator*=(const Mat& m);
inline Mat& operator%=(const Mat& m);
inline Mat& operator/=(const Mat& m);
template<typename T1> inline Mat(const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator= (const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator+=(const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator-=(const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator*=(const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator%=(const BaseCube<eT,T1>& X);
template<typename T1> inline Mat& operator/=(const BaseCube<eT,T1>& X);
template<typename T1, typename T2>
inline explicit Mat(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
inline explicit Mat(const subview<eT>& X, const bool use_colmem); // only to be used by the quasi_unwrap class
inline Mat(const subview<eT>& X);
inline Mat& operator= (const subview<eT>& X);
inline Mat& operator+=(const subview<eT>& X);
inline Mat& operator-=(const subview<eT>& X);
inline Mat& operator*=(const subview<eT>& X);
inline Mat& operator%=(const subview<eT>& X);
inline Mat& operator/=(const subview<eT>& X);
inline Mat(const subview_row_strans<eT>& X); // subview_row_strans can only be generated by the Proxy class
inline Mat(const subview_row_htrans<eT>& X); // subview_row_htrans can only be generated by the Proxy class
inline Mat(const xvec_htrans<eT>& X); // xvec_htrans can only be generated by the Proxy class
template<bool do_conj>
inline Mat(const xtrans_mat<eT,do_conj>& X); // xtrans_mat can only be generated by the Proxy class
inline Mat(const subview_cube<eT>& X);
inline Mat& operator= (const subview_cube<eT>& X);
inline Mat& operator+=(const subview_cube<eT>& X);
inline Mat& operator-=(const subview_cube<eT>& X);
inline Mat& operator*=(const subview_cube<eT>& X);
inline Mat& operator%=(const subview_cube<eT>& X);
inline Mat& operator/=(const subview_cube<eT>& X);
inline Mat(const diagview<eT>& X);
inline Mat& operator= (const diagview<eT>& X);
inline Mat& operator+=(const diagview<eT>& X);
inline Mat& operator-=(const diagview<eT>& X);
inline Mat& operator*=(const diagview<eT>& X);
inline Mat& operator%=(const diagview<eT>& X);
inline Mat& operator/=(const diagview<eT>& X);
template<typename T1> inline Mat(const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator= (const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator+=(const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator-=(const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator*=(const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator%=(const subview_elem1<eT,T1>& X);
template<typename T1> inline Mat& operator/=(const subview_elem1<eT,T1>& X);
template<typename T1, typename T2> inline Mat(const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator= (const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator+=(const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator-=(const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator*=(const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator%=(const subview_elem2<eT,T1,T2>& X);
template<typename T1, typename T2> inline Mat& operator/=(const subview_elem2<eT,T1,T2>& X);
// Operators on sparse matrices (and subviews)
template<typename T1> inline explicit Mat(const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator= (const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator+=(const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator-=(const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator*=(const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator%=(const SpBase<eT, T1>& m);
template<typename T1> inline Mat& operator/=(const SpBase<eT, T1>& m);
inline explicit Mat(const SpSubview<eT>& X);
inline Mat& operator= (const SpSubview<eT>& X);
inline explicit Mat(const spdiagview<eT>& X);
inline Mat& operator= (const spdiagview<eT>& X);
inline Mat& operator+=(const spdiagview<eT>& X);
inline Mat& operator-=(const spdiagview<eT>& X);
inline Mat& operator*=(const spdiagview<eT>& X);
inline Mat& operator%=(const spdiagview<eT>& X);
inline Mat& operator/=(const spdiagview<eT>& X);
arma_cold inline mat_injector<Mat> operator<<(const eT val);
arma_cold inline mat_injector<Mat> operator<<(const injector_end_of_row<>& x);
arma_inline subview_row<eT> row(const uword row_num);
arma_inline const subview_row<eT> row(const uword row_num) const;
inline subview_row<eT> operator()(const uword row_num, const span& col_span);
inline const subview_row<eT> operator()(const uword row_num, const span& col_span) const;
arma_inline subview_col<eT> col(const uword col_num);
arma_inline const subview_col<eT> col(const uword col_num) const;
inline subview_col<eT> operator()(const span& row_span, const uword col_num);
inline const subview_col<eT> operator()(const span& row_span, const uword col_num) const;
inline Col<eT> unsafe_col(const uword col_num);
inline const Col<eT> unsafe_col(const uword col_num) const;
arma_inline subview<eT> rows(const uword in_row1, const uword in_row2);
arma_inline const subview<eT> rows(const uword in_row1, const uword in_row2) const;
arma_inline subview<eT> cols(const uword in_col1, const uword in_col2);
arma_inline const subview<eT> cols(const uword in_col1, const uword in_col2) const;
inline subview<eT> rows(const span& row_span);
inline const subview<eT> rows(const span& row_span) const;
arma_inline subview<eT> cols(const span& col_span);
arma_inline const subview<eT> cols(const span& col_span) const;
arma_inline subview<eT> submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2);
arma_inline const subview<eT> submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const;
arma_inline subview<eT> submat(const uword in_row1, const uword in_col1, const SizeMat& s);
arma_inline const subview<eT> submat(const uword in_row1, const uword in_col1, const SizeMat& s) const;
inline subview<eT> submat (const span& row_span, const span& col_span);
inline const subview<eT> submat (const span& row_span, const span& col_span) const;
inline subview<eT> operator()(const span& row_span, const span& col_span);
inline const subview<eT> operator()(const span& row_span, const span& col_span) const;
inline subview<eT> operator()(const uword in_row1, const uword in_col1, const SizeMat& s);
inline const subview<eT> operator()(const uword in_row1, const uword in_col1, const SizeMat& s) const;
inline subview<eT> head_rows(const uword N);
inline const subview<eT> head_rows(const uword N) const;
inline subview<eT> tail_rows(const uword N);
inline const subview<eT> tail_rows(const uword N) const;
inline subview<eT> head_cols(const uword N);
inline const subview<eT> head_cols(const uword N) const;
inline subview<eT> tail_cols(const uword N);
inline const subview<eT> tail_cols(const uword N) const;
template<typename T1> arma_inline subview_elem1<eT,T1> elem(const Base<uword,T1>& a);
template<typename T1> arma_inline const subview_elem1<eT,T1> elem(const Base<uword,T1>& a) const;
template<typename T1> arma_inline subview_elem1<eT,T1> operator()(const Base<uword,T1>& a);
template<typename T1> arma_inline const subview_elem1<eT,T1> operator()(const Base<uword,T1>& a) const;
template<typename T1, typename T2> arma_inline subview_elem2<eT,T1,T2> elem(const Base<uword,T1>& ri, const Base<uword,T2>& ci);
template<typename T1, typename T2> arma_inline const subview_elem2<eT,T1,T2> elem(const Base<uword,T1>& ri, const Base<uword,T2>& ci) const;
template<typename T1, typename T2> arma_inline subview_elem2<eT,T1,T2> submat(const Base<uword,T1>& ri, const Base<uword,T2>& ci);
template<typename T1, typename T2> arma_inline const subview_elem2<eT,T1,T2> submat(const Base<uword,T1>& ri, const Base<uword,T2>& ci) const;
template<typename T1, typename T2> arma_inline subview_elem2<eT,T1,T2> operator()(const Base<uword,T1>& ri, const Base<uword,T2>& ci);
template<typename T1, typename T2> arma_inline const subview_elem2<eT,T1,T2> operator()(const Base<uword,T1>& ri, const Base<uword,T2>& ci) const;
template<typename T1> arma_inline subview_elem2<eT,T1,T1> rows(const Base<uword,T1>& ri);
template<typename T1> arma_inline const subview_elem2<eT,T1,T1> rows(const Base<uword,T1>& ri) const;
template<typename T2> arma_inline subview_elem2<eT,T2,T2> cols(const Base<uword,T2>& ci);
template<typename T2> arma_inline const subview_elem2<eT,T2,T2> cols(const Base<uword,T2>& ci) const;
arma_inline subview_each1< Mat<eT>, 0 > each_col();
arma_inline subview_each1< Mat<eT>, 1 > each_row();
arma_inline const subview_each1< Mat<eT>, 0 > each_col() const;
arma_inline const subview_each1< Mat<eT>, 1 > each_row() const;
template<typename T1> inline subview_each2< Mat<eT>, 0, T1 > each_col(const Base<uword, T1>& indices);
template<typename T1> inline subview_each2< Mat<eT>, 1, T1 > each_row(const Base<uword, T1>& indices);
template<typename T1> inline const subview_each2< Mat<eT>, 0, T1 > each_col(const Base<uword, T1>& indices) const;
template<typename T1> inline const subview_each2< Mat<eT>, 1, T1 > each_row(const Base<uword, T1>& indices) const;
inline const Mat& each_col(const std::function< void( Col<eT>&) >& F);
inline const Mat& each_col(const std::function< void(const Col<eT>&) >& F) const;
inline const Mat& each_row(const std::function< void( Row<eT>&) >& F);
inline const Mat& each_row(const std::function< void(const Row<eT>&) >& F) const;
arma_inline diagview<eT> diag(const sword in_id = 0);
arma_inline const diagview<eT> diag(const sword in_id = 0) 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);
inline void shed_row(const uword row_num);
inline void shed_col(const uword col_num);
inline void shed_rows(const uword in_row1, const uword in_row2);
inline void shed_cols(const uword in_col1, const uword in_col2);
template<typename T1> inline void shed_rows(const Base<uword, T1>& indices);
template<typename T1> inline void shed_cols(const Base<uword, T1>& indices);
inline void insert_rows(const uword row_num, const uword N, const bool set_to_zero = true);
inline void insert_cols(const uword col_num, const uword N, const bool set_to_zero = true);
template<typename T1> inline void insert_rows(const uword row_num, const Base<eT,T1>& X);
template<typename T1> inline void insert_cols(const uword col_num, const Base<eT,T1>& X);
template<typename T1, typename gen_type> inline Mat(const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator= (const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator+=(const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator-=(const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator*=(const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator%=(const Gen<T1, gen_type>& X);
template<typename T1, typename gen_type> inline Mat& operator/=(const Gen<T1, gen_type>& X);
template<typename T1, typename op_type> inline Mat(const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator= (const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator+=(const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator-=(const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator*=(const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator%=(const Op<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator/=(const Op<T1, op_type>& X);
template<typename T1, typename eop_type> inline Mat(const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator= (const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator+=(const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator-=(const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator*=(const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator%=(const eOp<T1, eop_type>& X);
template<typename T1, typename eop_type> inline Mat& operator/=(const eOp<T1, eop_type>& X);
template<typename T1, typename op_type> inline Mat(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator= (const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator+=(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator-=(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator*=(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator%=(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator/=(const mtOp<eT, T1, op_type>& X);
template<typename T1, typename op_type> inline Mat(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator= (const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator+=(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator-=(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator*=(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator%=(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator/=(const CubeToMatOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat(const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator= (const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator+=(const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator-=(const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator*=(const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator%=(const SpToDOp<T1, op_type>& X);
template<typename T1, typename op_type> inline Mat& operator/=(const SpToDOp<T1, op_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator= (const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator+=(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator-=(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator*=(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator%=(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator/=(const Glue<T1, T2, glue_type>& X);
template<typename T1, typename T2> inline Mat& operator+=(const Glue<T1, T2, glue_times>& X);
template<typename T1, typename T2> inline Mat& operator-=(const Glue<T1, T2, glue_times>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator= (const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator+=(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator-=(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator*=(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator%=(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator/=(const eGlue<T1, T2, eglue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat(const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator= (const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator+=(const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator-=(const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator*=(const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator%=(const mtGlue<eT, T1, T2, glue_type>& X);
template<typename T1, typename T2, typename glue_type> inline Mat& operator/=(const mtGlue<eT, T1, T2, glue_type>& X);
arma_inline arma_warn_unused const eT& at_alt (const uword ii) const;
arma_inline arma_warn_unused eT& operator[] (const uword ii);
arma_inline arma_warn_unused const eT& operator[] (const uword ii) const;
arma_inline arma_warn_unused eT& at (const uword ii);
arma_inline arma_warn_unused const eT& at (const uword ii) const;
arma_inline arma_warn_unused eT& operator() (const uword ii);
arma_inline arma_warn_unused const eT& operator() (const uword ii) const;
arma_inline arma_warn_unused eT& at (const uword in_row, const uword in_col);
arma_inline arma_warn_unused const eT& at (const uword in_row, const uword in_col) const;
arma_inline arma_warn_unused eT& operator() (const uword in_row, const uword in_col);
arma_inline arma_warn_unused const eT& operator() (const uword in_row, const uword in_col) const;
arma_inline const Mat& operator++();
arma_inline void operator++(int);
arma_inline const Mat& operator--();
arma_inline void operator--(int);
arma_inline arma_warn_unused bool is_empty() const;
arma_inline arma_warn_unused bool is_vec() const;
arma_inline arma_warn_unused bool is_rowvec() const;
arma_inline arma_warn_unused bool is_colvec() const;
arma_inline arma_warn_unused bool is_square() const;
inline arma_warn_unused bool is_finite() const;
inline arma_warn_unused bool has_inf() const;
inline arma_warn_unused bool has_nan() const;
inline arma_warn_unused bool is_sorted(const char* direction = "ascend") const;
inline arma_warn_unused bool is_sorted(const char* direction, const uword dim) const;
template<typename comparator>
inline arma_warn_unused bool is_sorted_helper(const comparator& comp, const uword dim) const;
arma_inline arma_warn_unused bool in_range(const uword ii) const;
arma_inline arma_warn_unused bool in_range(const span& x ) const;
arma_inline arma_warn_unused bool in_range(const uword in_row, const uword in_col) const;
arma_inline arma_warn_unused bool in_range(const span& row_span, const uword in_col) const;
arma_inline arma_warn_unused bool in_range(const uword in_row, const span& col_span) const;
arma_inline arma_warn_unused bool in_range(const span& row_span, const span& col_span) const;
arma_inline arma_warn_unused bool in_range(const uword in_row, const uword in_col, const SizeMat& s) const;
arma_inline arma_warn_unused eT* colptr(const uword in_col);
arma_inline arma_warn_unused const eT* colptr(const uword in_col) const;
arma_inline arma_warn_unused eT* memptr();
arma_inline arma_warn_unused const eT* memptr() const;
arma_cold inline void impl_print( const std::string& extra_text) const;
arma_cold inline void impl_print(std::ostream& user_stream, const std::string& extra_text) const;
arma_cold inline void impl_raw_print( const std::string& extra_text) const;
arma_cold inline void impl_raw_print(std::ostream& user_stream, const std::string& extra_text) const;
template<typename eT2, typename expr>
inline void copy_size(const Base<eT2,expr>& X);
inline void set_size(const uword in_elem);
inline void set_size(const uword in_rows, const uword in_cols);
inline void set_size(const SizeMat& s);
inline void resize(const uword in_elem);
inline void resize(const uword in_rows, const uword in_cols);
inline void resize(const SizeMat& s);
inline void reshape(const uword in_rows, const uword in_cols);
inline void reshape(const SizeMat& s);
arma_deprecated inline void reshape(const uword in_rows, const uword in_cols, const uword dim); //!< NOTE: don't use this form: it will be removed
template<typename functor> inline const Mat& for_each(functor F);
template<typename functor> inline const Mat& for_each(functor F) const;
template<typename functor> inline const Mat& transform(functor F);
template<typename functor> inline const Mat& imbue(functor F);
inline const Mat& replace(const eT old_val, const eT new_val);
inline const Mat& clean(const pod_type threshold);
inline const Mat& fill(const eT val);
template<typename fill_type>
inline const Mat& fill(const fill::fill_class<fill_type>& f);
inline const Mat& zeros();
inline const Mat& zeros(const uword in_elem);
inline const Mat& zeros(const uword in_rows, const uword in_cols);
inline const Mat& zeros(const SizeMat& s);
inline const Mat& ones();
inline const Mat& ones(const uword in_elem);
inline const Mat& ones(const uword in_rows, const uword in_cols);
inline const Mat& ones(const SizeMat& s);
inline const Mat& randu();
inline const Mat& randu(const uword in_elem);
inline const Mat& randu(const uword in_rows, const uword in_cols);
inline const Mat& randu(const SizeMat& s);
inline const Mat& randn();
inline const Mat& randn(const uword in_elem);
inline const Mat& randn(const uword in_rows, const uword in_cols);
inline const Mat& randn(const SizeMat& s);
inline const Mat& eye();
inline const Mat& eye(const uword in_rows, const uword in_cols);
inline const Mat& eye(const SizeMat& s);
inline arma_cold void reset();
inline arma_cold void soft_reset();
template<typename T1> inline void set_real(const Base<pod_type,T1>& X);
template<typename T1> inline void set_imag(const Base<pod_type,T1>& X);
inline arma_warn_unused eT min() const;
inline arma_warn_unused eT max() const;
inline eT min(uword& index_of_min_val) const;
inline eT max(uword& index_of_max_val) const;
inline eT min(uword& row_of_min_val, uword& col_of_min_val) const;
inline eT max(uword& row_of_max_val, uword& col_of_max_val) const;
inline arma_cold bool save(const std::string name, const file_type type = arma_binary, const bool print_status = true) const;
inline arma_cold bool save(const hdf5_name& spec, const file_type type = hdf5_binary, const bool print_status = true) const;
inline arma_cold bool save(const csv_name& spec, const file_type type = csv_ascii, const bool print_status = true) const;
inline arma_cold bool save( std::ostream& os, const file_type type = arma_binary, const bool print_status = true) const;
inline arma_cold bool load(const std::string name, const file_type type = auto_detect, const bool print_status = true);
inline arma_cold bool load(const hdf5_name& spec, const file_type type = hdf5_binary, const bool print_status = true);
inline arma_cold bool load(const csv_name& spec, const file_type type = csv_ascii, const bool print_status = true);
inline arma_cold bool load( std::istream& is, const file_type type = auto_detect, const bool print_status = true);
inline arma_cold bool quiet_save(const std::string name, const file_type type = arma_binary) const;
inline arma_cold bool quiet_save(const hdf5_name& spec, const file_type type = hdf5_binary) const;
inline arma_cold bool quiet_save(const csv_name& spec, const file_type type = csv_ascii) const;
inline arma_cold bool quiet_save( std::ostream& os, const file_type type = arma_binary) const;
inline arma_cold bool quiet_load(const std::string name, const file_type type = auto_detect);
inline arma_cold bool quiet_load(const hdf5_name& spec, const file_type type = hdf5_binary);
inline arma_cold bool quiet_load(const csv_name& spec, const file_type type = csv_ascii);
inline arma_cold bool quiet_load( std::istream& is, const file_type type = auto_detect);
// for container-like functionality
typedef eT value_type;
typedef uword size_type;
typedef eT* iterator;
typedef const eT* const_iterator;
typedef eT* col_iterator;
typedef const eT* const_col_iterator;
class const_row_iterator;
class row_iterator
{
public:
inline row_iterator();
inline row_iterator(const row_iterator& X);
inline row_iterator(Mat<eT>& in_M, const uword in_row, const uword in_col);
inline arma_warn_unused eT& operator* ();
inline row_iterator& operator++();
inline arma_warn_unused row_iterator operator++(int);
inline row_iterator& operator--();
inline arma_warn_unused row_iterator operator--(int);
inline arma_warn_unused bool operator!=(const row_iterator& X) const;
inline arma_warn_unused bool operator==(const row_iterator& X) const;
inline arma_warn_unused bool operator!=(const const_row_iterator& X) const;
inline arma_warn_unused bool operator==(const const_row_iterator& X) const;
typedef std::bidirectional_iterator_tag iterator_category;
typedef eT value_type;
typedef std::ptrdiff_t difference_type; // TODO: not certain on this one
typedef eT* pointer;
typedef eT& reference;
arma_aligned Mat<eT>* M;
arma_aligned uword current_row;
arma_aligned uword current_col;
};
class const_row_iterator
{
public:
inline const_row_iterator();
inline const_row_iterator(const row_iterator& X);
inline const_row_iterator(const const_row_iterator& X);
inline const_row_iterator(const Mat<eT>& in_M, const uword in_row, const uword in_col);
inline arma_warn_unused const eT& operator*() const;
inline const_row_iterator& operator++();
inline arma_warn_unused const_row_iterator operator++(int);
inline const_row_iterator& operator--();
inline arma_warn_unused const_row_iterator operator--(int);
inline arma_warn_unused bool operator!=(const row_iterator& X) const;
inline arma_warn_unused bool operator==(const row_iterator& X) const;
inline arma_warn_unused bool operator!=(const const_row_iterator& X) const;
inline arma_warn_unused bool operator==(const const_row_iterator& X) const;
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;
arma_aligned const Mat<eT>* M;
arma_aligned uword current_row;
arma_aligned uword current_col;
};
class const_row_col_iterator;
class row_col_iterator
{
public:
inline row_col_iterator();
inline row_col_iterator(const row_col_iterator& in_it);
inline row_col_iterator(Mat<eT>& in_M, const uword row = 0, const uword col = 0);
inline arma_warn_unused eT& operator*();
inline row_col_iterator& operator++();
inline arma_warn_unused row_col_iterator operator++(int);
inline row_col_iterator& operator--();
inline arma_warn_unused row_col_iterator operator--(int);
inline arma_warn_unused uword row() const;
inline arma_warn_unused uword col() const;
inline arma_warn_unused bool operator==(const row_col_iterator& rhs) const;
inline arma_warn_unused bool operator!=(const row_col_iterator& rhs) const;
inline arma_warn_unused bool operator==(const const_row_col_iterator& rhs) const;
inline arma_warn_unused bool operator!=(const const_row_col_iterator& rhs) const;
typedef std::bidirectional_iterator_tag iterator_category;
typedef eT value_type;
typedef std::ptrdiff_t difference_type; // TODO: not certain on this one
typedef eT* pointer;
typedef eT& reference;
arma_aligned Mat<eT>* M;
arma_aligned eT* current_ptr;
arma_aligned uword current_col;
arma_aligned uword current_row;
};
class const_row_col_iterator
{
public:
inline const_row_col_iterator();
inline const_row_col_iterator(const row_col_iterator& in_it);
inline const_row_col_iterator(const const_row_col_iterator& in_it);
inline const_row_col_iterator(const Mat<eT>& in_M, const uword row = 0, const uword col = 0);
inline arma_warn_unused const eT& operator*() const;
inline const_row_col_iterator& operator++();
inline arma_warn_unused const_row_col_iterator operator++(int);
inline const_row_col_iterator& operator--();
inline arma_warn_unused const_row_col_iterator operator--(int);
inline arma_warn_unused uword row() const;
inline arma_warn_unused uword col() const;
inline arma_warn_unused bool operator==(const const_row_col_iterator& rhs) const;
inline arma_warn_unused bool operator!=(const const_row_col_iterator& rhs) const;
inline arma_warn_unused bool operator==(const row_col_iterator& rhs) const;
inline arma_warn_unused bool operator!=(const row_col_iterator& rhs) const;
// So that we satisfy the STL iterator types.
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;
arma_aligned const Mat<eT>* M;
arma_aligned const eT* current_ptr;
arma_aligned uword current_col;
arma_aligned uword current_row;
};
inline iterator begin();
inline const_iterator begin() const;
inline const_iterator cbegin() const;
inline iterator end();
inline const_iterator end() const;
inline const_iterator cend() const;
inline col_iterator begin_col(const uword col_num);
inline const_col_iterator begin_col(const uword col_num) const;
inline col_iterator end_col (const uword col_num);
inline const_col_iterator end_col (const uword col_num) const;
inline row_iterator begin_row(const uword row_num);
inline const_row_iterator begin_row(const uword row_num) const;
inline row_iterator end_row (const uword row_num);
inline const_row_iterator end_row (const uword row_num) const;
inline row_col_iterator begin_row_col();
inline const_row_col_iterator begin_row_col() const;
inline row_col_iterator end_row_col();
inline const_row_col_iterator end_row_col() const;
inline void clear();
inline bool empty() const;
inline uword size() const;
inline eT& front();
inline const eT& front() const;
inline eT& back();
inline const eT& back() const;
inline void swap(Mat& B);
inline void steal_mem(Mat& X); //!< don't use this unless you're writing code internal to Armadillo
inline void steal_mem_col(Mat& X, const uword max_n_rows);
template<uword fixed_n_rows, uword fixed_n_cols> class fixed;
protected:
inline void init_cold();
inline void init_warm(uword in_rows, uword in_cols);
inline arma_cold void init(const std::string& text);
inline void init(const std::initializer_list<eT>& list);
inline void init(const std::initializer_list< std::initializer_list<eT> >& list);
template<typename T1, typename T2>
inline void init(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
inline Mat(const char junk, const eT* aux_mem, const uword aux_n_rows, const uword aux_n_cols);
inline Mat(const arma_vec_indicator&, const uhword in_vec_state);
inline Mat(const arma_vec_indicator&, const uword in_n_rows, const uword in_n_cols, const uhword in_vec_state);
inline Mat(const arma_fixed_indicator&, const uword in_n_rows, const uword in_n_cols, const uhword in_vec_state, const eT* in_mem);
friend class Cube<eT>;
friend class subview_cube<eT>;
friend class glue_join;
friend class op_strans;
friend class op_htrans;
friend class op_resize;
friend class op_mean;
friend class op_max;
friend class op_min;
public:
#ifdef ARMA_EXTRA_MAT_PROTO
#include ARMA_INCFILE_WRAP(ARMA_EXTRA_MAT_PROTO)
#endif
};
template<typename eT>
template<uword fixed_n_rows, uword fixed_n_cols>
class Mat<eT>::fixed : public Mat<eT>
{
private:
static constexpr uword fixed_n_elem = fixed_n_rows * fixed_n_cols;
static constexpr bool use_extra = (fixed_n_elem > arma_config::mat_prealloc);
arma_align_mem eT mem_local_extra[ (use_extra) ? fixed_n_elem : 1 ];
public:
typedef fixed<fixed_n_rows, fixed_n_cols> Mat_fixed_type;
typedef eT elem_type;
typedef typename get_pod_type<eT>::result pod_type;
static constexpr bool is_col = (fixed_n_cols == 1);
static constexpr bool is_row = (fixed_n_rows == 1);
static constexpr bool is_xvec = false;
static const uword n_rows; // value provided below the class definition
static const uword n_cols; // value provided below the class definition
static const uword n_elem; // value provided below the class definition
arma_inline fixed();
arma_inline fixed(const fixed<fixed_n_rows, fixed_n_cols>& X);
template<typename fill_type> inline fixed(const fill::fill_class<fill_type>& f);
template<typename T1> inline fixed(const Base<eT,T1>& A);
template<typename T1, typename T2> inline fixed(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
inline fixed(const eT* aux_mem);
inline fixed(const char* text);
inline fixed(const std::string& text);
using Mat<eT>::operator=;
using Mat<eT>::operator();
inline fixed(const std::initializer_list<eT>& list);
inline Mat& operator=(const std::initializer_list<eT>& list);
inline fixed(const std::initializer_list< std::initializer_list<eT> >& list);
inline Mat& operator=(const std::initializer_list< std::initializer_list<eT> >& list);
arma_inline Mat& operator=(const fixed<fixed_n_rows, fixed_n_cols>& X);
#if defined(ARMA_GOOD_COMPILER)
template<typename T1, typename eop_type> inline Mat& operator=(const eOp<T1, eop_type>& X);
template<typename T1, typename T2, typename eglue_type> inline Mat& operator=(const eGlue<T1, T2, eglue_type>& X);
#endif
arma_inline const Op< Mat_fixed_type, op_htrans > t() const;
arma_inline const Op< Mat_fixed_type, op_htrans > ht() const;
arma_inline const Op< Mat_fixed_type, op_strans > st() const;
arma_inline arma_warn_unused const eT& at_alt (const uword i) const;
arma_inline arma_warn_unused eT& operator[] (const uword i);
arma_inline arma_warn_unused const eT& operator[] (const uword i) const;
arma_inline arma_warn_unused eT& at (const uword i);
arma_inline arma_warn_unused const eT& at (const uword i) const;
arma_inline arma_warn_unused eT& operator() (const uword i);
arma_inline arma_warn_unused const eT& operator() (const uword i) const;
arma_inline arma_warn_unused eT& at (const uword in_row, const uword in_col);
arma_inline arma_warn_unused const eT& at (const uword in_row, const uword in_col) const;
arma_inline arma_warn_unused eT& operator() (const uword in_row, const uword in_col);
arma_inline arma_warn_unused const eT& operator() (const uword in_row, const uword in_col) const;
arma_inline arma_warn_unused eT* colptr(const uword in_col);
arma_inline arma_warn_unused const eT* colptr(const uword in_col) const;
arma_inline arma_warn_unused eT* memptr();
arma_inline arma_warn_unused const eT* memptr() const;
arma_inline arma_warn_unused bool is_vec() const;
inline const Mat<eT>& fill(const eT val);
inline const Mat<eT>& zeros();
inline const Mat<eT>& ones();
};
// these definitions are outside of the class due to bizarre C++ rules;
// C++17 has inline variables to address this shortcoming
template<typename eT>
template<uword fixed_n_rows, uword fixed_n_cols>
const uword Mat<eT>::fixed<fixed_n_rows, fixed_n_cols>::n_rows = fixed_n_rows;
template<typename eT>
template<uword fixed_n_rows, uword fixed_n_cols>
const uword Mat<eT>::fixed<fixed_n_rows, fixed_n_cols>::n_cols = fixed_n_cols;
template<typename eT>
template<uword fixed_n_rows, uword fixed_n_cols>
const uword Mat<eT>::fixed<fixed_n_rows, fixed_n_cols>::n_elem = fixed_n_rows * fixed_n_cols;
class Mat_aux
{
public:
template<typename eT> inline static void prefix_pp(Mat<eT>& x);
template<typename T> inline static void prefix_pp(Mat< std::complex<T> >& x);
template<typename eT> inline static void postfix_pp(Mat<eT>& x);
template<typename T> inline static void postfix_pp(Mat< std::complex<T> >& x);
template<typename eT> inline static void prefix_mm(Mat<eT>& x);
template<typename T> inline static void prefix_mm(Mat< std::complex<T> >& x);
template<typename eT> inline static void postfix_mm(Mat<eT>& x);
template<typename T> inline static void postfix_mm(Mat< std::complex<T> >& x);
template<typename eT, typename T1> inline static void set_real(Mat<eT>& out, const Base<eT,T1>& X);
template<typename T, typename T1> inline static void set_real(Mat< std::complex<T> >& out, const Base< T,T1>& X);
template<typename eT, typename T1> inline static void set_imag(Mat<eT>& out, const Base<eT,T1>& X);
template<typename T, typename T1> inline static void set_imag(Mat< std::complex<T> >& out, const Base< T,T1>& X);
};
//! @}
|
