Macros | Functions | Variables
sparse_ref.cpp File Reference
#include "main.h"
#include <Eigen/SparseCore>

Macros

#define EIGEN_SPARSE_CREATE_TEMPORARY_PLUGIN    { on_temporary_creation(); }
 
#define VERIFY_EVALUATION_COUNT(XPR, N)
 

Functions

void on_temporary_creation ()
 
template<typename PlainObjectType >
void check_const_correctness (const PlainObjectType &)
 
template<typename B >
EIGEN_DONT_INLINE void call_ref_1 (Ref< SparseMatrix< float > > a, const B &b)
 
template<typename B >
EIGEN_DONT_INLINE void call_ref_2 (const Ref< const SparseMatrix< float > > &a, const B &b)
 
template<typename B >
EIGEN_DONT_INLINE void call_ref_3 (const Ref< const SparseMatrix< float >, StandardCompressedFormat > &a, const B &b)
 
template<typename B >
EIGEN_DONT_INLINE void call_ref_4 (Ref< SparseVector< float > > a, const B &b)
 
template<typename B >
EIGEN_DONT_INLINE void call_ref_5 (const Ref< const SparseVector< float > > &a, const B &b)
 
void call_ref ()
 
 EIGEN_DECLARE_TEST (sparse_ref)
 

Variables

static long int nb_temporaries
 

Macro Definition Documentation

◆ EIGEN_SPARSE_CREATE_TEMPORARY_PLUGIN

#define EIGEN_SPARSE_CREATE_TEMPORARY_PLUGIN    { on_temporary_creation(); }

◆ VERIFY_EVALUATION_COUNT

