blob: 10309b3a993d9ff56e9f62d1af93444c7931d87c [file] [log] [blame]
Gael Guennebaud86ccd992008-11-05 13:47:55 +00001// This file is part of Eigen, a lightweight C++ template library
Benoit Jacob6347b1d2009-05-22 20:25:33 +02002// for linear algebra.
Gael Guennebaud86ccd992008-11-05 13:47:55 +00003//
Gael Guennebaud22c76092011-03-22 11:58:22 +01004// Copyright (C) 2008-2011 Gael Guennebaud <gael.guennebaud@inria.fr>
Gael Guennebaud86ccd992008-11-05 13:47:55 +00005// Copyright (C) 2008 Daniel Gomez Ferro <dgomezferro@gmail.com>
Desire NUENTSA4cd82452013-06-11 14:42:29 +02006// Copyright (C) 2013 Désiré Nuentsa-Wakam <desire.nuentsa_wakam@inria.fr>
Gael Guennebaud86ccd992008-11-05 13:47:55 +00007//
Benoit Jacob69124cf2012-07-13 14:42:47 -04008// This Source Code Form is subject to the terms of the Mozilla
9// Public License v. 2.0. If a copy of the MPL was not distributed
10// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Gael Guennebaud86ccd992008-11-05 13:47:55 +000011
Gael Guennebaudc43154b2015-03-04 10:16:46 +010012static long g_realloc_count = 0;
13#define EIGEN_SPARSE_COMPRESSED_STORAGE_REALLOCATE_PLUGIN g_realloc_count++;
14
Gael Guennebaud86ccd992008-11-05 13:47:55 +000015#include "sparse.h"
16
Gael Guennebaud178858f2009-01-19 15:20:45 +000017template<typename SparseMatrixType> void sparse_basic(const SparseMatrixType& ref)
18{
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +010019 typedef typename SparseMatrixType::StorageIndex StorageIndex;
20 typedef Matrix<StorageIndex,2,1> Vector2;
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +020021
Gael Guennebaudfc202ba2015-02-13 18:57:41 +010022 const Index rows = ref.rows();
23 const Index cols = ref.cols();
Gael Guennebaud0a537cb2016-02-12 15:58:31 +010024 //const Index inner = ref.innerSize();
25 //const Index outer = ref.outerSize();
Christoph Hertzberg0833b822014-10-31 17:12:13 +010026
Gael Guennebaud178858f2009-01-19 15:20:45 +000027 typedef typename SparseMatrixType::Scalar Scalar;
28 enum { Flags = SparseMatrixType::Flags };
Gael Guennebaud9f795582009-12-16 19:18:40 +010029
Gael Guennebaud42e25782011-08-19 14:18:05 +020030 double density = (std::max)(8./(rows*cols), 0.01);
Gael Guennebaud86ccd992008-11-05 13:47:55 +000031 typedef Matrix<Scalar,Dynamic,Dynamic> DenseMatrix;
32 typedef Matrix<Scalar,Dynamic,1> DenseVector;
33 Scalar eps = 1e-6;
34
Benoit Jacob47160402010-10-25 10:15:22 -040035 Scalar s1 = internal::random<Scalar>();
Gael Guennebaud86ccd992008-11-05 13:47:55 +000036 {
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020037 SparseMatrixType m(rows, cols);
38 DenseMatrix refMat = DenseMatrix::Zero(rows, cols);
39 DenseVector vec1 = DenseVector::Random(rows);
Gael Guennebaud86ccd992008-11-05 13:47:55 +000040
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +020041 std::vector<Vector2> zeroCoords;
42 std::vector<Vector2> nonzeroCoords;
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020043 initSparse<Scalar>(density, refMat, m, 0, &zeroCoords, &nonzeroCoords);
Gael Guennebaud86ccd992008-11-05 13:47:55 +000044
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020045 // test coeff and coeffRef
Christoph Hertzberg0833b822014-10-31 17:12:13 +010046 for (std::size_t i=0; i<zeroCoords.size(); ++i)
Gael Guennebaud86ccd992008-11-05 13:47:55 +000047 {
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020048 VERIFY_IS_MUCH_SMALLER_THAN( m.coeff(zeroCoords[i].x(),zeroCoords[i].y()), eps );
49 if(internal::is_same<SparseMatrixType,SparseMatrix<Scalar,Flags> >::value)
Christoph Hertzberg0833b822014-10-31 17:12:13 +010050 VERIFY_RAISES_ASSERT( m.coeffRef(zeroCoords[i].x(),zeroCoords[i].y()) = 5 );
Gael Guennebaud86ccd992008-11-05 13:47:55 +000051 }
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020052 VERIFY_IS_APPROX(m, refMat);
Gael Guennebaud86ccd992008-11-05 13:47:55 +000053
Christoph Hertzberg0833b822014-10-31 17:12:13 +010054 if(!nonzeroCoords.empty()) {
55 m.coeffRef(nonzeroCoords[0].x(), nonzeroCoords[0].y()) = Scalar(5);
56 refMat.coeffRef(nonzeroCoords[0].x(), nonzeroCoords[0].y()) = Scalar(5);
57 }
Gael Guennebaud86ccd992008-11-05 13:47:55 +000058
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020059 VERIFY_IS_APPROX(m, refMat);
Christoph Hertzberg0833b822014-10-31 17:12:13 +010060
Gael Guennebauda915f022013-06-28 16:16:02 +020061 // test assertion
62 VERIFY_RAISES_ASSERT( m.coeffRef(-1,1) = 0 );
63 VERIFY_RAISES_ASSERT( m.coeffRef(0,m.cols()) = 0 );
Gael Guennebaudd1d7a1a2013-06-23 19:11:32 +020064 }
Gael Guennebaud86ccd992008-11-05 13:47:55 +000065
Gael Guennebaud28293142009-05-04 14:25:12 +000066 // test insert (inner random)
Gael Guennebaud5015e482008-12-11 18:26:24 +000067 {
68 DenseMatrix m1(rows,cols);
69 m1.setZero();
Gael Guennebaud178858f2009-01-19 15:20:45 +000070 SparseMatrixType m2(rows,cols);
Gael Guennebaudc43154b2015-03-04 10:16:46 +010071 bool call_reserve = internal::random<int>()%2;
72 Index nnz = internal::random<int>(1,int(rows)/2);
73 if(call_reserve)
74 {
75 if(internal::random<int>()%2)
76 m2.reserve(VectorXi::Constant(m2.outerSize(), int(nnz)));
77 else
78 m2.reserve(m2.outerSize() * nnz);
79 }
80 g_realloc_count = 0;
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +020081 for (Index j=0; j<cols; ++j)
Gael Guennebaud5015e482008-12-11 18:26:24 +000082 {
Gael Guennebaudc43154b2015-03-04 10:16:46 +010083 for (Index k=0; k<nnz; ++k)
Gael Guennebaud5015e482008-12-11 18:26:24 +000084 {
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +020085 Index i = internal::random<Index>(0,rows-1);
Gael Guennebaud5015e482008-12-11 18:26:24 +000086 if (m1.coeff(i,j)==Scalar(0))
Benoit Jacob47160402010-10-25 10:15:22 -040087 m2.insert(i,j) = m1(i,j) = internal::random<Scalar>();
Gael Guennebaud5015e482008-12-11 18:26:24 +000088 }
89 }
Gael Guennebaudc43154b2015-03-04 10:16:46 +010090
91 if(call_reserve && !SparseMatrixType::IsRowMajor)
92 {
93 VERIFY(g_realloc_count==0);
94 }
95
Gael Guennebaud28293142009-05-04 14:25:12 +000096 m2.finalize();
97 VERIFY_IS_APPROX(m2,m1);
98 }
Gael Guennebaud9f795582009-12-16 19:18:40 +010099
Gael Guennebaud28293142009-05-04 14:25:12 +0000100 // test insert (fully random)
101 {
102 DenseMatrix m1(rows,cols);
103 m1.setZero();
104 SparseMatrixType m2(rows,cols);
Gael Guennebaud4ca89f32011-12-02 19:00:16 +0100105 if(internal::random<int>()%2)
106 m2.reserve(VectorXi::Constant(m2.outerSize(), 2));
Gael Guennebaud28293142009-05-04 14:25:12 +0000107 for (int k=0; k<rows*cols; ++k)
108 {
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +0200109 Index i = internal::random<Index>(0,rows-1);
110 Index j = internal::random<Index>(0,cols-1);
Gael Guennebaud4ca89f32011-12-02 19:00:16 +0100111 if ((m1.coeff(i,j)==Scalar(0)) && (internal::random<int>()%2))
Benoit Jacob47160402010-10-25 10:15:22 -0400112 m2.insert(i,j) = m1(i,j) = internal::random<Scalar>();
Gael Guennebaud4ca89f32011-12-02 19:00:16 +0100113 else
114 {
115 Scalar v = internal::random<Scalar>();
116 m2.coeffRef(i,j) += v;
117 m1(i,j) += v;
118 }
Gael Guennebaud28293142009-05-04 14:25:12 +0000119 }
Gael Guennebaudc4c70662009-01-14 14:24:10 +0000120 VERIFY_IS_APPROX(m2,m1);
Gael Guennebaud5015e482008-12-11 18:26:24 +0000121 }
Gael Guennebaud7706baf2011-09-08 13:42:54 +0200122
123 // test insert (un-compressed)
124 for(int mode=0;mode<4;++mode)
125 {
126 DenseMatrix m1(rows,cols);
127 m1.setZero();
128 SparseMatrixType m2(rows,cols);
Gael Guennebaudb47ef142014-07-08 16:47:11 +0200129 VectorXi r(VectorXi::Constant(m2.outerSize(), ((mode%2)==0) ? int(m2.innerSize()) : std::max<int>(1,int(m2.innerSize())/8)));
Gael Guennebaud7706baf2011-09-08 13:42:54 +0200130 m2.reserve(r);
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100131 for (Index k=0; k<rows*cols; ++k)
Gael Guennebaud7706baf2011-09-08 13:42:54 +0200132 {
Gael Guennebaud6d1f5db2013-07-10 23:48:26 +0200133 Index i = internal::random<Index>(0,rows-1);
134 Index j = internal::random<Index>(0,cols-1);
Gael Guennebaud7706baf2011-09-08 13:42:54 +0200135 if (m1.coeff(i,j)==Scalar(0))
136 m2.insert(i,j) = m1(i,j) = internal::random<Scalar>();
137 if(mode==3)
138 m2.reserve(r);
139 }
Gael Guennebaud4ca89f32011-12-02 19:00:16 +0100140 if(internal::random<int>()%2)
141 m2.makeCompressed();
Gael Guennebaud7706baf2011-09-08 13:42:54 +0200142 VERIFY_IS_APPROX(m2,m1);
143 }
Gael Guennebaud9f795582009-12-16 19:18:40 +0100144
Gael Guennebaud4e602832012-11-16 09:02:50 +0100145 // test basic computations
146 {
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100147 DenseMatrix refM1 = DenseMatrix::Zero(rows, cols);
148 DenseMatrix refM2 = DenseMatrix::Zero(rows, cols);
149 DenseMatrix refM3 = DenseMatrix::Zero(rows, cols);
150 DenseMatrix refM4 = DenseMatrix::Zero(rows, cols);
151 SparseMatrixType m1(rows, cols);
152 SparseMatrixType m2(rows, cols);
153 SparseMatrixType m3(rows, cols);
154 SparseMatrixType m4(rows, cols);
Gael Guennebaud4e602832012-11-16 09:02:50 +0100155 initSparse<Scalar>(density, refM1, m1);
156 initSparse<Scalar>(density, refM2, m2);
157 initSparse<Scalar>(density, refM3, m3);
158 initSparse<Scalar>(density, refM4, m4);
159
Gael Guennebaud2c1b56f2016-05-31 10:56:53 +0200160 if(internal::random<bool>())
161 m1.makeCompressed();
162
Gael Guennebaud4aac8722014-07-22 12:54:03 +0200163 VERIFY_IS_APPROX(m1*s1, refM1*s1);
Gael Guennebaud4e602832012-11-16 09:02:50 +0100164 VERIFY_IS_APPROX(m1+m2, refM1+refM2);
165 VERIFY_IS_APPROX(m1+m2+m3, refM1+refM2+refM3);
166 VERIFY_IS_APPROX(m3.cwiseProduct(m1+m2), refM3.cwiseProduct(refM1+refM2));
167 VERIFY_IS_APPROX(m1*s1-m2, refM1*s1-refM2);
168
Gael Guennebaud4e602832012-11-16 09:02:50 +0100169 if(SparseMatrixType::IsRowMajor)
170 VERIFY_IS_APPROX(m1.innerVector(0).dot(refM2.row(0)), refM1.row(0).dot(refM2.row(0)));
171 else
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100172 VERIFY_IS_APPROX(m1.innerVector(0).dot(refM2.col(0)), refM1.col(0).dot(refM2.col(0)));
Gael Guennebaud3573a102014-02-17 13:46:17 +0100173
174 DenseVector rv = DenseVector::Random(m1.cols());
175 DenseVector cv = DenseVector::Random(m1.rows());
176 Index r = internal::random<Index>(0,m1.rows()-2);
177 Index c = internal::random<Index>(0,m1.cols()-1);
178 VERIFY_IS_APPROX(( m1.template block<1,Dynamic>(r,0,1,m1.cols()).dot(rv)) , refM1.row(r).dot(rv));
179 VERIFY_IS_APPROX(m1.row(r).dot(rv), refM1.row(r).dot(rv));
180 VERIFY_IS_APPROX(m1.col(c).dot(cv), refM1.col(c).dot(cv));
Gael Guennebaud4e602832012-11-16 09:02:50 +0100181
182 VERIFY_IS_APPROX(m1.conjugate(), refM1.conjugate());
183 VERIFY_IS_APPROX(m1.real(), refM1.real());
184
185 refM4.setRandom();
186 // sparse cwise* dense
187 VERIFY_IS_APPROX(m3.cwiseProduct(refM4), refM3.cwiseProduct(refM4));
Gael Guennebaud90275082015-11-04 17:42:07 +0100188 // dense cwise* sparse
189 VERIFY_IS_APPROX(refM4.cwiseProduct(m3), refM4.cwiseProduct(refM3));
Gael Guennebaud4e602832012-11-16 09:02:50 +0100190// VERIFY_IS_APPROX(m3.cwise()/refM4, refM3.cwise()/refM4);
191
Gael Guennebaud15084cf2016-01-29 22:09:45 +0100192 VERIFY_IS_APPROX(refM4 + m3, refM4 + refM3);
193 VERIFY_IS_APPROX(m3 + refM4, refM3 + refM4);
194 VERIFY_IS_APPROX(refM4 - m3, refM4 - refM3);
195 VERIFY_IS_APPROX(m3 - refM4, refM3 - refM4);
196
Gael Guennebaud2c1b56f2016-05-31 10:56:53 +0200197 VERIFY_IS_APPROX(m1.sum(), refM1.sum());
198
199 VERIFY_IS_APPROX(m1*=s1, refM1*=s1);
200 VERIFY_IS_APPROX(m1/=s1, refM1/=s1);
201
202 VERIFY_IS_APPROX(m1+=m2, refM1+=refM2);
203 VERIFY_IS_APPROX(m1-=m2, refM1-=refM2);
204
Gael Guennebaud4e602832012-11-16 09:02:50 +0100205 // test aliasing
206 VERIFY_IS_APPROX((m1 = -m1), (refM1 = -refM1));
207 VERIFY_IS_APPROX((m1 = m1.transpose()), (refM1 = refM1.transpose().eval()));
208 VERIFY_IS_APPROX((m1 = -m1.transpose()), (refM1 = -refM1.transpose().eval()));
209 VERIFY_IS_APPROX((m1 += -m1), (refM1 += -refM1));
210 }
211
212 // test transpose
213 {
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100214 DenseMatrix refMat2 = DenseMatrix::Zero(rows, cols);
215 SparseMatrixType m2(rows, cols);
Gael Guennebaud4e602832012-11-16 09:02:50 +0100216 initSparse<Scalar>(density, refMat2, m2);
217 VERIFY_IS_APPROX(m2.transpose().eval(), refMat2.transpose().eval());
218 VERIFY_IS_APPROX(m2.transpose(), refMat2.transpose());
219
220 VERIFY_IS_APPROX(SparseMatrixType(m2.adjoint()), refMat2.adjoint());
Gael Guennebaudff46ec02014-09-22 23:33:28 +0200221
222 // check isApprox handles opposite storage order
223 typename Transpose<SparseMatrixType>::PlainObject m3(m2);
224 VERIFY(m2.isApprox(m3));
Gael Guennebaud4e602832012-11-16 09:02:50 +0100225 }
226
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000227 // test prune
228 {
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100229 SparseMatrixType m2(rows, cols);
230 DenseMatrix refM2(rows, cols);
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000231 refM2.setZero();
232 int countFalseNonZero = 0;
233 int countTrueNonZero = 0;
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200234 m2.reserve(VectorXi::Constant(m2.outerSize(), int(m2.innerSize())));
235 for (Index j=0; j<m2.cols(); ++j)
Gael Guennebaud28293142009-05-04 14:25:12 +0000236 {
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200237 for (Index i=0; i<m2.rows(); ++i)
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000238 {
Benoit Jacob47160402010-10-25 10:15:22 -0400239 float x = internal::random<float>(0,1);
Christoph Hertzbergdacb4692016-05-05 13:35:45 +0200240 if (x<0.1f)
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000241 {
242 // do nothing
243 }
Christoph Hertzbergdacb4692016-05-05 13:35:45 +0200244 else if (x<0.5f)
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000245 {
246 countFalseNonZero++;
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200247 m2.insert(i,j) = Scalar(0);
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000248 }
249 else
250 {
251 countTrueNonZero++;
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200252 m2.insert(i,j) = Scalar(1);
253 refM2(i,j) = Scalar(1);
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000254 }
255 }
Gael Guennebaud28293142009-05-04 14:25:12 +0000256 }
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200257 if(internal::random<bool>())
258 m2.makeCompressed();
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000259 VERIFY(countFalseNonZero+countTrueNonZero == m2.nonZeros());
Gael Guennebauda44d91a2015-10-13 10:53:38 +0200260 if(countTrueNonZero>0)
261 VERIFY_IS_APPROX(m2, refM2);
Hauke Heibeld204ec42010-11-02 14:33:33 +0100262 m2.prune(Scalar(1));
Gael Guennebaud52cf07d2009-01-21 18:46:04 +0000263 VERIFY(countTrueNonZero==m2.nonZeros());
264 VERIFY_IS_APPROX(m2, refM2);
265 }
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100266
Gael Guennebaud87138072012-01-28 11:13:59 +0100267 // test setFromTriplets
268 {
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100269 typedef Triplet<Scalar,StorageIndex> TripletType;
Gael Guennebaud87138072012-01-28 11:13:59 +0100270 std::vector<TripletType> triplets;
Gael Guennebaudb47ef142014-07-08 16:47:11 +0200271 Index ntriplets = rows*cols;
Gael Guennebaud87138072012-01-28 11:13:59 +0100272 triplets.reserve(ntriplets);
Gael Guennebaudb4c79ee2015-10-13 11:30:41 +0200273 DenseMatrix refMat_sum = DenseMatrix::Zero(rows,cols);
274 DenseMatrix refMat_prod = DenseMatrix::Zero(rows,cols);
275 DenseMatrix refMat_last = DenseMatrix::Zero(rows,cols);
276
Gael Guennebaudb47ef142014-07-08 16:47:11 +0200277 for(Index i=0;i<ntriplets;++i)
Gael Guennebaud87138072012-01-28 11:13:59 +0100278 {
Gael Guennebaudaa6c5162015-02-16 13:19:05 +0100279 StorageIndex r = internal::random<StorageIndex>(0,StorageIndex(rows-1));
280 StorageIndex c = internal::random<StorageIndex>(0,StorageIndex(cols-1));
Gael Guennebaud87138072012-01-28 11:13:59 +0100281 Scalar v = internal::random<Scalar>();
Gael Guennebaud18e3ac02012-01-31 09:14:01 +0100282 triplets.push_back(TripletType(r,c,v));
Gael Guennebaudb4c79ee2015-10-13 11:30:41 +0200283 refMat_sum(r,c) += v;
284 if(std::abs(refMat_prod(r,c))==0)
285 refMat_prod(r,c) = v;
286 else
287 refMat_prod(r,c) *= v;
288 refMat_last(r,c) = v;
Gael Guennebaud87138072012-01-28 11:13:59 +0100289 }
290 SparseMatrixType m(rows,cols);
291 m.setFromTriplets(triplets.begin(), triplets.end());
Gael Guennebaudb4c79ee2015-10-13 11:30:41 +0200292 VERIFY_IS_APPROX(m, refMat_sum);
293
294 m.setFromTriplets(triplets.begin(), triplets.end(), std::multiplies<Scalar>());
295 VERIFY_IS_APPROX(m, refMat_prod);
296#if (defined(__cplusplus) && __cplusplus >= 201103L)
297 m.setFromTriplets(triplets.begin(), triplets.end(), [] (Scalar,Scalar b) { return b; });
298 VERIFY_IS_APPROX(m, refMat_last);
299#endif
Gael Guennebaud87138072012-01-28 11:13:59 +0100300 }
Gael Guennebaud3af29ca2015-02-09 10:23:45 +0100301
302 // test Map
303 {
304 DenseMatrix refMat2(rows, cols), refMat3(rows, cols);
305 SparseMatrixType m2(rows, cols), m3(rows, cols);
306 initSparse<Scalar>(density, refMat2, m2);
307 initSparse<Scalar>(density, refMat3, m3);
308 {
309 Map<SparseMatrixType> mapMat2(m2.rows(), m2.cols(), m2.nonZeros(), m2.outerIndexPtr(), m2.innerIndexPtr(), m2.valuePtr(), m2.innerNonZeroPtr());
310 Map<SparseMatrixType> mapMat3(m3.rows(), m3.cols(), m3.nonZeros(), m3.outerIndexPtr(), m3.innerIndexPtr(), m3.valuePtr(), m3.innerNonZeroPtr());
311 VERIFY_IS_APPROX(mapMat2+mapMat3, refMat2+refMat3);
312 VERIFY_IS_APPROX(mapMat2+mapMat3, refMat2+refMat3);
313 }
314 {
Gael Guennebaudfe513192015-02-13 10:03:53 +0100315 MappedSparseMatrix<Scalar,SparseMatrixType::Options,StorageIndex> mapMat2(m2.rows(), m2.cols(), m2.nonZeros(), m2.outerIndexPtr(), m2.innerIndexPtr(), m2.valuePtr(), m2.innerNonZeroPtr());
316 MappedSparseMatrix<Scalar,SparseMatrixType::Options,StorageIndex> mapMat3(m3.rows(), m3.cols(), m3.nonZeros(), m3.outerIndexPtr(), m3.innerIndexPtr(), m3.valuePtr(), m3.innerNonZeroPtr());
Gael Guennebaud3af29ca2015-02-09 10:23:45 +0100317 VERIFY_IS_APPROX(mapMat2+mapMat3, refMat2+refMat3);
318 VERIFY_IS_APPROX(mapMat2+mapMat3, refMat2+refMat3);
319 }
Gael Guennebaud757971e2016-07-26 09:40:19 +0200320
321 Index i = internal::random<Index>(0,rows-1);
322 Index j = internal::random<Index>(0,cols-1);
323 m2.coeffRef(i,j) = 123;
324 if(internal::random<bool>())
325 m2.makeCompressed();
326 Map<SparseMatrixType> mapMat2(rows, cols, m2.nonZeros(), m2.outerIndexPtr(), m2.innerIndexPtr(), m2.valuePtr(), m2.innerNonZeroPtr());
327 VERIFY_IS_EQUAL(m2.coeff(i,j),Scalar(123));
328 VERIFY_IS_EQUAL(mapMat2.coeff(i,j),Scalar(123));
329 mapMat2.coeffRef(i,j) = -123;
330 VERIFY_IS_EQUAL(m2.coeff(i,j),Scalar(-123));
Gael Guennebaud3af29ca2015-02-09 10:23:45 +0100331 }
Gael Guennebaud87138072012-01-28 11:13:59 +0100332
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100333 // test triangularView
334 {
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100335 DenseMatrix refMat2(rows, cols), refMat3(rows, cols);
336 SparseMatrixType m2(rows, cols), m3(rows, cols);
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100337 initSparse<Scalar>(density, refMat2, m2);
338 refMat3 = refMat2.template triangularView<Lower>();
339 m3 = m2.template triangularView<Lower>();
340 VERIFY_IS_APPROX(m3, refMat3);
341
342 refMat3 = refMat2.template triangularView<Upper>();
343 m3 = m2.template triangularView<Upper>();
344 VERIFY_IS_APPROX(m3, refMat3);
345
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100346 {
347 refMat3 = refMat2.template triangularView<UnitUpper>();
348 m3 = m2.template triangularView<UnitUpper>();
349 VERIFY_IS_APPROX(m3, refMat3);
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100350
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100351 refMat3 = refMat2.template triangularView<UnitLower>();
352 m3 = m2.template triangularView<UnitLower>();
353 VERIFY_IS_APPROX(m3, refMat3);
354 }
Desire NUENTSA4cd82452013-06-11 14:42:29 +0200355
356 refMat3 = refMat2.template triangularView<StrictlyUpper>();
357 m3 = m2.template triangularView<StrictlyUpper>();
358 VERIFY_IS_APPROX(m3, refMat3);
359
360 refMat3 = refMat2.template triangularView<StrictlyLower>();
361 m3 = m2.template triangularView<StrictlyLower>();
362 VERIFY_IS_APPROX(m3, refMat3);
Gael Guennebaudf6b1dee2015-11-04 17:02:32 +0100363
364 // check sparse-traingular to dense
365 refMat3 = m2.template triangularView<StrictlyUpper>();
366 VERIFY_IS_APPROX(refMat3, DenseMatrix(refMat2.template triangularView<StrictlyUpper>()));
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100367 }
Gael Guennebaudfa6d36e2010-07-22 15:57:01 +0200368
Gael Guennebaud9a3ec632010-11-15 14:14:05 +0100369 // test selfadjointView
Gael Guennebaud9353bba2011-12-04 14:39:24 +0100370 if(!SparseMatrixType::IsRowMajor)
Gael Guennebaud9a3ec632010-11-15 14:14:05 +0100371 {
372 DenseMatrix refMat2(rows, rows), refMat3(rows, rows);
373 SparseMatrixType m2(rows, rows), m3(rows, rows);
374 initSparse<Scalar>(density, refMat2, m2);
375 refMat3 = refMat2.template selfadjointView<Lower>();
376 m3 = m2.template selfadjointView<Lower>();
377 VERIFY_IS_APPROX(m3, refMat3);
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100378
379 // selfadjointView only works for square matrices:
380 SparseMatrixType m4(rows, rows+1);
381 VERIFY_RAISES_ASSERT(m4.template selfadjointView<Lower>());
382 VERIFY_RAISES_ASSERT(m4.template selfadjointView<Upper>());
Gael Guennebaud9a3ec632010-11-15 14:14:05 +0100383 }
384
Gael Guennebaudfa6d36e2010-07-22 15:57:01 +0200385 // test sparseView
386 {
387 DenseMatrix refMat2 = DenseMatrix::Zero(rows, rows);
388 SparseMatrixType m2(rows, rows);
Gael Guennebaud9a3ec632010-11-15 14:14:05 +0100389 initSparse<Scalar>(density, refMat2, m2);
Gael Guennebaudfa6d36e2010-07-22 15:57:01 +0200390 VERIFY_IS_APPROX(m2.eval(), refMat2.sparseView().eval());
Gael Guennebaud8456bbb2016-05-18 16:53:28 +0200391
392 // sparse view on expressions:
393 VERIFY_IS_APPROX((s1*m2).eval(), (s1*refMat2).sparseView().eval());
394 VERIFY_IS_APPROX((m2+m2).eval(), (refMat2+refMat2).sparseView().eval());
395 VERIFY_IS_APPROX((m2*m2).eval(), (refMat2.lazyProduct(refMat2)).sparseView().eval());
396 VERIFY_IS_APPROX((m2*m2).eval(), (refMat2*refMat2).sparseView().eval());
Gael Guennebaudfa6d36e2010-07-22 15:57:01 +0200397 }
Gael Guennebaud82f9aa12011-12-04 21:49:21 +0100398
399 // test diagonal
400 {
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100401 DenseMatrix refMat2 = DenseMatrix::Zero(rows, cols);
402 SparseMatrixType m2(rows, cols);
Gael Guennebaud82f9aa12011-12-04 21:49:21 +0100403 initSparse<Scalar>(density, refMat2, m2);
404 VERIFY_IS_APPROX(m2.diagonal(), refMat2.diagonal().eval());
Gael Guennebaudb26e6972014-12-01 14:41:39 +0100405 VERIFY_IS_APPROX(const_cast<const SparseMatrixType&>(m2).diagonal(), refMat2.diagonal().eval());
406
407 initSparse<Scalar>(density, refMat2, m2, ForceNonZeroDiag);
408 m2.diagonal() += refMat2.diagonal();
409 refMat2.diagonal() += refMat2.diagonal();
410 VERIFY_IS_APPROX(m2, refMat2);
Gael Guennebaud82f9aa12011-12-04 21:49:21 +0100411 }
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200412
Gael Guennebaud62f21e22015-06-24 17:55:00 +0200413 // test diagonal to sparse
414 {
415 DenseVector d = DenseVector::Random(rows);
416 DenseMatrix refMat2 = d.asDiagonal();
417 SparseMatrixType m2(rows, rows);
418 m2 = d.asDiagonal();
419 VERIFY_IS_APPROX(m2, refMat2);
Gael Guennebaud4c8cd132015-06-24 18:11:06 +0200420 SparseMatrixType m3(d.asDiagonal());
421 VERIFY_IS_APPROX(m3, refMat2);
Gael Guennebaud62f21e22015-06-24 17:55:00 +0200422 refMat2 += d.asDiagonal();
423 m2 += d.asDiagonal();
424 VERIFY_IS_APPROX(m2, refMat2);
425 }
426
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200427 // test conservative resize
428 {
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100429 std::vector< std::pair<StorageIndex,StorageIndex> > inc;
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100430 if(rows > 3 && cols > 2)
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100431 inc.push_back(std::pair<StorageIndex,StorageIndex>(-3,-2));
432 inc.push_back(std::pair<StorageIndex,StorageIndex>(0,0));
433 inc.push_back(std::pair<StorageIndex,StorageIndex>(3,2));
434 inc.push_back(std::pair<StorageIndex,StorageIndex>(3,0));
435 inc.push_back(std::pair<StorageIndex,StorageIndex>(0,3));
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200436
437 for(size_t i = 0; i< inc.size(); i++) {
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100438 StorageIndex incRows = inc[i].first;
439 StorageIndex incCols = inc[i].second;
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200440 SparseMatrixType m1(rows, cols);
441 DenseMatrix refMat1 = DenseMatrix::Zero(rows, cols);
442 initSparse<Scalar>(density, refMat1, m1);
443
444 m1.conservativeResize(rows+incRows, cols+incCols);
445 refMat1.conservativeResize(rows+incRows, cols+incCols);
446 if (incRows > 0) refMat1.bottomRows(incRows).setZero();
447 if (incCols > 0) refMat1.rightCols(incCols).setZero();
448
449 VERIFY_IS_APPROX(m1, refMat1);
450
451 // Insert new values
452 if (incRows > 0)
Gael Guennebaud7ee378d2013-07-12 16:40:02 +0200453 m1.insert(m1.rows()-1, 0) = refMat1(refMat1.rows()-1, 0) = 1;
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200454 if (incCols > 0)
Gael Guennebaud7ee378d2013-07-12 16:40:02 +0200455 m1.insert(0, m1.cols()-1) = refMat1(0, refMat1.cols()-1) = 1;
Benjamin Piwowarski6bf49ce2012-07-19 00:07:06 +0200456
457 VERIFY_IS_APPROX(m1, refMat1);
458
459
460 }
461 }
Desire NUENTSA4cd82452013-06-11 14:42:29 +0200462
463 // test Identity matrix
464 {
465 DenseMatrix refMat1 = DenseMatrix::Identity(rows, rows);
466 SparseMatrixType m1(rows, rows);
467 m1.setIdentity();
468 VERIFY_IS_APPROX(m1, refMat1);
Gael Guennebaud8a211bb2015-10-25 22:01:58 +0100469 for(int k=0; k<rows*rows/4; ++k)
470 {
471 Index i = internal::random<Index>(0,rows-1);
472 Index j = internal::random<Index>(0,rows-1);
Gael Guennebaud73f692d2015-10-27 11:01:37 +0100473 Scalar v = internal::random<Scalar>();
Gael Guennebaud8a211bb2015-10-25 22:01:58 +0100474 m1.coeffRef(i,j) = v;
475 refMat1.coeffRef(i,j) = v;
476 VERIFY_IS_APPROX(m1, refMat1);
477 if(internal::random<Index>(0,10)<2)
478 m1.makeCompressed();
479 }
480 m1.setIdentity();
481 refMat1.setIdentity();
482 VERIFY_IS_APPROX(m1, refMat1);
Desire NUENTSA4cd82452013-06-11 14:42:29 +0200483 }
Gael Guennebaudec469702016-02-01 15:04:33 +0100484
485 // test array/vector of InnerIterator
486 {
487 typedef typename SparseMatrixType::InnerIterator IteratorType;
488
489 DenseMatrix refMat2 = DenseMatrix::Zero(rows, cols);
490 SparseMatrixType m2(rows, cols);
491 initSparse<Scalar>(density, refMat2, m2);
492 IteratorType static_array[2];
493 static_array[0] = IteratorType(m2,0);
494 static_array[1] = IteratorType(m2,m2.outerSize()-1);
495 VERIFY( static_array[0] || m2.innerVector(static_array[0].outer()).nonZeros() == 0 );
496 VERIFY( static_array[1] || m2.innerVector(static_array[1].outer()).nonZeros() == 0 );
497 if(static_array[0] && static_array[1])
498 {
499 ++(static_array[1]);
500 static_array[1] = IteratorType(m2,0);
501 VERIFY( static_array[1] );
502 VERIFY( static_array[1].index() == static_array[0].index() );
503 VERIFY( static_array[1].outer() == static_array[0].outer() );
504 VERIFY( static_array[1].value() == static_array[0].value() );
505 }
506
507 std::vector<IteratorType> iters(2);
508 iters[0] = IteratorType(m2,0);
509 iters[1] = IteratorType(m2,m2.outerSize()-1);
510 }
Gael Guennebaud86ccd992008-11-05 13:47:55 +0000511}
512
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100513
Christoph Hertzbergc5a37772014-10-31 17:19:05 +0100514template<typename SparseMatrixType>
Christoph Hertzberge8cdbed2014-12-04 22:48:53 +0100515void big_sparse_triplet(Index rows, Index cols, double density) {
516 typedef typename SparseMatrixType::StorageIndex StorageIndex;
517 typedef typename SparseMatrixType::Scalar Scalar;
518 typedef Triplet<Scalar,Index> TripletType;
519 std::vector<TripletType> triplets;
520 double nelements = density * rows*cols;
521 VERIFY(nelements>=0 && nelements < NumTraits<StorageIndex>::highest());
522 Index ntriplets = Index(nelements);
523 triplets.reserve(ntriplets);
524 Scalar sum = Scalar(0);
525 for(Index i=0;i<ntriplets;++i)
526 {
527 Index r = internal::random<Index>(0,rows-1);
528 Index c = internal::random<Index>(0,cols-1);
529 Scalar v = internal::random<Scalar>();
530 triplets.push_back(TripletType(r,c,v));
531 sum += v;
532 }
533 SparseMatrixType m(rows,cols);
534 m.setFromTriplets(triplets.begin(), triplets.end());
535 VERIFY(m.nonZeros() <= ntriplets);
536 VERIFY_IS_APPROX(sum, m.sum());
Christoph Hertzbergc5a37772014-10-31 17:19:05 +0100537}
538
539
Gael Guennebaud86ccd992008-11-05 13:47:55 +0000540void test_sparse_basic()
541{
542 for(int i = 0; i < g_repeat; i++) {
Gael Guennebaudc43154b2015-03-04 10:16:46 +0100543 int r = Eigen::internal::random<int>(1,200), c = Eigen::internal::random<int>(1,200);
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100544 if(Eigen::internal::random<int>(0,4) == 0) {
545 r = c; // check square matrices in 25% of tries
546 }
547 EIGEN_UNUSED_VARIABLE(r+c);
548 CALL_SUBTEST_1(( sparse_basic(SparseMatrix<double>(1, 1)) ));
Gael Guennebaud91fe1502011-06-07 11:28:16 +0200549 CALL_SUBTEST_1(( sparse_basic(SparseMatrix<double>(8, 8)) ));
Christoph Hertzberg0833b822014-10-31 17:12:13 +0100550 CALL_SUBTEST_2(( sparse_basic(SparseMatrix<std::complex<double>, ColMajor>(r, c)) ));
551 CALL_SUBTEST_2(( sparse_basic(SparseMatrix<std::complex<double>, RowMajor>(r, c)) ));
552 CALL_SUBTEST_1(( sparse_basic(SparseMatrix<double>(r, c)) ));
Gael Guennebaudd7698c12015-03-19 15:11:05 +0100553 CALL_SUBTEST_5(( sparse_basic(SparseMatrix<double,ColMajor,long int>(r, c)) ));
554 CALL_SUBTEST_5(( sparse_basic(SparseMatrix<double,RowMajor,long int>(r, c)) ));
Gael Guennebaud47e89022013-06-10 10:34:03 +0200555
Gael Guennebaudc43154b2015-03-04 10:16:46 +0100556 r = Eigen::internal::random<int>(1,100);
557 c = Eigen::internal::random<int>(1,100);
558 if(Eigen::internal::random<int>(0,4) == 0) {
559 r = c; // check square matrices in 25% of tries
560 }
561
Gael Guennebaudd7698c12015-03-19 15:11:05 +0100562 CALL_SUBTEST_6(( sparse_basic(SparseMatrix<double,ColMajor,short int>(short(r), short(c))) ));
563 CALL_SUBTEST_6(( sparse_basic(SparseMatrix<double,RowMajor,short int>(short(r), short(c))) ));
Gael Guennebaud86ccd992008-11-05 13:47:55 +0000564 }
Christoph Hertzbergc5a37772014-10-31 17:19:05 +0100565
566 // Regression test for bug 900: (manually insert higher values here, if you have enough RAM):
567 CALL_SUBTEST_3((big_sparse_triplet<SparseMatrix<float, RowMajor, int> >(10000, 10000, 0.125)));
568 CALL_SUBTEST_4((big_sparse_triplet<SparseMatrix<double, ColMajor, long int> >(10000, 10000, 0.125)));
Gael Guennebaudbfd6ee62015-11-06 15:05:37 +0100569
570 // Regression test for bug 1105
Christoph Hertzberg7268b102016-05-11 19:41:53 +0200571#ifdef EIGEN_TEST_PART_7
Gael Guennebaudbfd6ee62015-11-06 15:05:37 +0100572 {
573 int n = Eigen::internal::random<int>(200,600);
574 SparseMatrix<std::complex<double>,0, long> mat(n, n);
575 std::complex<double> val;
576
577 for(int i=0; i<n; ++i)
578 {
579 mat.coeffRef(i, i%(n/10)) = val;
580 VERIFY(mat.data().allocatedSize()<20*n);
581 }
582 }
583#endif
Gael Guennebaud86ccd992008-11-05 13:47:55 +0000584}