blob: 502d1cc9d022f843c38c0cac0ca75def84c8cd73 [file] [log] [blame]
Gael Guennebaud8cef5412008-06-21 17:28:07 +00001// This file is part of Eigen, a lightweight C++ template library
Benoit Jacob6347b1d2009-05-22 20:25:33 +02002// for linear algebra.
Gael Guennebaud8cef5412008-06-21 17:28:07 +00003//
Gael Guennebaud28e64b02010-06-24 23:21:58 +02004// Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
Gael Guennebaud8cef5412008-06-21 17:28:07 +00005//
Benoit Jacob69124cf2012-07-13 14:42:47 -04006// This Source Code Form is subject to the terms of the Mozilla
7// Public License v. 2.0. If a copy of the MPL was not distributed
8// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Gael Guennebaud19bc4182013-02-25 01:17:44 +01009
Gael Guennebaud8cef5412008-06-21 17:28:07 +000010#include "main.h"
Gael Guennebaud8cef5412008-06-21 17:28:07 +000011
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000012
13// Test the corner cases of pow(x, y) for real types.
14template<typename Scalar>
15void pow_test() {
16 const Scalar zero = Scalar(0);
Antonio Sanchez8dfe1022021-03-16 20:12:46 -070017 const Scalar eps = Eigen::NumTraits<Scalar>::epsilon();
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000018 const Scalar one = Scalar(1);
Rasmus Munk Larsen6e3b7952021-02-05 16:58:49 -080019 const Scalar two = Scalar(2);
20 const Scalar three = Scalar(3);
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000021 const Scalar sqrt_half = Scalar(std::sqrt(0.5));
22 const Scalar sqrt2 = Scalar(std::sqrt(2));
Antonio Sanchez8dfe1022021-03-16 20:12:46 -070023 const Scalar inf = Eigen::NumTraits<Scalar>::infinity();
24 const Scalar nan = Eigen::NumTraits<Scalar>::quiet_NaN();
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000025 const Scalar denorm_min = std::numeric_limits<Scalar>::denorm_min();
Rasmus Munk Larsen6e3b7952021-02-05 16:58:49 -080026 const Scalar min = (std::numeric_limits<Scalar>::min)();
27 const Scalar max = (std::numeric_limits<Scalar>::max)();
Antonio Sanchez8dfe1022021-03-16 20:12:46 -070028 const Scalar max_exp = (static_cast<Scalar>(int(Eigen::NumTraits<Scalar>::max_exponent())) * Scalar(EIGEN_LN2)) / eps;
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000029
Rasmus Munk Larsen6e3b7952021-02-05 16:58:49 -080030 const static Scalar abs_vals[] = {zero,
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000031 denorm_min,
32 min,
33 eps,
Rasmus Munk Larsen6e3b7952021-02-05 16:58:49 -080034 sqrt_half,
35 one,
36 sqrt2,
37 two,
38 three,
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000039 max_exp,
Rasmus Munk Larsen6e3b7952021-02-05 16:58:49 -080040 max,
41 inf,
42 nan};
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000043 const int abs_cases = 13;
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000044 const int num_cases = 2*abs_cases * 2*abs_cases;
45 // Repeat the same value to make sure we hit the vectorized path.
46 const int num_repeats = 32;
47 Array<Scalar, Dynamic, Dynamic> x(num_repeats, num_cases);
48 Array<Scalar, Dynamic, Dynamic> y(num_repeats, num_cases);
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000049 int count = 0;
50 for (int i = 0; i < abs_cases; ++i) {
51 const Scalar abs_x = abs_vals[i];
52 for (int sign_x = 0; sign_x < 2; ++sign_x) {
53 Scalar x_case = sign_x == 0 ? -abs_x : abs_x;
54 for (int j = 0; j < abs_cases; ++j) {
55 const Scalar abs_y = abs_vals[j];
56 for (int sign_y = 0; sign_y < 2; ++sign_y) {
57 Scalar y_case = sign_y == 0 ? -abs_y : abs_y;
58 for (int repeat = 0; repeat < num_repeats; ++repeat) {
59 x(repeat, count) = x_case;
60 y(repeat, count) = y_case;
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000061 }
62 ++count;
63 }
64 }
65 }
66 }
67
68 Array<Scalar, Dynamic, Dynamic> actual = x.pow(y);
69 const Scalar tol = test_precision<Scalar>();
70 bool all_pass = true;
71 for (int i = 0; i < 1; ++i) {
72 for (int j = 0; j < num_cases; ++j) {
Rasmus Munk Larsenbe0574e2021-02-17 02:50:32 +000073 Scalar e = static_cast<Scalar>(std::pow(x(i,j), y(i,j)));
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000074 Scalar a = actual(i, j);
Rasmus Munk Larsen7a87ed12022-08-08 18:48:36 +000075 bool success = (a==e) || ((numext::isfinite)(e) && internal::isApprox(a, e, tol)) || ((numext::isnan)(a) && (numext::isnan)(e));
76 all_pass &= success;
77 if (!success) {
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +000078 std::cout << "pow(" << x(i,j) << "," << y(i,j) << ") = " << a << " != " << e << std::endl;
79 }
80 }
81 }
Charles Schlosser76a669f2022-08-16 21:32:36 +000082
83 typedef typename internal::make_integer<Scalar>::type Int_t;
84
85 // ensure both vectorized and non-vectorized paths taken
86 Index test_size = 2 * internal::packet_traits<Scalar>::size + 1;
87
88 Array<Scalar, Dynamic, 1> eigenPow(test_size);
89 for (int i = 0; i < num_cases; ++i) {
90 Array<Scalar, Dynamic, 1> bases = x.col(i);
91 for (Scalar abs_exponent : abs_vals){
92 for (Scalar exponent : {-abs_exponent, abs_exponent}){
93 // test floating point exponent code path
94 eigenPow.setZero();
95 eigenPow = bases.pow(exponent);
96 for (int j = 0; j < num_repeats; j++){
97 Scalar e = static_cast<Scalar>(std::pow(bases(j), exponent));
98 Scalar a = eigenPow(j);
99 bool success = (a == e) || ((numext::isfinite)(e) && internal::isApprox(a, e, tol)) || ((numext::isnan)(a) && (numext::isnan)(e));
100 all_pass &= success;
101 if (!success) {
102 std::cout << "pow(" << x(i, j) << "," << y(i, j) << ") = " << a << " != " << e << std::endl;
103 }
104 }
105 // test integer exponent code path
106 bool exponent_is_integer = (numext::isfinite)(exponent) && (numext::round(exponent) == exponent) && (numext::abs(exponent) < static_cast<Scalar>(NumTraits<Int_t>::highest()));
107 if (exponent_is_integer)
108 {
109 Int_t exponent_as_int = static_cast<Int_t>(exponent);
110 eigenPow.setZero();
111 eigenPow = bases.pow(exponent_as_int);
112 for (int j = 0; j < num_repeats; j++){
113 Scalar e = static_cast<Scalar>(std::pow(bases(j), exponent));
114 Scalar a = eigenPow(j);
115 bool success = (a == e) || ((numext::isfinite)(e) && internal::isApprox(a, e, tol)) || ((numext::isnan)(a) && (numext::isnan)(e));
116 all_pass &= success;
117 if (!success) {
118 std::cout << "pow(" << x(i, j) << "," << y(i, j) << ") = " << a << " != " << e << std::endl;
119 }
120 }
121 }
122 }
123 }
124 }
125
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +0000126 VERIFY(all_pass);
127}
128
Charles Schlossere5af9f82022-08-29 19:23:54 +0000129template <typename Scalar, typename ScalarExponent>
130Scalar calc_overflow_threshold(const ScalarExponent exponent) {
131 EIGEN_USING_STD(exp2);
132 EIGEN_STATIC_ASSERT((NumTraits<Scalar>::digits() < 2 * NumTraits<double>::digits()), BASE_TYPE_IS_TOO_BIG);
133
134 if (exponent < 2)
135 return NumTraits<Scalar>::highest();
136 else {
137 const double max_exponent = static_cast<double>(NumTraits<Scalar>::digits());
138 const double clamped_exponent = exponent < max_exponent ? static_cast<double>(exponent) : max_exponent;
139 const double threshold = exp2(max_exponent / clamped_exponent);
140 return static_cast<Scalar>(threshold);
141 }
142}
143
144template <typename Base, typename Exponent>
145void test_exponent(Exponent exponent) {
146 EIGEN_USING_STD(pow);
147
148 const Base max_abs_bases = 10000;
149 // avoid integer overflow in Base type
150 Base threshold = calc_overflow_threshold<Base, Exponent>(numext::abs(exponent));
151 // avoid numbers that can't be verified with std::pow
152 double double_threshold = calc_overflow_threshold<double, Exponent>(numext::abs(exponent));
153 // use the lesser of these two thresholds
154 Base testing_threshold = threshold < double_threshold ? threshold : static_cast<Base>(double_threshold);
Charles Schlossere5af9f82022-08-29 19:23:54 +0000155 // test both vectorized and non-vectorized code paths
156 const Index array_size = 2 * internal::packet_traits<Base>::size + 1;
157
158 Base max_base = numext::mini(testing_threshold, max_abs_bases);
159 Base min_base = NumTraits<Base>::IsSigned ? -max_base : 0;
160
161 ArrayX<Base> x(array_size), y(array_size);
162
163 bool all_pass = true;
164
165 for (Base base = min_base; base <= max_base; base++) {
166 if (exponent < 0 && base == 0) continue;
167 x.setConstant(base);
168 y = x.pow(exponent);
169 Base e = pow(base, exponent);
170 for (Base a : y) {
171 bool pass = a == e;
172 all_pass &= pass;
173 if (!pass) {
174 std::cout << "pow(" << base << "," << exponent << ") = " << a << " != " << e << std::endl;
175 }
176 }
177 }
178
179 VERIFY(all_pass);
180}
181template <typename Base, typename Exponent>
182void int_pow_test() {
183 Exponent max_exponent = NumTraits<Base>::digits();
184 Exponent min_exponent = NumTraits<Exponent>::IsSigned ? -max_exponent : 0;
185
186 for (Exponent exponent = min_exponent; exponent < max_exponent; exponent++) {
187 test_exponent<Base, Exponent>(exponent);
188 }
189}
190
Benoit Jacobe2775862010-04-28 18:51:38 -0400191template<typename ArrayType> void array(const ArrayType& m)
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000192{
Benoit Jacobe2775862010-04-28 18:51:38 -0400193 typedef typename ArrayType::Scalar Scalar;
Gael Guennebaudd476cad2016-06-25 10:12:06 +0200194 typedef typename ArrayType::RealScalar RealScalar;
Benoit Jacobe2775862010-04-28 18:51:38 -0400195 typedef Array<Scalar, ArrayType::RowsAtCompileTime, 1> ColVectorType;
196 typedef Array<Scalar, 1, ArrayType::ColsAtCompileTime> RowVectorType;
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000197
Hauke Heibelf1679c72010-06-20 17:37:56 +0200198 Index rows = m.rows();
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800199 Index cols = m.cols();
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000200
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000201 ArrayType m1 = ArrayType::Random(rows, cols);
202 if (NumTraits<RealScalar>::IsInteger && NumTraits<RealScalar>::IsSigned
203 && !NumTraits<Scalar>::IsComplex) {
204 // Here we cap the size of the values in m1 such that pow(3)/cube()
205 // doesn't overflow and result in undefined behavior. Notice that because
206 // pow(int, int) promotes its inputs and output to double (according to
207 // the C++ standard), we hvae to make sure that the result fits in 53 bits
208 // for int64,
209 RealScalar max_val =
210 numext::mini(RealScalar(std::cbrt(NumTraits<RealScalar>::highest())),
211 RealScalar(std::cbrt(1LL << 53)))/2;
212 m1.array() = (m1.abs().array() <= max_val).select(m1, Scalar(max_val));
213 }
214 ArrayType m2 = ArrayType::Random(rows, cols),
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000215 m3(rows, cols);
Christoph Hertzberg3be9f5c2015-04-16 13:25:20 +0200216 ArrayType m4 = m1; // copy constructor
217 VERIFY_IS_APPROX(m1, m4);
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000218
Gael Guennebaud627595a2009-06-10 11:20:30 +0200219 ColVectorType cv1 = ColVectorType::Random(rows);
220 RowVectorType rv1 = RowVectorType::Random(cols);
221
Benoit Jacob47160402010-10-25 10:15:22 -0400222 Scalar s1 = internal::random<Scalar>(),
Hauke Heibel8cb3e362012-03-02 16:27:27 +0100223 s2 = internal::random<Scalar>();
224
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000225 // scalar addition
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100226 VERIFY_IS_APPROX(m1 + s1, s1 + m1);
Benoit Jacobe2775862010-04-28 18:51:38 -0400227 VERIFY_IS_APPROX(m1 + s1, ArrayType::Constant(rows,cols,s1) + m1);
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100228 VERIFY_IS_APPROX(s1 - m1, (-m1)+s1 );
Benoit Jacobe2775862010-04-28 18:51:38 -0400229 VERIFY_IS_APPROX(m1 - s1, m1 - ArrayType::Constant(rows,cols,s1));
230 VERIFY_IS_APPROX(s1 - m1, ArrayType::Constant(rows,cols,s1) - m1);
231 VERIFY_IS_APPROX((m1*Scalar(2)) - s2, (m1+m1) - ArrayType::Constant(rows,cols,s2) );
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000232 m3 = m1;
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100233 m3 += s2;
234 VERIFY_IS_APPROX(m3, m1 + s2);
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000235 m3 = m1;
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100236 m3 -= s1;
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800237 VERIFY_IS_APPROX(m3, m1 - s1);
238
Hauke Heibelf578dc72010-12-16 17:34:13 +0100239 // scalar operators via Maps
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000240 m3 = m1; m4 = m1;
241 ArrayType::Map(m4.data(), m4.rows(), m4.cols()) -= ArrayType::Map(m2.data(), m2.rows(), m2.cols());
242 VERIFY_IS_APPROX(m4, m3 - m2);
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800243
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000244 m3 = m1; m4 = m1;
245 ArrayType::Map(m4.data(), m4.rows(), m4.cols()) += ArrayType::Map(m2.data(), m2.rows(), m2.cols());
246 VERIFY_IS_APPROX(m4, m3 + m2);
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800247
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000248 m3 = m1; m4 = m1;
249 ArrayType::Map(m4.data(), m4.rows(), m4.cols()) *= ArrayType::Map(m2.data(), m2.rows(), m2.cols());
250 VERIFY_IS_APPROX(m4, m3 * m2);
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800251
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000252 m3 = m1; m4 = m1;
Hauke Heibelf578dc72010-12-16 17:34:13 +0100253 m2 = ArrayType::Random(rows,cols);
254 m2 = (m2==0).select(1,m2);
Rasmus Munk Larsen98e51c92022-08-26 16:19:03 +0000255 ArrayType::Map(m4.data(), m4.rows(), m4.cols()) /= ArrayType::Map(m2.data(), m2.rows(), m2.cols());
256 VERIFY_IS_APPROX(m4, m3 / m2);
Gael Guennebaud05ad0832008-07-19 13:03:23 +0000257
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000258 // reductions
Gael Guennebaud42af5872013-02-23 22:58:14 +0100259 VERIFY_IS_APPROX(m1.abs().colwise().sum().sum(), m1.abs().sum());
260 VERIFY_IS_APPROX(m1.abs().rowwise().sum().sum(), m1.abs().sum());
261 using std::abs;
262 VERIFY_IS_MUCH_SMALLER_THAN(abs(m1.colwise().sum().sum() - m1.sum()), m1.abs().sum());
263 VERIFY_IS_MUCH_SMALLER_THAN(abs(m1.rowwise().sum().sum() - m1.sum()), m1.abs().sum());
Gael Guennebaud28e139a2013-02-23 23:06:45 +0100264 if (!internal::isMuchSmallerThan(abs(m1.sum() - (m1+m2).sum()), m1.abs().sum(), test_precision<Scalar>()))
Hauke Heibel83e3c452010-12-16 18:53:02 +0100265 VERIFY_IS_NOT_APPROX(((m1+m2).rowwise().sum()).sum(), m1.sum());
Gael Guennebaud66e99ab2016-06-06 15:11:41 +0200266 VERIFY_IS_APPROX(m1.colwise().sum(), m1.colwise().redux(internal::scalar_sum_op<Scalar,Scalar>()));
Gael Guennebaud627595a2009-06-10 11:20:30 +0200267
268 // vector-wise ops
269 m3 = m1;
270 VERIFY_IS_APPROX(m3.colwise() += cv1, m1.colwise() + cv1);
271 m3 = m1;
272 VERIFY_IS_APPROX(m3.colwise() -= cv1, m1.colwise() - cv1);
273 m3 = m1;
274 VERIFY_IS_APPROX(m3.rowwise() += rv1, m1.rowwise() + rv1);
275 m3 = m1;
276 VERIFY_IS_APPROX(m3.rowwise() -= rv1, m1.rowwise() - rv1);
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800277
Gael Guennebaud0a18eec2014-09-19 13:25:28 +0200278 // Conversion from scalar
279 VERIFY_IS_APPROX((m3 = s1), ArrayType::Constant(rows,cols,s1));
280 VERIFY_IS_APPROX((m3 = 1), ArrayType::Constant(rows,cols,1));
281 VERIFY_IS_APPROX((m3.topLeftCorner(rows,cols) = 1), ArrayType::Constant(rows,cols,1));
282 typedef Array<Scalar,
283 ArrayType::RowsAtCompileTime==Dynamic?2:ArrayType::RowsAtCompileTime,
284 ArrayType::ColsAtCompileTime==Dynamic?2:ArrayType::ColsAtCompileTime,
285 ArrayType::Options> FixedArrayType;
Gael Guennebaud543529d2019-01-22 15:30:50 +0100286 {
287 FixedArrayType f1(s1);
288 VERIFY_IS_APPROX(f1, FixedArrayType::Constant(s1));
289 FixedArrayType f2(numext::real(s1));
290 VERIFY_IS_APPROX(f2, FixedArrayType::Constant(numext::real(s1)));
291 FixedArrayType f3((int)100*numext::real(s1));
292 VERIFY_IS_APPROX(f3, FixedArrayType::Constant((int)100*numext::real(s1)));
293 f1.setRandom();
294 FixedArrayType f4(f1.data());
295 VERIFY_IS_APPROX(f4, f1);
296 }
Gael Guennebaud543529d2019-01-22 15:30:50 +0100297 {
298 FixedArrayType f1{s1};
299 VERIFY_IS_APPROX(f1, FixedArrayType::Constant(s1));
300 FixedArrayType f2{numext::real(s1)};
301 VERIFY_IS_APPROX(f2, FixedArrayType::Constant(numext::real(s1)));
302 FixedArrayType f3{(int)100*numext::real(s1)};
303 VERIFY_IS_APPROX(f3, FixedArrayType::Constant((int)100*numext::real(s1)));
304 f1.setRandom();
305 FixedArrayType f4{f1.data()};
306 VERIFY_IS_APPROX(f4, f1);
307 }
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800308
Gael Guennebaudd476cad2016-06-25 10:12:06 +0200309 // pow
310 VERIFY_IS_APPROX(m1.pow(2), m1.square());
311 VERIFY_IS_APPROX(pow(m1,2), m1.square());
312 VERIFY_IS_APPROX(m1.pow(3), m1.cube());
313 VERIFY_IS_APPROX(pow(m1,3), m1.cube());
314 VERIFY_IS_APPROX((-m1).pow(3), -m1.cube());
315 VERIFY_IS_APPROX(pow(2*m1,3), 8*m1.cube());
316 ArrayType exponents = ArrayType::Constant(rows, cols, RealScalar(2));
317 VERIFY_IS_APPROX(Eigen::pow(m1,exponents), m1.square());
318 VERIFY_IS_APPROX(m1.pow(exponents), m1.square());
319 VERIFY_IS_APPROX(Eigen::pow(2*m1,exponents), 4*m1.square());
320 VERIFY_IS_APPROX((2*m1).pow(exponents), 4*m1.square());
321 VERIFY_IS_APPROX(Eigen::pow(m1,2*exponents), m1.square().square());
322 VERIFY_IS_APPROX(m1.pow(2*exponents), m1.square().square());
Gael Guennebaude61cee72016-07-04 11:49:03 +0200323 VERIFY_IS_APPROX(Eigen::pow(m1(0,0), exponents), ArrayType::Constant(rows,cols,m1(0,0)*m1(0,0)));
Gael Guennebaudd476cad2016-06-25 10:12:06 +0200324
Gael Guennebaud0a18eec2014-09-19 13:25:28 +0200325 // Check possible conflicts with 1D ctor
326 typedef Array<Scalar, Dynamic, 1> OneDArrayType;
Gael Guennebaud543529d2019-01-22 15:30:50 +0100327 {
328 OneDArrayType o1(rows);
329 VERIFY(o1.size()==rows);
330 OneDArrayType o2(static_cast<int>(rows));
331 VERIFY(o2.size()==rows);
332 }
Gael Guennebaud543529d2019-01-22 15:30:50 +0100333 {
334 OneDArrayType o1{rows};
335 VERIFY(o1.size()==rows);
336 OneDArrayType o4{int(rows)};
337 VERIFY(o4.size()==rows);
338 }
Gael Guennebaud543529d2019-01-22 15:30:50 +0100339 // Check possible conflicts with 2D ctor
340 typedef Array<Scalar, Dynamic, Dynamic> TwoDArrayType;
341 typedef Array<Scalar, 2, 1> ArrayType2;
342 {
343 TwoDArrayType o1(rows,cols);
344 VERIFY(o1.rows()==rows);
345 VERIFY(o1.cols()==cols);
346 TwoDArrayType o2(static_cast<int>(rows),static_cast<int>(cols));
347 VERIFY(o2.rows()==rows);
348 VERIFY(o2.cols()==cols);
349
350 ArrayType2 o3(rows,cols);
351 VERIFY(o3(0)==Scalar(rows) && o3(1)==Scalar(cols));
352 ArrayType2 o4(static_cast<int>(rows),static_cast<int>(cols));
353 VERIFY(o4(0)==Scalar(rows) && o4(1)==Scalar(cols));
354 }
Gael Guennebaud543529d2019-01-22 15:30:50 +0100355 {
356 TwoDArrayType o1{rows,cols};
357 VERIFY(o1.rows()==rows);
358 VERIFY(o1.cols()==cols);
359 TwoDArrayType o2{int(rows),int(cols)};
360 VERIFY(o2.rows()==rows);
361 VERIFY(o2.cols()==cols);
362
363 ArrayType2 o3{rows,cols};
364 VERIFY(o3(0)==Scalar(rows) && o3(1)==Scalar(cols));
365 ArrayType2 o4{int(rows),int(cols)};
366 VERIFY(o4(0)==Scalar(rows) && o4(1)==Scalar(cols));
367 }
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000368}
369
Benoit Jacobe2775862010-04-28 18:51:38 -0400370template<typename ArrayType> void comparisons(const ArrayType& m)
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000371{
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100372 using std::abs;
Benoit Jacobe2775862010-04-28 18:51:38 -0400373 typedef typename ArrayType::Scalar Scalar;
Benoit Jacob874ff5a2009-01-26 17:56:04 +0000374 typedef typename NumTraits<Scalar>::Real RealScalar;
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000375
Hauke Heibelf1679c72010-06-20 17:37:56 +0200376 Index rows = m.rows();
377 Index cols = m.cols();
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000378
Benoit Jacob47160402010-10-25 10:15:22 -0400379 Index r = internal::random<Index>(0, rows-1),
380 c = internal::random<Index>(0, cols-1);
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000381
Benoit Jacobe2775862010-04-28 18:51:38 -0400382 ArrayType m1 = ArrayType::Random(rows, cols),
Gael Guennebaud9fc1c922015-06-22 16:48:27 +0200383 m2 = ArrayType::Random(rows, cols),
384 m3(rows, cols),
385 m4 = m1;
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800386
Gael Guennebaud9fc1c922015-06-22 16:48:27 +0200387 m4 = (m4.abs()==Scalar(0)).select(1,m4);
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000388
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100389 VERIFY(((m1 + Scalar(1)) > m1).all());
390 VERIFY(((m1 - Scalar(1)) < m1).all());
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000391 if (rows*cols>1)
392 {
393 m3 = m1;
394 m3(r,c) += 1;
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100395 VERIFY(! (m1 < m3).all() );
396 VERIFY(! (m1 > m3).all() );
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000397 }
Christoph Hertzberg494fa992015-05-07 17:28:40 +0200398 VERIFY(!(m1 > m2 && m1 < m2).any());
399 VERIFY((m1 <= m2 || m1 >= m2).all());
Gael Guennebaud627595a2009-06-10 11:20:30 +0200400
Christoph Hertzberg36052c42013-10-17 15:37:29 +0200401 // comparisons array to scalar
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100402 VERIFY( (m1 != (m1(r,c)+1) ).any() );
Christoph Hertzberg36052c42013-10-17 15:37:29 +0200403 VERIFY( (m1 > (m1(r,c)-1) ).any() );
404 VERIFY( (m1 < (m1(r,c)+1) ).any() );
405 VERIFY( (m1 == m1(r,c) ).any() );
406
407 // comparisons scalar to array
408 VERIFY( ( (m1(r,c)+1) != m1).any() );
409 VERIFY( ( (m1(r,c)-1) < m1).any() );
410 VERIFY( ( (m1(r,c)+1) > m1).any() );
411 VERIFY( ( m1(r,c) == m1).any() );
Gael Guennebaud627595a2009-06-10 11:20:30 +0200412
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000413 // test Select
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100414 VERIFY_IS_APPROX( (m1<m2).select(m1,m2), m1.cwiseMin(m2) );
415 VERIFY_IS_APPROX( (m1>m2).select(m1,m2), m1.cwiseMax(m2) );
Gael Guennebaud9f795582009-12-16 19:18:40 +0100416 Scalar mid = (m1.cwiseAbs().minCoeff() + m1.cwiseAbs().maxCoeff())/Scalar(2);
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000417 for (int j=0; j<cols; ++j)
418 for (int i=0; i<rows; ++i)
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100419 m3(i,j) = abs(m1(i,j))<mid ? 0 : m1(i,j);
Benoit Jacobe2775862010-04-28 18:51:38 -0400420 VERIFY_IS_APPROX( (m1.abs()<ArrayType::Constant(rows,cols,mid))
421 .select(ArrayType::Zero(rows,cols),m1), m3);
Gael Guennebaude14aa8c2008-09-03 17:56:06 +0000422 // shorter versions:
Benoit Jacobe2775862010-04-28 18:51:38 -0400423 VERIFY_IS_APPROX( (m1.abs()<ArrayType::Constant(rows,cols,mid))
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000424 .select(0,m1), m3);
Benoit Jacobe2775862010-04-28 18:51:38 -0400425 VERIFY_IS_APPROX( (m1.abs()>=ArrayType::Constant(rows,cols,mid))
Gael Guennebaud59dc1da2008-09-03 17:16:28 +0000426 .select(m1,0), m3);
Gael Guennebaude14aa8c2008-09-03 17:56:06 +0000427 // even shorter version:
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100428 VERIFY_IS_APPROX( (m1.abs()<mid).select(0,m1), m3);
Gael Guennebaud627595a2009-06-10 11:20:30 +0200429
Gael Guennebaud56c7e162009-01-24 15:22:44 +0000430 // count
Gael Guennebaudc70d5422010-01-18 22:54:20 +0100431 VERIFY(((m1.abs()+1)>RealScalar(0.1)).count() == rows*cols);
Benoit Jacobaaaade42010-05-30 16:00:58 -0400432
Gael Guennebaud35c11582011-05-31 22:17:34 +0200433 // and/or
434 VERIFY( (m1<RealScalar(0) && m1>RealScalar(0)).count() == 0);
435 VERIFY( (m1<RealScalar(0) || m1>=RealScalar(0)).count() == rows*cols);
436 RealScalar a = m1.abs().mean();
437 VERIFY( (m1<-a || m1>a).count() == (m1.abs()>a).count());
438
Gael Guennebaud12e1ebb2018-07-12 17:16:40 +0200439 typedef Array<Index, Dynamic, 1> ArrayOfIndices;
Gael Guennebaud4ebb8042010-06-02 09:45:57 +0200440
Gael Guennebaud9f795582009-12-16 19:18:40 +0100441 // TODO allows colwise/rowwise for array
Benoit Jacobaaaade42010-05-30 16:00:58 -0400442 VERIFY_IS_APPROX(((m1.abs()+1)>RealScalar(0.1)).colwise().count(), ArrayOfIndices::Constant(cols,rows).transpose());
443 VERIFY_IS_APPROX(((m1.abs()+1)>RealScalar(0.1)).rowwise().count(), ArrayOfIndices::Constant(rows, cols));
Benoit Jacobe8009992008-11-03 22:47:00 +0000444}
445
Benoit Jacobe2775862010-04-28 18:51:38 -0400446template<typename ArrayType> void array_real(const ArrayType& m)
Gael Guennebaud0ce5bc02010-01-27 23:23:59 +0100447{
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100448 using std::abs;
Gael Guennebaud9b9177f2013-07-05 13:35:34 +0200449 using std::sqrt;
Benoit Jacobe2775862010-04-28 18:51:38 -0400450 typedef typename ArrayType::Scalar Scalar;
Gael Guennebaud0ce5bc02010-01-27 23:23:59 +0100451 typedef typename NumTraits<Scalar>::Real RealScalar;
452
Hauke Heibelf1679c72010-06-20 17:37:56 +0200453 Index rows = m.rows();
454 Index cols = m.cols();
Gael Guennebaud0ce5bc02010-01-27 23:23:59 +0100455
Benoit Jacobe2775862010-04-28 18:51:38 -0400456 ArrayType m1 = ArrayType::Random(rows, cols),
Gael Guennebaudc695cbf2013-06-24 13:33:44 +0200457 m2 = ArrayType::Random(rows, cols),
Gael Guennebaud9fc1c922015-06-22 16:48:27 +0200458 m3(rows, cols),
459 m4 = m1;
Benoit Steiner83149622015-12-10 13:13:45 -0800460
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800461 m4 = (m4.abs()==Scalar(0)).select(Scalar(1),m4);
Gael Guennebaud0ce5bc02010-01-27 23:23:59 +0100462
Gael Guennebaud9b1ad5e2012-03-09 12:08:06 +0100463 Scalar s1 = internal::random<Scalar>();
464
Deanna Hood41b717d2015-03-18 03:11:03 +1000465 // these tests are mostly to check possible compilation issues with free-functions.
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100466 VERIFY_IS_APPROX(m1.sin(), sin(m1));
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100467 VERIFY_IS_APPROX(m1.cos(), cos(m1));
Deanna Hoodf89fcef2015-03-11 13:13:30 +1000468 VERIFY_IS_APPROX(m1.tan(), tan(m1));
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100469 VERIFY_IS_APPROX(m1.asin(), asin(m1));
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100470 VERIFY_IS_APPROX(m1.acos(), acos(m1));
Jitse Niesende150b12014-06-19 15:12:33 +0100471 VERIFY_IS_APPROX(m1.atan(), atan(m1));
Deanna Hoodf89fcef2015-03-11 13:13:30 +1000472 VERIFY_IS_APPROX(m1.sinh(), sinh(m1));
473 VERIFY_IS_APPROX(m1.cosh(), cosh(m1));
474 VERIFY_IS_APPROX(m1.tanh(), tanh(m1));
Rasmus Munk Larsen28ba1b22019-01-11 17:45:37 -0800475#if EIGEN_HAS_CXX11_MATH
476 VERIFY_IS_APPROX(m1.tanh().atanh(), atanh(tanh(m1)));
477 VERIFY_IS_APPROX(m1.sinh().asinh(), asinh(sinh(m1)));
478 VERIFY_IS_APPROX(m1.cosh().acosh(), acosh(cosh(m1)));
479#endif
Rasmus Munk Larsend6e283b2018-08-13 11:14:50 -0700480 VERIFY_IS_APPROX(m1.logistic(), logistic(m1));
Gael Guennebaud2f7e2612016-07-08 11:13:55 +0200481
Deanna Hooda5e49972015-03-11 08:56:42 +1000482 VERIFY_IS_APPROX(m1.arg(), arg(m1));
Deanna Hood31fdd672015-03-11 06:39:23 +1000483 VERIFY_IS_APPROX(m1.round(), round(m1));
Ilya Tokar19876ce2019-12-16 16:00:35 -0500484 VERIFY_IS_APPROX(m1.rint(), rint(m1));
Deanna Hood31fdd672015-03-11 06:39:23 +1000485 VERIFY_IS_APPROX(m1.floor(), floor(m1));
486 VERIFY_IS_APPROX(m1.ceil(), ceil(m1));
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200487 VERIFY((m1.isNaN() == (Eigen::isnan)(m1)).all());
488 VERIFY((m1.isInf() == (Eigen::isinf)(m1)).all());
489 VERIFY((m1.isFinite() == (Eigen::isfinite)(m1)).all());
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800490 VERIFY_IS_APPROX(m4.inverse(), inverse(m4));
Deanna Hood41b717d2015-03-18 03:11:03 +1000491 VERIFY_IS_APPROX(m1.abs(), abs(m1));
492 VERIFY_IS_APPROX(m1.abs2(), abs2(m1));
493 VERIFY_IS_APPROX(m1.square(), square(m1));
494 VERIFY_IS_APPROX(m1.cube(), cube(m1));
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100495 VERIFY_IS_APPROX(cos(m1+RealScalar(3)*m2), cos((m1+RealScalar(3)*m2).eval()));
Gael Guennebaud3f32f5e2015-11-27 16:27:53 +0100496 VERIFY_IS_APPROX(m1.sign(), sign(m1));
Rasmus Munk Larsen6964ae82020-07-07 01:54:04 +0000497 VERIFY((m1.sqrt().sign().isNaN() == (Eigen::isnan)(sign(sqrt(m1)))).all());
Deanna Hood41b717d2015-03-18 03:11:03 +1000498
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800499 // avoid inf and NaNs so verification doesn't fail
500 m3 = m4.abs();
501 VERIFY_IS_APPROX(m3.sqrt(), sqrt(abs(m3)));
502 VERIFY_IS_APPROX(m3.rsqrt(), Scalar(1)/sqrt(abs(m3)));
503 VERIFY_IS_APPROX(rsqrt(m3), Scalar(1)/sqrt(abs(m3)));
Deanna Hood41b717d2015-03-18 03:11:03 +1000504 VERIFY_IS_APPROX(m3.log(), log(m3));
Gael Guennebaud89099b02016-06-01 17:00:08 +0200505 VERIFY_IS_APPROX(m3.log1p(), log1p(m3));
Deanna Hood41b717d2015-03-18 03:11:03 +1000506 VERIFY_IS_APPROX(m3.log10(), log10(m3));
Rasmus Munk Larsenf9fac1d2020-12-04 21:45:09 +0000507 VERIFY_IS_APPROX(m3.log2(), log2(m3));
Deanna Hood41b717d2015-03-18 03:11:03 +1000508
509
510 VERIFY((!(m1>m2) == (m1<=m2)).all());
511
512 VERIFY_IS_APPROX(sin(m1.asin()), m1);
513 VERIFY_IS_APPROX(cos(m1.acos()), m1);
514 VERIFY_IS_APPROX(tan(m1.atan()), m1);
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800515 VERIFY_IS_APPROX(sinh(m1), Scalar(0.5)*(exp(m1)-exp(-m1)));
516 VERIFY_IS_APPROX(cosh(m1), Scalar(0.5)*(exp(m1)+exp(-m1)));
517 VERIFY_IS_APPROX(tanh(m1), (Scalar(0.5)*(exp(m1)-exp(-m1)))/(Scalar(0.5)*(exp(m1)+exp(-m1))));
518 VERIFY_IS_APPROX(logistic(m1), (Scalar(1)/(Scalar(1)+exp(-m1))));
519 VERIFY_IS_APPROX(arg(m1), ((m1<Scalar(0)).template cast<Scalar>())*Scalar(std::acos(Scalar(-1))));
Deanna Hood41b717d2015-03-18 03:11:03 +1000520 VERIFY((round(m1) <= ceil(m1) && round(m1) >= floor(m1)).all());
Ilya Tokar19876ce2019-12-16 16:00:35 -0500521 VERIFY((rint(m1) <= ceil(m1) && rint(m1) >= floor(m1)).all());
522 VERIFY(((ceil(m1) - round(m1)) <= Scalar(0.5) || (round(m1) - floor(m1)) <= Scalar(0.5)).all());
523 VERIFY(((ceil(m1) - round(m1)) <= Scalar(1.0) && (round(m1) - floor(m1)) <= Scalar(1.0)).all());
524 VERIFY(((ceil(m1) - rint(m1)) <= Scalar(0.5) || (rint(m1) - floor(m1)) <= Scalar(0.5)).all());
525 VERIFY(((ceil(m1) - rint(m1)) <= Scalar(1.0) && (rint(m1) - floor(m1)) <= Scalar(1.0)).all());
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800526 VERIFY((Eigen::isnan)((m1*Scalar(0))/Scalar(0)).all());
527 VERIFY((Eigen::isinf)(m4/Scalar(0)).all());
528 VERIFY(((Eigen::isfinite)(m1) && (!(Eigen::isfinite)(m1*Scalar(0)/Scalar(0))) && (!(Eigen::isfinite)(m4/Scalar(0)))).all());
529 VERIFY_IS_APPROX(inverse(inverse(m4)),m4);
Deanna Hood41b717d2015-03-18 03:11:03 +1000530 VERIFY((abs(m1) == m1 || abs(m1) == -m1).all());
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800531 VERIFY_IS_APPROX(m3, sqrt(abs2(m3)));
Joel Holdsworthd5c66572020-03-19 17:45:20 +0000532 VERIFY_IS_APPROX(m1.absolute_difference(m2), (m1 > m2).select(m1 - m2, m2 - m1));
Gael Guennebaud3f32f5e2015-11-27 16:27:53 +0100533 VERIFY_IS_APPROX( m1.sign(), -(-m1).sign() );
534 VERIFY_IS_APPROX( m1*m1.sign(),m1.abs());
535 VERIFY_IS_APPROX(m1.sign() * m1.abs(), m1);
Benoit Jacob5d63d2c2010-04-28 22:42:34 -0400536
Gael Guennebaud62670c82013-06-10 23:40:56 +0200537 VERIFY_IS_APPROX(numext::abs2(numext::real(m1)) + numext::abs2(numext::imag(m1)), numext::abs2(m1));
Gael Guennebaud87427d22019-10-08 09:15:17 +0200538 VERIFY_IS_APPROX(numext::abs2(Eigen::real(m1)) + numext::abs2(Eigen::imag(m1)), numext::abs2(m1));
Benoit Jacob5d63d2c2010-04-28 22:42:34 -0400539 if(!NumTraits<Scalar>::IsComplex)
Gael Guennebaud62670c82013-06-10 23:40:56 +0200540 VERIFY_IS_APPROX(numext::real(m1), m1);
Gael Guennebaud4ebb8042010-06-02 09:45:57 +0200541
Jitse Niesen6fecb6f2014-02-24 14:10:17 +0000542 // shift argument of logarithm so that it is not zero
543 Scalar smallNumber = NumTraits<Scalar>::dummy_precision();
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800544 VERIFY_IS_APPROX((m3 + smallNumber).log() , log(abs(m3) + smallNumber));
545 VERIFY_IS_APPROX((m3 + smallNumber + Scalar(1)).log() , log1p(abs(m3) + smallNumber));
Gael Guennebaud4ebb8042010-06-02 09:45:57 +0200546
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100547 VERIFY_IS_APPROX(m1.exp() * m2.exp(), exp(m1+m2));
548 VERIFY_IS_APPROX(m1.exp(), exp(m1));
549 VERIFY_IS_APPROX(m1.exp() / m2.exp(),(m1-m2).exp());
Gael Guennebaud575ac542010-06-19 23:17:07 +0200550
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800551 VERIFY_IS_APPROX(m1.expm1(), expm1(m1));
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800552 VERIFY_IS_APPROX((m3 + smallNumber).exp() - Scalar(1), expm1(abs(m3) + smallNumber));
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800553
Gael Guennebaud575ac542010-06-19 23:17:07 +0200554 VERIFY_IS_APPROX(m3.pow(RealScalar(0.5)), m3.sqrt());
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100555 VERIFY_IS_APPROX(pow(m3,RealScalar(0.5)), m3.sqrt());
Benoit Steinere25e3a02015-12-03 18:16:35 -0800556
557 VERIFY_IS_APPROX(m3.pow(RealScalar(-0.5)), m3.rsqrt());
558 VERIFY_IS_APPROX(pow(m3,RealScalar(-0.5)), m3.rsqrt());
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800559
560 // Avoid inf and NaN.
561 m3 = (m1.square()<NumTraits<Scalar>::epsilon()).select(Scalar(1),m3);
562 VERIFY_IS_APPROX(m3.pow(RealScalar(-2)), m3.square().inverse());
Rasmus Munk Larsencdd8fdc2021-01-18 13:25:16 +0000563 pow_test<Scalar>();
Benoit Steinere25e3a02015-12-03 18:16:35 -0800564
Charles Schlossere5af9f82022-08-29 19:23:54 +0000565 typedef typename internal::make_integer<Scalar>::type SignedInt;
566 typedef typename std::make_unsigned<SignedInt>::type UnsignedInt;
567
568 int_pow_test<SignedInt, SignedInt>();
569 int_pow_test<SignedInt, UnsignedInt>();
570 int_pow_test<UnsignedInt, SignedInt>();
571 int_pow_test<UnsignedInt, UnsignedInt>();
572
Antonio Sanchez4c42d5e2021-01-23 11:54:00 -0800573 VERIFY_IS_APPROX(log10(m3), log(m3)/numext::log(Scalar(10)));
574 VERIFY_IS_APPROX(log2(m3), log(m3)/numext::log(Scalar(2)));
Hauke Heibel81c13362012-03-07 08:58:42 +0100575
576 // scalar by array division
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100577 const RealScalar tiny = sqrt(std::numeric_limits<RealScalar>::epsilon());
Hauke Heibeldd9365e2012-03-09 14:04:13 +0100578 s1 += Scalar(tiny);
579 m1 += ArrayType::Constant(rows,cols,Scalar(tiny));
Rasmus Munk Larsen96dc37a2022-01-07 01:10:17 +0000580 VERIFY_IS_CWISE_APPROX(s1/m1, s1 * m1.inverse());
Eugene Brevdof7362772015-12-24 21:15:38 -0800581
Gael Guennebaudc695cbf2013-06-24 13:33:44 +0200582 // check inplace transpose
583 m3 = m1;
584 m3.transposeInPlace();
Deanna Hood41b717d2015-03-18 03:11:03 +1000585 VERIFY_IS_APPROX(m3, m1.transpose());
Gael Guennebaudc695cbf2013-06-24 13:33:44 +0200586 m3.transposeInPlace();
Deanna Hood41b717d2015-03-18 03:11:03 +1000587 VERIFY_IS_APPROX(m3, m1);
Gael Guennebaud0ce5bc02010-01-27 23:23:59 +0100588}
589
Jitse Niesen837db082011-05-09 10:17:41 +0100590template<typename ArrayType> void array_complex(const ArrayType& m)
591{
Deanna Hood41b717d2015-03-18 03:11:03 +1000592 typedef typename ArrayType::Scalar Scalar;
593 typedef typename NumTraits<Scalar>::Real RealScalar;
Jitse Niesen837db082011-05-09 10:17:41 +0100594
595 Index rows = m.rows();
596 Index cols = m.cols();
597
598 ArrayType m1 = ArrayType::Random(rows, cols),
Gael Guennebaud9fc1c922015-06-22 16:48:27 +0200599 m2(rows, cols),
600 m4 = m1;
Srinivas Vasudevan218764e2016-12-02 14:13:01 -0800601
Gael Guennebaud9fc1c922015-06-22 16:48:27 +0200602 m4.real() = (m4.real().abs()==RealScalar(0)).select(RealScalar(1),m4.real());
603 m4.imag() = (m4.imag().abs()==RealScalar(0)).select(RealScalar(1),m4.imag());
Jitse Niesen837db082011-05-09 10:17:41 +0100604
Deanna Hood41b717d2015-03-18 03:11:03 +1000605 Array<RealScalar, -1, -1> m3(rows, cols);
606
Jitse Niesen837db082011-05-09 10:17:41 +0100607 for (Index i = 0; i < m.rows(); ++i)
608 for (Index j = 0; j < m.cols(); ++j)
Gael Guennebauda76fbbf2012-11-06 15:25:50 +0100609 m2(i,j) = sqrt(m1(i,j));
Jitse Niesen837db082011-05-09 10:17:41 +0100610
Deanna Hood41b717d2015-03-18 03:11:03 +1000611 // these tests are mostly to check possible compilation issues with free-functions.
Deanna Hoodf89fcef2015-03-11 13:13:30 +1000612 VERIFY_IS_APPROX(m1.sin(), sin(m1));
613 VERIFY_IS_APPROX(m1.cos(), cos(m1));
614 VERIFY_IS_APPROX(m1.tan(), tan(m1));
615 VERIFY_IS_APPROX(m1.sinh(), sinh(m1));
616 VERIFY_IS_APPROX(m1.cosh(), cosh(m1));
617 VERIFY_IS_APPROX(m1.tanh(), tanh(m1));
Rasmus Munk Larsend6e283b2018-08-13 11:14:50 -0700618 VERIFY_IS_APPROX(m1.logistic(), logistic(m1));
Deanna Hood41b717d2015-03-18 03:11:03 +1000619 VERIFY_IS_APPROX(m1.arg(), arg(m1));
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200620 VERIFY((m1.isNaN() == (Eigen::isnan)(m1)).all());
621 VERIFY((m1.isInf() == (Eigen::isinf)(m1)).all());
622 VERIFY((m1.isFinite() == (Eigen::isfinite)(m1)).all());
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800623 VERIFY_IS_APPROX(m4.inverse(), inverse(m4));
Deanna Hood41b717d2015-03-18 03:11:03 +1000624 VERIFY_IS_APPROX(m1.log(), log(m1));
625 VERIFY_IS_APPROX(m1.log10(), log10(m1));
Rasmus Munk Larsenf9fac1d2020-12-04 21:45:09 +0000626 VERIFY_IS_APPROX(m1.log2(), log2(m1));
Deanna Hood41b717d2015-03-18 03:11:03 +1000627 VERIFY_IS_APPROX(m1.abs(), abs(m1));
628 VERIFY_IS_APPROX(m1.abs2(), abs2(m1));
629 VERIFY_IS_APPROX(m1.sqrt(), sqrt(m1));
630 VERIFY_IS_APPROX(m1.square(), square(m1));
631 VERIFY_IS_APPROX(m1.cube(), cube(m1));
632 VERIFY_IS_APPROX(cos(m1+RealScalar(3)*m2), cos((m1+RealScalar(3)*m2).eval()));
Gael Guennebaud3f32f5e2015-11-27 16:27:53 +0100633 VERIFY_IS_APPROX(m1.sign(), sign(m1));
Deanna Hood41b717d2015-03-18 03:11:03 +1000634
635
636 VERIFY_IS_APPROX(m1.exp() * m2.exp(), exp(m1+m2));
637 VERIFY_IS_APPROX(m1.exp(), exp(m1));
638 VERIFY_IS_APPROX(m1.exp() / m2.exp(),(m1-m2).exp());
639
Srinivas Vasudevan88062b72019-12-12 01:56:54 +0000640 VERIFY_IS_APPROX(m1.expm1(), expm1(m1));
641 VERIFY_IS_APPROX(expm1(m1), exp(m1) - 1.);
642 // Check for larger magnitude complex numbers that expm1 matches exp - 1.
643 VERIFY_IS_APPROX(expm1(10. * m1), exp(10. * m1) - 1.);
644
Deanna Hood41b717d2015-03-18 03:11:03 +1000645 VERIFY_IS_APPROX(sinh(m1), 0.5*(exp(m1)-exp(-m1)));
646 VERIFY_IS_APPROX(cosh(m1), 0.5*(exp(m1)+exp(-m1)));
647 VERIFY_IS_APPROX(tanh(m1), (0.5*(exp(m1)-exp(-m1)))/(0.5*(exp(m1)+exp(-m1))));
Rasmus Munk Larsend6e283b2018-08-13 11:14:50 -0700648 VERIFY_IS_APPROX(logistic(m1), (1.0/(1.0 + exp(-m1))));
Deanna Hood41b717d2015-03-18 03:11:03 +1000649
650 for (Index i = 0; i < m.rows(); ++i)
651 for (Index j = 0; j < m.cols(); ++j)
Gael Guennebaud87427d22019-10-08 09:15:17 +0200652 m3(i,j) = std::atan2(m1(i,j).imag(), m1(i,j).real());
Deanna Hood41b717d2015-03-18 03:11:03 +1000653 VERIFY_IS_APPROX(arg(m1), m3);
654
655 std::complex<RealScalar> zero(0.0,0.0);
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200656 VERIFY((Eigen::isnan)(m1*zero/zero).all());
Gael Guennebaud4a985e72015-11-20 14:52:08 +0100657#if EIGEN_COMP_MSVC
658 // msvc complex division is not robust
659 VERIFY((Eigen::isinf)(m4/RealScalar(0)).all());
660#else
Gael Guennebaud40f326e2015-06-17 15:33:09 +0200661#if EIGEN_COMP_CLANG
Gael Guennebaud4a985e72015-11-20 14:52:08 +0100662 // clang's complex division is notoriously broken too
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200663 if((numext::isinf)(m4(0,0)/RealScalar(0))) {
Gael Guennebaud40f326e2015-06-17 15:33:09 +0200664#endif
Gael Guennebaud4a985e72015-11-20 14:52:08 +0100665 VERIFY((Eigen::isinf)(m4/zero).all());
Gael Guennebaud40f326e2015-06-17 15:33:09 +0200666#if EIGEN_COMP_CLANG
667 }
668 else
669 {
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200670 VERIFY((Eigen::isinf)(m4.real()/zero.real()).all());
Gael Guennebaud40f326e2015-06-17 15:33:09 +0200671 }
672#endif
Gael Guennebaud4a985e72015-11-20 14:52:08 +0100673#endif // MSVC
674
Christoph Hertzberg61e09772015-08-14 17:32:34 +0200675 VERIFY(((Eigen::isfinite)(m1) && (!(Eigen::isfinite)(m1*zero/zero)) && (!(Eigen::isfinite)(m1/zero))).all());
Deanna Hood41b717d2015-03-18 03:11:03 +1000676
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800677 VERIFY_IS_APPROX(inverse(inverse(m4)),m4);
Deanna Hood41b717d2015-03-18 03:11:03 +1000678 VERIFY_IS_APPROX(conj(m1.conjugate()), m1);
Gael Guennebaud87427d22019-10-08 09:15:17 +0200679 VERIFY_IS_APPROX(abs(m1), sqrt(square(m1.real())+square(m1.imag())));
Deanna Hood41b717d2015-03-18 03:11:03 +1000680 VERIFY_IS_APPROX(abs(m1), sqrt(abs2(m1)));
681 VERIFY_IS_APPROX(log10(m1), log(m1)/log(10));
Rasmus Munk Larsenf9fac1d2020-12-04 21:45:09 +0000682 VERIFY_IS_APPROX(log2(m1), log(m1)/log(2));
Deanna Hood41b717d2015-03-18 03:11:03 +1000683
Gael Guennebaud3f32f5e2015-11-27 16:27:53 +0100684 VERIFY_IS_APPROX( m1.sign(), -(-m1).sign() );
685 VERIFY_IS_APPROX( m1.sign() * m1.abs(), m1);
686
Deanna Hood41b717d2015-03-18 03:11:03 +1000687 // scalar by array division
Eugene Brevdof7362772015-12-24 21:15:38 -0800688 Scalar s1 = internal::random<Scalar>();
Benoit Steiner2d74ef92016-05-17 07:20:11 -0700689 const RealScalar tiny = std::sqrt(std::numeric_limits<RealScalar>::epsilon());
Deanna Hood41b717d2015-03-18 03:11:03 +1000690 s1 += Scalar(tiny);
691 m1 += ArrayType::Constant(rows,cols,Scalar(tiny));
692 VERIFY_IS_APPROX(s1/m1, s1 * m1.inverse());
693
694 // check inplace transpose
695 m2 = m1;
696 m2.transposeInPlace();
697 VERIFY_IS_APPROX(m2, m1.transpose());
698 m2.transposeInPlace();
699 VERIFY_IS_APPROX(m2, m1);
Rasmus Munk Larsenb47c7772020-04-27 18:55:15 -0700700 // Check vectorized inplace transpose.
Rasmus Munk Larsen74ec8e62020-05-07 17:29:56 +0000701 ArrayType m5 = ArrayType::Random(131, 131);
Rasmus Munk Larsenb47c7772020-04-27 18:55:15 -0700702 ArrayType m6 = m5;
703 m6.transposeInPlace();
704 VERIFY_IS_APPROX(m6, m5.transpose());
Jitse Niesen837db082011-05-09 10:17:41 +0100705}
706
Abraham Bachrach039408c2012-01-11 11:00:30 -0500707template<typename ArrayType> void min_max(const ArrayType& m)
708{
Abraham Bachrach039408c2012-01-11 11:00:30 -0500709 typedef typename ArrayType::Scalar Scalar;
710
711 Index rows = m.rows();
712 Index cols = m.cols();
713
714 ArrayType m1 = ArrayType::Random(rows, cols);
715
716 // min/max with array
717 Scalar maxM1 = m1.maxCoeff();
718 Scalar minM1 = m1.minCoeff();
719
720 VERIFY_IS_APPROX(ArrayType::Constant(rows,cols, minM1), (m1.min)(ArrayType::Constant(rows,cols, minM1)));
721 VERIFY_IS_APPROX(m1, (m1.min)(ArrayType::Constant(rows,cols, maxM1)));
722
723 VERIFY_IS_APPROX(ArrayType::Constant(rows,cols, maxM1), (m1.max)(ArrayType::Constant(rows,cols, maxM1)));
724 VERIFY_IS_APPROX(m1, (m1.max)(ArrayType::Constant(rows,cols, minM1)));
725
726 // min/max with scalar input
727 VERIFY_IS_APPROX(ArrayType::Constant(rows,cols, minM1), (m1.min)( minM1));
728 VERIFY_IS_APPROX(m1, (m1.min)( maxM1));
729
730 VERIFY_IS_APPROX(ArrayType::Constant(rows,cols, maxM1), (m1.max)( maxM1));
731 VERIFY_IS_APPROX(m1, (m1.max)( minM1));
732
Rasmus Munk Larsen841c8982021-02-24 17:49:20 -0800733
734 // min/max with various NaN propagation options.
735 if (m1.size() > 1 && !NumTraits<Scalar>::IsInteger) {
Antonio Sanchez8dfe1022021-03-16 20:12:46 -0700736 m1(0,0) = NumTraits<Scalar>::quiet_NaN();
Rasmus Munk Larsen841c8982021-02-24 17:49:20 -0800737 maxM1 = m1.template maxCoeff<PropagateNaN>();
738 minM1 = m1.template minCoeff<PropagateNaN>();
739 VERIFY((numext::isnan)(maxM1));
740 VERIFY((numext::isnan)(minM1));
741
742 maxM1 = m1.template maxCoeff<PropagateNumbers>();
743 minM1 = m1.template minCoeff<PropagateNumbers>();
744 VERIFY(!(numext::isnan)(maxM1));
745 VERIFY(!(numext::isnan)(minM1));
746 }
Abraham Bachrach039408c2012-01-11 11:00:30 -0500747}
748
Antonio Sanchezfc9d3522021-08-17 20:04:48 -0700749template<int N>
750struct shift_left {
751 template<typename Scalar>
752 Scalar operator()(const Scalar& v) const {
753 return v << N;
754 }
755};
756
757template<int N>
758struct arithmetic_shift_right {
759 template<typename Scalar>
760 Scalar operator()(const Scalar& v) const {
761 return v >> N;
762 }
763};
764
765template<typename ArrayType> void array_integer(const ArrayType& m)
766{
767 Index rows = m.rows();
768 Index cols = m.cols();
769
770 ArrayType m1 = ArrayType::Random(rows, cols),
771 m2(rows, cols);
772
773 m2 = m1.template shiftLeft<2>();
774 VERIFY( (m2 == m1.unaryExpr(shift_left<2>())).all() );
775 m2 = m1.template shiftLeft<9>();
776 VERIFY( (m2 == m1.unaryExpr(shift_left<9>())).all() );
777
778 m2 = m1.template shiftRight<2>();
779 VERIFY( (m2 == m1.unaryExpr(arithmetic_shift_right<2>())).all() );
780 m2 = m1.template shiftRight<9>();
781 VERIFY( (m2 == m1.unaryExpr(arithmetic_shift_right<9>())).all() );
782}
783
Gael Guennebaude0f6d352018-09-20 18:07:32 +0200784EIGEN_DECLARE_TEST(array_cwise)
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000785{
786 for(int i = 0; i < g_repeat; i++) {
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100787 CALL_SUBTEST_1( array(Array<float, 1, 1>()) );
Hauke Heibelb31e1242010-12-16 19:07:23 +0100788 CALL_SUBTEST_2( array(Array22f()) );
789 CALL_SUBTEST_3( array(Array44d()) );
Gael Guennebauda8f66fe2011-07-12 14:41:00 +0200790 CALL_SUBTEST_4( array(ArrayXXcf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
791 CALL_SUBTEST_5( array(ArrayXXf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
792 CALL_SUBTEST_6( array(ArrayXXi(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Gael Guennebaud543529d2019-01-22 15:30:50 +0100793 CALL_SUBTEST_6( array(Array<Index,Dynamic,Dynamic>(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Antonio Sanchezfc9d3522021-08-17 20:04:48 -0700794 CALL_SUBTEST_6( array_integer(ArrayXXi(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
795 CALL_SUBTEST_6( array_integer(Array<Index,Dynamic,Dynamic>(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000796 }
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100797 for(int i = 0; i < g_repeat; i++) {
798 CALL_SUBTEST_1( comparisons(Array<float, 1, 1>()) );
Hauke Heibelb31e1242010-12-16 19:07:23 +0100799 CALL_SUBTEST_2( comparisons(Array22f()) );
800 CALL_SUBTEST_3( comparisons(Array44d()) );
Gael Guennebauda8f66fe2011-07-12 14:41:00 +0200801 CALL_SUBTEST_5( comparisons(ArrayXXf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
802 CALL_SUBTEST_6( comparisons(ArrayXXi(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100803 }
804 for(int i = 0; i < g_repeat; i++) {
Abraham Bachrach039408c2012-01-11 11:00:30 -0500805 CALL_SUBTEST_1( min_max(Array<float, 1, 1>()) );
806 CALL_SUBTEST_2( min_max(Array22f()) );
807 CALL_SUBTEST_3( min_max(Array44d()) );
808 CALL_SUBTEST_5( min_max(ArrayXXf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
809 CALL_SUBTEST_6( min_max(ArrayXXi(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
810 }
811 for(int i = 0; i < g_repeat; i++) {
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100812 CALL_SUBTEST_1( array_real(Array<float, 1, 1>()) );
Hauke Heibelb31e1242010-12-16 19:07:23 +0100813 CALL_SUBTEST_2( array_real(Array22f()) );
814 CALL_SUBTEST_3( array_real(Array44d()) );
Gael Guennebauda8f66fe2011-07-12 14:41:00 +0200815 CALL_SUBTEST_5( array_real(ArrayXXf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Antonio Sanchezf0e46ed2021-01-22 11:10:54 -0800816 CALL_SUBTEST_7( array_real(Array<Eigen::half, 32, 32>()) );
817 CALL_SUBTEST_8( array_real(Array<Eigen::bfloat16, 32, 32>()) );
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100818 }
Jitse Niesen837db082011-05-09 10:17:41 +0100819 for(int i = 0; i < g_repeat; i++) {
Gael Guennebauda8f66fe2011-07-12 14:41:00 +0200820 CALL_SUBTEST_4( array_complex(ArrayXXcf(internal::random<int>(1,EIGEN_TEST_MAX_SIZE), internal::random<int>(1,EIGEN_TEST_MAX_SIZE))) );
Jitse Niesen837db082011-05-09 10:17:41 +0100821 }
Benoit Jacob5d63d2c2010-04-28 22:42:34 -0400822
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100823 VERIFY((internal::is_same< internal::global_math_functions_filtering_base<int>::type, int >::value));
824 VERIFY((internal::is_same< internal::global_math_functions_filtering_base<float>::type, float >::value));
825 VERIFY((internal::is_same< internal::global_math_functions_filtering_base<Array2i>::type, ArrayBase<Array2i> >::value));
Gael Guennebaud64fcfd32016-06-14 11:26:57 +0200826 typedef CwiseUnaryOp<internal::scalar_abs_op<double>, ArrayXd > Xpr;
Hauke Heibel2d0dfe52010-12-16 17:36:10 +0100827 VERIFY((internal::is_same< internal::global_math_functions_filtering_base<Xpr>::type,
828 ArrayBase<Xpr>
829 >::value));
Gael Guennebaud8cef5412008-06-21 17:28:07 +0000830}