#define VERIFY_EVALUATION_COUNT (   XPR,
  N 
)
Value:
{ \
nb_temporaries = 0; \
CALL_SUBTEST(XPR); \
if (nb_temporaries != N) std::cerr << "nb_temporaries == " << nb_temporaries << "\n"; \
VERIFY((#XPR) && nb_temporaries == N); \
}
N
@ N
Definition: constructor.cpp:22
nb_temporaries
static long int nb_temporaries
Definition: sparse_ref.cpp:15

Function Documentation

◆ call_ref()

void call_ref ( )
72  {
73  SparseMatrix<float> A = MatrixXf::Random(10, 10).sparseView(0.5, 1);
74  SparseMatrix<float, RowMajor> B = MatrixXf::Random(10, 10).sparseView(0.5, 1);
75  SparseMatrix<float> C = MatrixXf::Random(10, 10).sparseView(0.5, 1);
76  C.reserve(VectorXi::Constant(C.outerSize(), 2));
77  const SparseMatrix<float> &Ac(A);
78  Block<SparseMatrix<float> > Ab(A, 0, 1, 3, 3);
79  const Block<SparseMatrix<float> > Abc(A, 0, 1, 3, 3);
80  SparseVector<float> vc = VectorXf::Random(10).sparseView(0.5, 1);
81  SparseVector<float, RowMajor> vr = VectorXf::Random(10).sparseView(0.5, 1);
82  SparseMatrix<float> AA = A * A;
83 
84  VERIFY_EVALUATION_COUNT(call_ref_1(A, A), 0);
85  // VERIFY_EVALUATION_COUNT( call_ref_1(Ac, Ac), 0); // does not compile on purpose
86  VERIFY_EVALUATION_COUNT(call_ref_2(A, A), 0);
87  VERIFY_EVALUATION_COUNT(call_ref_3(A, A), 0);
88  VERIFY_EVALUATION_COUNT(call_ref_2(A.transpose(), A.transpose()), 1);
89  VERIFY_EVALUATION_COUNT(call_ref_3(A.transpose(), A.transpose()), 1);
90  VERIFY_EVALUATION_COUNT(call_ref_2(Ac, Ac), 0);
91  VERIFY_EVALUATION_COUNT(call_ref_3(Ac, Ac), 0);
92  VERIFY_EVALUATION_COUNT(call_ref_2(A + A, 2 * Ac), 1);
93  VERIFY_EVALUATION_COUNT(call_ref_3(A + A, 2 * Ac), 1);
94  VERIFY_EVALUATION_COUNT(call_ref_2(B, B), 1);
95  VERIFY_EVALUATION_COUNT(call_ref_3(B, B), 1);
96  VERIFY_EVALUATION_COUNT(call_ref_2(B.transpose(), B.transpose()), 0);
97  VERIFY_EVALUATION_COUNT(call_ref_3(B.transpose(), B.transpose()), 0);
98  VERIFY_EVALUATION_COUNT(call_ref_2(A * A, AA), 3);
99  VERIFY_EVALUATION_COUNT(call_ref_3(A * A, AA), 3);
100 
101  VERIFY(!C.isCompressed());
102  VERIFY_EVALUATION_COUNT(call_ref_3(C, C), 1);
103 
104  Ref<SparseMatrix<float> > Ar(A);
105  VERIFY_IS_APPROX(Ar + Ar, A + A);
106  VERIFY_EVALUATION_COUNT(call_ref_1(Ar, A), 0);
107  VERIFY_EVALUATION_COUNT(call_ref_2(Ar, A), 0);
108 
109  Ref<SparseMatrix<float, RowMajor> > Br(B);
110  VERIFY_EVALUATION_COUNT(call_ref_1(Br.transpose(), Br.transpose()), 0);
111  VERIFY_EVALUATION_COUNT(call_ref_2(Br, Br), 1);
112  VERIFY_EVALUATION_COUNT(call_ref_2(Br.transpose(), Br.transpose()), 0);
113 
114  Ref<const SparseMatrix<float> > Arc(A);
115  // VERIFY_EVALUATION_COUNT( call_ref_1(Arc, Arc), 0); // does not compile on purpose
116  VERIFY_EVALUATION_COUNT(call_ref_2(Arc, Arc), 0);
117 
118  VERIFY_EVALUATION_COUNT(call_ref_2(A.middleCols(1, 3), A.middleCols(1, 3)), 0);
119 
120  VERIFY_EVALUATION_COUNT(call_ref_2(A.col(2), A.col(2)), 0);
121  VERIFY_EVALUATION_COUNT(call_ref_2(vc, vc), 0);
122  VERIFY_EVALUATION_COUNT(call_ref_2(vr.transpose(), vr.transpose()), 0);
123  VERIFY_EVALUATION_COUNT(call_ref_2(vr, vr.transpose()), 0);
124 
125  VERIFY_EVALUATION_COUNT(call_ref_2(A.block(1, 1, 3, 3), A.block(1, 1, 3, 3)),
126  1); // should be 0 (allocate starts/nnz only)
127 
128  VERIFY_EVALUATION_COUNT(call_ref_4(vc, vc), 0);
129  VERIFY_EVALUATION_COUNT(call_ref_4(vr, vr.transpose()), 0);
130  VERIFY_EVALUATION_COUNT(call_ref_5(vc, vc), 0);
131  VERIFY_EVALUATION_COUNT(call_ref_5(vr, vr.transpose()), 0);
132  VERIFY_EVALUATION_COUNT(call_ref_4(A.col(2), A.col(2)), 0);
133  VERIFY_EVALUATION_COUNT(call_ref_5(A.col(2), A.col(2)), 0);
134  // VERIFY_EVALUATION_COUNT( call_ref_4(A.row(2), A.row(2).transpose()), 1); // does not compile on purpose
135  VERIFY_EVALUATION_COUNT(call_ref_5(A.row(2), A.row(2).transpose()), 1);
136 }
A
Matrix< SCALARA, Dynamic, Dynamic, opt_A > A
Definition: bench_gemm.cpp:47
Eigen::Block
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:110
Eigen::Matrix
The matrix class, also used for vectors and row-vectors.
Definition: Eigen/Eigen/src/Core/Matrix.h:186
Eigen::Ref
A matrix or vector expression mapping an existing expression.
Definition: Ref.h:264
Eigen::SparseMatrixBase::transpose
TransposeReturnType transpose()
Definition: SparseMatrixBase.h:358
Eigen::SparseMatrix
A versatible sparse matrix representation.
Definition: SparseMatrix.h:121
Eigen::SparseVector
a sparse vector class
Definition: SparseVector.h:62
oomph::Matrix
Definition: matrices.h:74
VERIFY_IS_APPROX
#define VERIFY_IS_APPROX(a, b)
Definition: integer_types.cpp:13
VERIFY
#define VERIFY(a)
Definition: main.h:362
call_ref_4
EIGEN_DONT_INLINE void call_ref_4(Ref< SparseVector< float > > a, const B &b)
Definition: sparse_ref.cpp:63
call_ref_3
EIGEN_DONT_INLINE void call_ref_3(const Ref< const SparseMatrix< float >, StandardCompressedFormat > &a, const B &b)
Definition: sparse_ref.cpp:57
VERIFY_EVALUATION_COUNT
#define VERIFY_EVALUATION_COUNT(XPR, N)
Definition: sparse_ref.cpp:28
call_ref_1
EIGEN_DONT_INLINE void call_ref_1(Ref< SparseMatrix< float > > a, const B &b)
Definition: sparse_ref.cpp:47
call_ref_5
EIGEN_DONT_INLINE void call_ref_5(const Ref< const SparseVector< float > > &a, const B &b)
Definition: sparse_ref.cpp:68
call_ref_2
EIGEN_DONT_INLINE void call_ref_2(const Ref< const SparseMatrix< float > > &a, const B &b)
Definition: sparse_ref.cpp:52

References call_ref_1(), call_ref_2(), call_ref_3(), call_ref_4(), call_ref_5(), Eigen::SparseMatrixBase< Derived >::transpose(), VERIFY, VERIFY_EVALUATION_COUNT, and VERIFY_IS_APPROX.

Referenced by EIGEN_DECLARE_TEST().

◆ call_ref_1()

template<typename B >
EIGEN_DONT_INLINE void call_ref_1 ( Ref< SparseMatrix< float > >  a,
const B &  b 
)
47  {
48  VERIFY_IS_EQUAL(a.toDense(), b.toDense());
49 }
b
Scalar * b
Definition: benchVecAdd.cpp:17
a
const Scalar * a
Definition: level2_cplx_impl.h:32
VERIFY_IS_EQUAL
#define VERIFY_IS_EQUAL(a, b)
Definition: main.h:367

References a, b, and VERIFY_IS_EQUAL.

Referenced by call_ref().

◆ call_ref_2()

template<typename B >
EIGEN_DONT_INLINE void call_ref_2 ( const Ref< const SparseMatrix< float > > &  a,
const B &  b 
)
52  {
53  VERIFY_IS_EQUAL(a.toDense(), b.toDense());
54 }

References a, b, and VERIFY_IS_EQUAL.

Referenced by call_ref().

◆ call_ref_3()

template<typename B >
EIGEN_DONT_INLINE void call_ref_3 ( const Ref< const SparseMatrix< float >, StandardCompressedFormat > &  a,
const B &  b 
)
57  {
58  VERIFY(a.isCompressed());
59  VERIFY_IS_EQUAL(a.toDense(), b.toDense());
60 }

References a, b, VERIFY, and VERIFY_IS_EQUAL.

Referenced by call_ref().

◆ call_ref_4()

template<typename B >
EIGEN_DONT_INLINE void call_ref_4 ( Ref< SparseVector< float > >  a,
const B &  b 
)
63  {
64  VERIFY_IS_EQUAL(a.toDense(), b.toDense());
65 }

References a, b, and VERIFY_IS_EQUAL.

Referenced by call_ref().

◆ call_ref_5()

template<typename B >
EIGEN_DONT_INLINE void call_ref_5 ( const Ref< const SparseVector< float > > &  a,
const B &  b 
)
68  {
69  VERIFY_IS_EQUAL(a.toDense(), b.toDense());
70 }

References a, b, and VERIFY_IS_EQUAL.

Referenced by call_ref().

◆ check_const_correctness()

template<typename PlainObjectType >
void check_const_correctness ( const PlainObjectType &  )
37  {
38  // verify that ref-to-const don't have LvalueBit
39  typedef std::add_const_t<PlainObjectType> ConstPlainObjectType;
40  VERIFY(!(internal::traits<Ref<ConstPlainObjectType> >::Flags & LvalueBit));
41  VERIFY(!(internal::traits<Ref<ConstPlainObjectType, Aligned> >::Flags & LvalueBit));
42  VERIFY(!(Ref<ConstPlainObjectType>::Flags & LvalueBit));
43  VERIFY(!(Ref<ConstPlainObjectType, Aligned>::Flags & LvalueBit));
44 }
Eigen::LvalueBit
const unsigned int LvalueBit
Definition: Constants.h:148
Flags
Extend namespace for flags.
Definition: fsi_chan_precond_driver.cc:56

References Eigen::LvalueBit, and VERIFY.

Referenced by EIGEN_DECLARE_TEST().

◆ EIGEN_DECLARE_TEST()

EIGEN_DECLARE_TEST ( sparse_ref  )
138  {
139  for (int i = 0; i < g_repeat; i++) {
140  CALL_SUBTEST_1(check_const_correctness(SparseMatrix<float>()));
141  CALL_SUBTEST_1(check_const_correctness(SparseMatrix<double, RowMajor>()));
142  CALL_SUBTEST_2(call_ref());
143 
144  CALL_SUBTEST_3(check_const_correctness(SparseVector<float>()));
145  CALL_SUBTEST_3(check_const_correctness(SparseVector<double, RowMajor>()));
146  }
147 }
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9
Eigen::g_repeat
static int g_repeat
Definition: main.h:191
call_ref
void call_ref()
Definition: sparse_ref.cpp:72
check_const_correctness
void check_const_correctness(const PlainObjectType &)
Definition: sparse_ref.cpp:37
CALL_SUBTEST_3
#define CALL_SUBTEST_3(FUNC)
Definition: split_test_helper.h:16
CALL_SUBTEST_1
#define CALL_SUBTEST_1(FUNC)
Definition: split_test_helper.h:4
CALL_SUBTEST_2
#define CALL_SUBTEST_2(FUNC)
Definition: split_test_helper.h:10

References call_ref(), CALL_SUBTEST_1, CALL_SUBTEST_2, CALL_SUBTEST_3, check_const_correctness(), Eigen::g_repeat, and i.

◆ on_temporary_creation()

void on_temporary_creation ( )
inline
17  {
18  // here's a great place to set a breakpoint when debugging failures in this test!
19  nb_temporaries++;
20 }

References nb_temporaries.

Variable Documentation

◆ nb_temporaries

long int nb_temporaries
static

Referenced by on_temporary_creation().