Mercurial > hg > octave-nkf
annotate liboctave/dNDArray.h @ 14557:e8e86ae3abbc
make diag (x, m, n) return a proper diagonal matrix object (bug #36099)
* Array.h, Array.cc (Array<T>::diag (octave_idx_type, octave_idx_type)
const): New function.
* CMatrix.h, CMatrix.cc (ComplexMatrix::diag (octave_idx_type,
octave_idx_type) const): New function.
* dMatrix.h, dMatrix.cc (Matrix::diag (octave_idx_type,
octave_idx_type) const): New function.
* fCMatrix.h, fCMatrix.cc (FloatComplexMatrix::diag (octave_idx_type,
octave_idx_type) const): New function.
* fMatrix.h, fMatrix.cc (FloatMatrix::diag (octave_idx_type,
octave_idx_type) const): New function.
* CNDArray.cc, CNDArray.h (ComplexNDArray::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* boolNDArray.cc, boolNDArray.h (boolNDArray::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* chNDArray.cc, chNDArray.h (charNDArray::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* dNDArray.cc, dNDArray.h (NDArray::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* fCNDArray.cc, fCNDArray.h (FloatComplexNDArray::diag
(octave_idx_type, octave_idx_type) const): New forwarding function.
* fNDArray.cc, fNDArray.h (FloatNDArray::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* intNDArray.cc, intNDArray.h (intNDArray<T>::diag (octave_idx_type,
octave_idx_type) const): New forwarding function.
* Cell.cc, Cell.h (Cell::diag (octave_idx_type, octave_idx_type)
const): New function.
* ov.h (octave_value::diag (octave_idx_type, octave_idx_type)):
New function.
* ov-base.h, ov-base.cc (octave_base_value::diag (octave_idx_type,
octave_idx_type) const): New virtual function and default implementation.
* ov-base-mat.h (octave_base_matrix<T>::diag (octave_idx_type,
octave_idx_type) const): New function.
* ov-base-scalar.cc, ov-base-scalar.h (octave_base_scalar<T>::diag
(octave_idx_type, octave_idx_type)): New function.
* ov-complex.cc, ov-complex.h (octave_complex::diag (octave_idx_type,
octave_idx_type) const): New function.
* ov-cx-mat.cc, ov-complex.h (octave_complex_matrix::diag
(octave_idx_type, octave_idx_type) const): New function.
* ov-float.cc, ov-float.h (octave_float_scalar::diag (octave_idx_type,
octave_idx_type) const): New function.
* ov-flt-complex.cc, ov-flt-complex.h (octave_float_complex::diag
(octave_idx_type, octave_idx_type) const): New function.
* ov-flt-cx-mat.cc, ov-flt-cx-mat.h (octave_float_complex_matrix::diag
(octave_idx_type, octave_idx_type) const): New function.
* ov-flt-re-mat.cc, ov-flt-re-mat.h (octave_float_matrix::diag
(octave_idx_type, octave_idx_type) const): New function.
* ov-range.cc, ov-range.h (octave_range::diag (octave_idx_type,
octave_idx_type) const): New function.
* ov-re-mat.cc, ov-re-mat.h (octave_matrix::diag (octave_idx_type,
octave_idx_type) const): New function.
* ov-scalar.cc, ov-scalar.h (octave_scalar::diag (octave_idx_type,
octave_idx_type) const): New function.
* data.cc (Fdiag): Use two-arg octave_value::diag method for
dispatching. New tests.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 12 Apr 2012 16:27:39 -0400 |
parents | 72c96de7a403 |
children | 13cc11418393 |
rev | line source |
---|---|
4511 | 1 /* |
2 | |
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13756
diff
changeset
|
3 Copyright (C) 1996-2012 John W. Eaton |
4511 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
4511 | 11 |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
4511 | 20 |
21 */ | |
22 | |
4513 | 23 #if !defined (octave_NDArray_h) |
24 #define octave_NDArray_h 1 | |
4511 | 25 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
26 #include "MArray.h" |
4513 | 27 #include "dMatrix.h" |
4902 | 28 #include "intNDArray.h" |
4511 | 29 |
30 #include "mx-defs.h" | |
8774
b756ce0002db
split implementation and interface in mx-op-defs and MArray-defs
Jaroslav Hajek <highegg@gmail.com>
parents:
8650
diff
changeset
|
31 #include "mx-op-decl.h" |
9743
26abff55f6fe
optimize bsxfun for common built-in operations
Jaroslav Hajek <highegg@gmail.com>
parents:
9732
diff
changeset
|
32 #include "bsxfun-decl.h" |
4511 | 33 |
4513 | 34 class |
6108 | 35 OCTAVE_API |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
36 NDArray : public MArray<double> |
4511 | 37 { |
4513 | 38 public: |
5523 | 39 |
9656
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
40 typedef Matrix matrix_type; |
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
41 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
42 NDArray (void) : MArray<double> () { } |
4511 | 43 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
44 NDArray (const dim_vector& dv) : MArray<double> (dv) { } |
4511 | 45 |
4587 | 46 NDArray (const dim_vector& dv, double val) |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
47 : MArray<double> (dv, val) { } |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
48 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
49 NDArray (const NDArray& a) : MArray<double> (a) { } |
4513 | 50 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
51 NDArray (const Matrix& a) : MArray<double> (a) { } |
4511 | 52 |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
53 NDArray (const Array<octave_idx_type>& a, bool zero_based = false, |
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
54 bool negative_to_nan = false); |
7919
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
55 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
56 template <class U> |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
57 NDArray (const MArray<U>& a) : MArray<double> (a) { } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
58 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
59 template <class U> |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
60 NDArray (const Array<U>& a) : MArray<double> (a) { } |
4511 | 61 |
4902 | 62 template <class U> |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
63 explicit NDArray (const intNDArray<U>& a) : MArray<double> (a) { } |
4543 | 64 |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
65 NDArray (const charNDArray&); |
8956
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
66 |
4511 | 67 NDArray& operator = (const NDArray& a) |
68 { | |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
69 MArray<double>::operator = (a); |
4511 | 70 return *this; |
71 } | |
72 | |
4543 | 73 // unary operations |
74 | |
75 boolNDArray operator ! (void) const; | |
76 | |
4634 | 77 bool any_element_is_negative (bool = false) const; |
13756
6dfebfa334cb
allow negative data log plots with OpenGL+FLTK graphics (bug #34232)
John W. Eaton <jwe@octave.org>
parents:
13005
diff
changeset
|
78 bool any_element_is_positive (bool = false) const; |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7919
diff
changeset
|
79 bool any_element_is_nan (void) const; |
4634 | 80 bool any_element_is_inf_or_nan (void) const; |
5943 | 81 bool any_element_not_one_or_zero (void) const; |
6989 | 82 bool all_elements_are_zero (void) const; |
4634 | 83 bool all_elements_are_int_or_inf_or_nan (void) const; |
84 bool all_integers (double& max_val, double& min_val) const; | |
9827
c15a5ed0da58
optimize bsxfun (@power, ...)
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
85 bool all_integers (void) const; |
4634 | 86 bool too_large_for_float (void) const; |
87 | |
5775 | 88 // FIXME -- this is not quite the right thing. |
4513 | 89 |
4556 | 90 boolNDArray all (int dim = -1) const; |
91 boolNDArray any (int dim = -1) const; | |
4513 | 92 |
4584 | 93 NDArray cumprod (int dim = -1) const; |
94 NDArray cumsum (int dim = -1) const; | |
4569 | 95 NDArray prod (int dim = -1) const; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
96 NDArray sum (int dim = -1) const; |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
97 NDArray xsum (int dim = -1) const; |
4569 | 98 NDArray sumsq (int dim = -1) const; |
5275 | 99 NDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); |
100 ComplexNDArray concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
101 charNDArray concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
4844 | 102 |
9790
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
103 NDArray max (int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
104 NDArray max (Array<octave_idx_type>& index, int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
105 NDArray min (int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
106 NDArray min (Array<octave_idx_type>& index, int dim = -1) const; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
107 |
9790
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
108 NDArray cummax (int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
109 NDArray cummax (Array<octave_idx_type>& index, int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
110 NDArray cummin (int dim = -1) const; |
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
111 NDArray cummin (Array<octave_idx_type>& index, int dim = -1) const; |
8777
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
112 |
9790
a5035bc7fbfb
rewrite dispatch part & slightly improve min,max,cummin,cummax
Jaroslav Hajek <highegg@gmail.com>
parents:
9743
diff
changeset
|
113 NDArray diff (octave_idx_type order = 1, int dim = -1) const; |
9513
9f870f73ab7d
implement built-in diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8998
diff
changeset
|
114 |
5275 | 115 NDArray& insert (const NDArray& a, octave_idx_type r, octave_idx_type c); |
116 NDArray& insert (const NDArray& a, const Array<octave_idx_type>& ra_idx); | |
4915 | 117 |
4634 | 118 NDArray abs (void) const; |
8998
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
119 boolNDArray isnan (void) const; |
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
120 boolNDArray isinf (void) const; |
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
121 boolNDArray isfinite (void) const; |
4634 | 122 |
4773 | 123 ComplexNDArray fourier (int dim = 1) const; |
124 ComplexNDArray ifourier (int dim = 1) const; | |
125 | |
126 ComplexNDArray fourier2d (void) const; | |
127 ComplexNDArray ifourier2d (void) const; | |
128 | |
129 ComplexNDArray fourierNd (void) const; | |
130 ComplexNDArray ifourierNd (void) const; | |
131 | |
6108 | 132 friend OCTAVE_API NDArray real (const ComplexNDArray& a); |
133 friend OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
4569 | 134 |
8650
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
135 friend class ComplexNDArray; |
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
136 |
4513 | 137 Matrix matrix_value (void) const; |
138 | |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
139 NDArray squeeze (void) const { return MArray<double>::squeeze (); } |
4532 | 140 |
5275 | 141 static void increment_index (Array<octave_idx_type>& ra_idx, |
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
142 const dim_vector& dimensions, |
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
143 int start_dimension = 0); |
4532 | 144 |
5275 | 145 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
146 const dim_vector& dimensions); |
4556 | 147 |
4511 | 148 // i/o |
149 | |
6108 | 150 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const NDArray& a); |
151 friend OCTAVE_API std::istream& operator >> (std::istream& is, NDArray& a); | |
4511 | 152 |
153 static double resize_fill_value (void) { return 0; } | |
154 | |
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
155 NDArray diag (octave_idx_type k = 0) const; |
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
156 |
14557
e8e86ae3abbc
make diag (x, m, n) return a proper diagonal matrix object (bug #36099)
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
157 NDArray diag (octave_idx_type m, octave_idx_type n) const; |
e8e86ae3abbc
make diag (x, m, n) return a proper diagonal matrix object (bug #36099)
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
158 |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
159 NDArray& changesign (void) |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
160 { |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
161 MArray<double>::changesign (); |
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
162 return *this; |
9607
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
163 } |
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
164 |
4511 | 165 }; |
166 | |
5508 | 167 // Publish externally used friend functions. |
168 | |
6108 | 169 extern OCTAVE_API NDArray real (const ComplexNDArray& a); |
170 extern OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
5508 | 171 |
10329
83fa590b8a09
simplify min/max definitions in liboctave
Jaroslav Hajek <highegg@gmail.com>
parents:
10312
diff
changeset
|
172 MINMAX_DECLS (NDArray, double, OCTAVE_API) |
4844 | 173 |
6708 | 174 NDS_CMP_OP_DECLS (NDArray, double, OCTAVE_API) |
175 NDS_BOOL_OP_DECLS (NDArray, double, OCTAVE_API) | |
4543 | 176 |
6708 | 177 SND_CMP_OP_DECLS (double, NDArray, OCTAVE_API) |
178 SND_BOOL_OP_DECLS (double, NDArray, OCTAVE_API) | |
4543 | 179 |
6708 | 180 NDND_CMP_OP_DECLS (NDArray, NDArray, OCTAVE_API) |
181 NDND_BOOL_OP_DECLS (NDArray, NDArray, OCTAVE_API) | |
4543 | 182 |
10350
12884915a8e4
merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10329
diff
changeset
|
183 MARRAY_FORWARD_DEFS (MArray, NDArray, double) |
4511 | 184 |
9743
26abff55f6fe
optimize bsxfun for common built-in operations
Jaroslav Hajek <highegg@gmail.com>
parents:
9732
diff
changeset
|
185 BSXFUN_STDOP_DECLS (NDArray, OCTAVE_API) |
26abff55f6fe
optimize bsxfun for common built-in operations
Jaroslav Hajek <highegg@gmail.com>
parents:
9732
diff
changeset
|
186 BSXFUN_STDREL_DECLS (NDArray, OCTAVE_API) |
26abff55f6fe
optimize bsxfun for common built-in operations
Jaroslav Hajek <highegg@gmail.com>
parents:
9732
diff
changeset
|
187 |
9827
c15a5ed0da58
optimize bsxfun (@power, ...)
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
188 BSXFUN_OP_DECL (pow, NDArray, OCTAVE_API) |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
189 BSXFUN_OP2_DECL (pow, ComplexNDArray, ComplexNDArray, |
9827
c15a5ed0da58
optimize bsxfun (@power, ...)
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
190 NDArray, OCTAVE_API) |
13005
4061106b1c4b
Enable automatic bsxfun for power operators
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
191 BSXFUN_OP2_DECL (pow, ComplexNDArray, NDArray, |
4061106b1c4b
Enable automatic bsxfun for power operators
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11586
diff
changeset
|
192 ComplexNDArray, OCTAVE_API) |
9827
c15a5ed0da58
optimize bsxfun (@power, ...)
Jaroslav Hajek <highegg@gmail.com>
parents:
9812
diff
changeset
|
193 |
4511 | 194 #endif |