1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2010 Hauke Heibel <hauke.heibel@gmail.com>
5 // Copyright (C) 2015 Gael Guennebaud <gael.guennebaud@inria.fr>
6 //
7 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 #define TEST_ENABLE_TEMPORARY_TRACKING
12 
13 #include "main.h"
14 
15 template <int N, typename XprType>
use_n_times(const XprType & xpr)16 void use_n_times(const XprType &xpr)
17 {
18   typename internal::nested_eval<XprType,N>::type mat(xpr);
19   typename XprType::PlainObject res(mat.rows(), mat.cols());
20   nb_temporaries--; // remove res
21   res.setZero();
22   for(int i=0; i<N; ++i)
23     res += mat;
24 }
25 
26 template <int N, typename ReferenceType, typename XprType>
verify_eval_type(const XprType &,const ReferenceType &)27 bool verify_eval_type(const XprType &, const ReferenceType&)
28 {
29   typedef typename internal::nested_eval<XprType,N>::type EvalType;
30   return internal::is_same<typename internal::remove_all<EvalType>::type, typename internal::remove_all<ReferenceType>::type>::value;
31 }
32 
run_nesting_ops_1(const MatrixType & _m)33 template <typename MatrixType> void run_nesting_ops_1(const MatrixType& _m)
34 {
35   typename internal::nested_eval<MatrixType,2>::type m(_m);
36 
37   // Make really sure that we are in debug mode!
38   VERIFY_RAISES_ASSERT(eigen_assert(false));
39 
40   // The only intention of these tests is to ensure that this code does
41   // not trigger any asserts or segmentation faults... more to come.
42   VERIFY_IS_APPROX( (m.transpose() * m).diagonal().sum(), (m.transpose() * m).diagonal().sum() );
43   VERIFY_IS_APPROX( (m.transpose() * m).diagonal().array().abs().sum(), (m.transpose() * m).diagonal().array().abs().sum() );
44 
45   VERIFY_IS_APPROX( (m.transpose() * m).array().abs().sum(), (m.transpose() * m).array().abs().sum() );
46 }
47 
run_nesting_ops_2(const MatrixType & _m)48 template <typename MatrixType> void run_nesting_ops_2(const MatrixType& _m)
49 {
50   typedef typename MatrixType::Scalar Scalar;
51   Index rows = _m.rows();
52   Index cols = _m.cols();
53   MatrixType m1 = MatrixType::Random(rows,cols);
54   Matrix<Scalar,MatrixType::RowsAtCompileTime,MatrixType::ColsAtCompileTime,ColMajor> m2;
55 
56   if((MatrixType::SizeAtCompileTime==Dynamic))
57   {
58     VERIFY_EVALUATION_COUNT( use_n_times<1>(m1 + m1*m1), 1 );
59     VERIFY_EVALUATION_COUNT( use_n_times<10>(m1 + m1*m1), 1 );
60 
61     VERIFY_EVALUATION_COUNT( use_n_times<1>(m1.template triangularView<Lower>().solve(m1.col(0))), 1 );
62     VERIFY_EVALUATION_COUNT( use_n_times<10>(m1.template triangularView<Lower>().solve(m1.col(0))), 1 );
63 
64     VERIFY_EVALUATION_COUNT( use_n_times<1>(Scalar(2)*m1.template triangularView<Lower>().solve(m1.col(0))), 2 ); // FIXME could be one by applying the scaling in-place on the solve result
65     VERIFY_EVALUATION_COUNT( use_n_times<1>(m1.col(0)+m1.template triangularView<Lower>().solve(m1.col(0))), 2 ); // FIXME could be one by adding m1.col() inplace
66     VERIFY_EVALUATION_COUNT( use_n_times<10>(m1.col(0)+m1.template triangularView<Lower>().solve(m1.col(0))), 2 );
67   }
68 
69   {
70     VERIFY( verify_eval_type<10>(m1, m1) );
71     if(!NumTraits<Scalar>::IsComplex)
72     {
73       VERIFY( verify_eval_type<3>(2*m1, 2*m1) );
74       VERIFY( verify_eval_type<4>(2*m1, m1) );
75     }
76     else
77     {
78       VERIFY( verify_eval_type<2>(2*m1, 2*m1) );
79       VERIFY( verify_eval_type<3>(2*m1, m1) );
80     }
81     VERIFY( verify_eval_type<2>(m1+m1, m1+m1) );
82     VERIFY( verify_eval_type<3>(m1+m1, m1) );
83     VERIFY( verify_eval_type<1>(m1*m1.transpose(), m2) );
84     VERIFY( verify_eval_type<1>(m1*(m1+m1).transpose(), m2) );
85     VERIFY( verify_eval_type<2>(m1*m1.transpose(), m2) );
86     VERIFY( verify_eval_type<1>(m1+m1*m1, m1) );
87 
88     VERIFY( verify_eval_type<1>(m1.template triangularView<Lower>().solve(m1), m1) );
89     VERIFY( verify_eval_type<1>(m1+m1.template triangularView<Lower>().solve(m1), m1) );
90   }
91 }
92 
93 
test_nesting_ops()94 void test_nesting_ops()
95 {
96   CALL_SUBTEST_1(run_nesting_ops_1(MatrixXf::Random(25,25)));
97   CALL_SUBTEST_2(run_nesting_ops_1(MatrixXcd::Random(25,25)));
98   CALL_SUBTEST_3(run_nesting_ops_1(Matrix4f::Random()));
99   CALL_SUBTEST_4(run_nesting_ops_1(Matrix2d::Random()));
100 
101   Index s = internal::random<int>(1,EIGEN_TEST_MAX_SIZE);
102   CALL_SUBTEST_1( run_nesting_ops_2(MatrixXf(s,s)) );
103   CALL_SUBTEST_2( run_nesting_ops_2(MatrixXcd(s,s)) );
104   CALL_SUBTEST_3( run_nesting_ops_2(Matrix4f()) );
105   CALL_SUBTEST_4( run_nesting_ops_2(Matrix2d()) );
106   TEST_SET_BUT_UNUSED_VARIABLE(s)
107 }
108