1 | // This file is part of Eigen, a lightweight C++ template library
|
---|
2 | // for linear algebra.
|
---|
3 | //
|
---|
4 | // Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
|
---|
5 | //
|
---|
6 | // 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/.
|
---|
9 |
|
---|
10 | #ifndef EIGEN_SPARSEVECTOR_H
|
---|
11 | #define EIGEN_SPARSEVECTOR_H
|
---|
12 |
|
---|
13 | namespace Eigen {
|
---|
14 |
|
---|
15 | /** \ingroup SparseCore_Module
|
---|
16 | * \class SparseVector
|
---|
17 | *
|
---|
18 | * \brief a sparse vector class
|
---|
19 | *
|
---|
20 | * \tparam _Scalar the scalar type, i.e. the type of the coefficients
|
---|
21 | *
|
---|
22 | * See http://www.netlib.org/linalg/html_templates/node91.html for details on the storage scheme.
|
---|
23 | *
|
---|
24 | * This class can be extended with the help of the plugin mechanism described on the page
|
---|
25 | * \ref TopicCustomizingEigen by defining the preprocessor symbol \c EIGEN_SPARSEVECTOR_PLUGIN.
|
---|
26 | */
|
---|
27 |
|
---|
28 | namespace internal {
|
---|
29 | template<typename _Scalar, int _Options, typename _Index>
|
---|
30 | struct traits<SparseVector<_Scalar, _Options, _Index> >
|
---|
31 | {
|
---|
32 | typedef _Scalar Scalar;
|
---|
33 | typedef _Index Index;
|
---|
34 | typedef Sparse StorageKind;
|
---|
35 | typedef MatrixXpr XprKind;
|
---|
36 | enum {
|
---|
37 | IsColVector = (_Options & RowMajorBit) ? 0 : 1,
|
---|
38 |
|
---|
39 | RowsAtCompileTime = IsColVector ? Dynamic : 1,
|
---|
40 | ColsAtCompileTime = IsColVector ? 1 : Dynamic,
|
---|
41 | MaxRowsAtCompileTime = RowsAtCompileTime,
|
---|
42 | MaxColsAtCompileTime = ColsAtCompileTime,
|
---|
43 | Flags = _Options | NestByRefBit | LvalueBit | (IsColVector ? 0 : RowMajorBit),
|
---|
44 | CoeffReadCost = NumTraits<Scalar>::ReadCost,
|
---|
45 | SupportedAccessPatterns = InnerRandomAccessPattern
|
---|
46 | };
|
---|
47 | };
|
---|
48 |
|
---|
49 | // Sparse-Vector-Assignment kinds:
|
---|
50 | enum {
|
---|
51 | SVA_RuntimeSwitch,
|
---|
52 | SVA_Inner,
|
---|
53 | SVA_Outer
|
---|
54 | };
|
---|
55 |
|
---|
56 | template< typename Dest, typename Src,
|
---|
57 | int AssignmentKind = !bool(Src::IsVectorAtCompileTime) ? SVA_RuntimeSwitch
|
---|
58 | : Src::InnerSizeAtCompileTime==1 ? SVA_Outer
|
---|
59 | : SVA_Inner>
|
---|
60 | struct sparse_vector_assign_selector;
|
---|
61 |
|
---|
62 | }
|
---|
63 |
|
---|
64 | template<typename _Scalar, int _Options, typename _Index>
|
---|
65 | class SparseVector
|
---|
66 | : public SparseMatrixBase<SparseVector<_Scalar, _Options, _Index> >
|
---|
67 | {
|
---|
68 | typedef SparseMatrixBase<SparseVector> SparseBase;
|
---|
69 |
|
---|
70 | public:
|
---|
71 | EIGEN_SPARSE_PUBLIC_INTERFACE(SparseVector)
|
---|
72 | EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(SparseVector, +=)
|
---|
73 | EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(SparseVector, -=)
|
---|
74 |
|
---|
75 | typedef internal::CompressedStorage<Scalar,Index> Storage;
|
---|
76 | enum { IsColVector = internal::traits<SparseVector>::IsColVector };
|
---|
77 |
|
---|
78 | enum {
|
---|
79 | Options = _Options
|
---|
80 | };
|
---|
81 |
|
---|
82 | EIGEN_STRONG_INLINE Index rows() const { return IsColVector ? m_size : 1; }
|
---|
83 | EIGEN_STRONG_INLINE Index cols() const { return IsColVector ? 1 : m_size; }
|
---|
84 | EIGEN_STRONG_INLINE Index innerSize() const { return m_size; }
|
---|
85 | EIGEN_STRONG_INLINE Index outerSize() const { return 1; }
|
---|
86 |
|
---|
87 | EIGEN_STRONG_INLINE const Scalar* valuePtr() const { return m_data.valuePtr(); }
|
---|
88 | EIGEN_STRONG_INLINE Scalar* valuePtr() { return m_data.valuePtr(); }
|
---|
89 |
|
---|
90 | EIGEN_STRONG_INLINE const Index* innerIndexPtr() const { return m_data.indexPtr(); }
|
---|
91 | EIGEN_STRONG_INLINE Index* innerIndexPtr() { return m_data.indexPtr(); }
|
---|
92 |
|
---|
93 | /** \internal */
|
---|
94 | inline Storage& data() { return m_data; }
|
---|
95 | /** \internal */
|
---|
96 | inline const Storage& data() const { return m_data; }
|
---|
97 |
|
---|
98 | inline Scalar coeff(Index row, Index col) const
|
---|
99 | {
|
---|
100 | eigen_assert(IsColVector ? (col==0 && row>=0 && row<m_size) : (row==0 && col>=0 && col<m_size));
|
---|
101 | return coeff(IsColVector ? row : col);
|
---|
102 | }
|
---|
103 | inline Scalar coeff(Index i) const
|
---|
104 | {
|
---|
105 | eigen_assert(i>=0 && i<m_size);
|
---|
106 | return m_data.at(i);
|
---|
107 | }
|
---|
108 |
|
---|
109 | inline Scalar& coeffRef(Index row, Index col)
|
---|
110 | {
|
---|
111 | eigen_assert(IsColVector ? (col==0 && row>=0 && row<m_size) : (row==0 && col>=0 && col<m_size));
|
---|
112 | return coeff(IsColVector ? row : col);
|
---|
113 | }
|
---|
114 |
|
---|
115 | /** \returns a reference to the coefficient value at given index \a i
|
---|
116 | * This operation involes a log(rho*size) binary search. If the coefficient does not
|
---|
117 | * exist yet, then a sorted insertion into a sequential buffer is performed.
|
---|
118 | *
|
---|
119 | * This insertion might be very costly if the number of nonzeros above \a i is large.
|
---|
120 | */
|
---|
121 | inline Scalar& coeffRef(Index i)
|
---|
122 | {
|
---|
123 | eigen_assert(i>=0 && i<m_size);
|
---|
124 | return m_data.atWithInsertion(i);
|
---|
125 | }
|
---|
126 |
|
---|
127 | public:
|
---|
128 |
|
---|
129 | class InnerIterator;
|
---|
130 | class ReverseInnerIterator;
|
---|
131 |
|
---|
132 | inline void setZero() { m_data.clear(); }
|
---|
133 |
|
---|
134 | /** \returns the number of non zero coefficients */
|
---|
135 | inline Index nonZeros() const { return static_cast<Index>(m_data.size()); }
|
---|
136 |
|
---|
137 | inline void startVec(Index outer)
|
---|
138 | {
|
---|
139 | EIGEN_UNUSED_VARIABLE(outer);
|
---|
140 | eigen_assert(outer==0);
|
---|
141 | }
|
---|
142 |
|
---|
143 | inline Scalar& insertBackByOuterInner(Index outer, Index inner)
|
---|
144 | {
|
---|
145 | EIGEN_UNUSED_VARIABLE(outer);
|
---|
146 | eigen_assert(outer==0);
|
---|
147 | return insertBack(inner);
|
---|
148 | }
|
---|
149 | inline Scalar& insertBack(Index i)
|
---|
150 | {
|
---|
151 | m_data.append(0, i);
|
---|
152 | return m_data.value(m_data.size()-1);
|
---|
153 | }
|
---|
154 |
|
---|
155 | inline Scalar& insert(Index row, Index col)
|
---|
156 | {
|
---|
157 | eigen_assert(IsColVector ? (col==0 && row>=0 && row<m_size) : (row==0 && col>=0 && col<m_size));
|
---|
158 |
|
---|
159 | Index inner = IsColVector ? row : col;
|
---|
160 | Index outer = IsColVector ? col : row;
|
---|
161 | EIGEN_ONLY_USED_FOR_DEBUG(outer);
|
---|
162 | eigen_assert(outer==0);
|
---|
163 | return insert(inner);
|
---|
164 | }
|
---|
165 | Scalar& insert(Index i)
|
---|
166 | {
|
---|
167 | eigen_assert(i>=0 && i<m_size);
|
---|
168 |
|
---|
169 | Index startId = 0;
|
---|
170 | Index p = Index(m_data.size()) - 1;
|
---|
171 | // TODO smart realloc
|
---|
172 | m_data.resize(p+2,1);
|
---|
173 |
|
---|
174 | while ( (p >= startId) && (m_data.index(p) > i) )
|
---|
175 | {
|
---|
176 | m_data.index(p+1) = m_data.index(p);
|
---|
177 | m_data.value(p+1) = m_data.value(p);
|
---|
178 | --p;
|
---|
179 | }
|
---|
180 | m_data.index(p+1) = i;
|
---|
181 | m_data.value(p+1) = 0;
|
---|
182 | return m_data.value(p+1);
|
---|
183 | }
|
---|
184 |
|
---|
185 | /**
|
---|
186 | */
|
---|
187 | inline void reserve(Index reserveSize) { m_data.reserve(reserveSize); }
|
---|
188 |
|
---|
189 |
|
---|
190 | inline void finalize() {}
|
---|
191 |
|
---|
192 | void prune(const Scalar& reference, const RealScalar& epsilon = NumTraits<RealScalar>::dummy_precision())
|
---|
193 | {
|
---|
194 | m_data.prune(reference,epsilon);
|
---|
195 | }
|
---|
196 |
|
---|
197 | void resize(Index rows, Index cols)
|
---|
198 | {
|
---|
199 | eigen_assert(rows==1 || cols==1);
|
---|
200 | resize(IsColVector ? rows : cols);
|
---|
201 | }
|
---|
202 |
|
---|
203 | void resize(Index newSize)
|
---|
204 | {
|
---|
205 | m_size = newSize;
|
---|
206 | m_data.clear();
|
---|
207 | }
|
---|
208 |
|
---|
209 | void resizeNonZeros(Index size) { m_data.resize(size); }
|
---|
210 |
|
---|
211 | inline SparseVector() : m_size(0) { check_template_parameters(); resize(0); }
|
---|
212 |
|
---|
213 | inline SparseVector(Index size) : m_size(0) { check_template_parameters(); resize(size); }
|
---|
214 |
|
---|
215 | inline SparseVector(Index rows, Index cols) : m_size(0) { check_template_parameters(); resize(rows,cols); }
|
---|
216 |
|
---|
217 | template<typename OtherDerived>
|
---|
218 | inline SparseVector(const SparseMatrixBase<OtherDerived>& other)
|
---|
219 | : m_size(0)
|
---|
220 | {
|
---|
221 | check_template_parameters();
|
---|
222 | *this = other.derived();
|
---|
223 | }
|
---|
224 |
|
---|
225 | inline SparseVector(const SparseVector& other)
|
---|
226 | : SparseBase(other), m_size(0)
|
---|
227 | {
|
---|
228 | check_template_parameters();
|
---|
229 | *this = other.derived();
|
---|
230 | }
|
---|
231 |
|
---|
232 | /** Swaps the values of \c *this and \a other.
|
---|
233 | * Overloaded for performance: this version performs a \em shallow swap by swaping pointers and attributes only.
|
---|
234 | * \sa SparseMatrixBase::swap()
|
---|
235 | */
|
---|
236 | inline void swap(SparseVector& other)
|
---|
237 | {
|
---|
238 | std::swap(m_size, other.m_size);
|
---|
239 | m_data.swap(other.m_data);
|
---|
240 | }
|
---|
241 |
|
---|
242 | inline SparseVector& operator=(const SparseVector& other)
|
---|
243 | {
|
---|
244 | if (other.isRValue())
|
---|
245 | {
|
---|
246 | swap(other.const_cast_derived());
|
---|
247 | }
|
---|
248 | else
|
---|
249 | {
|
---|
250 | resize(other.size());
|
---|
251 | m_data = other.m_data;
|
---|
252 | }
|
---|
253 | return *this;
|
---|
254 | }
|
---|
255 |
|
---|
256 | template<typename OtherDerived>
|
---|
257 | inline SparseVector& operator=(const SparseMatrixBase<OtherDerived>& other)
|
---|
258 | {
|
---|
259 | SparseVector tmp(other.size());
|
---|
260 | internal::sparse_vector_assign_selector<SparseVector,OtherDerived>::run(tmp,other.derived());
|
---|
261 | this->swap(tmp);
|
---|
262 | return *this;
|
---|
263 | }
|
---|
264 |
|
---|
265 | #ifndef EIGEN_PARSED_BY_DOXYGEN
|
---|
266 | template<typename Lhs, typename Rhs>
|
---|
267 | inline SparseVector& operator=(const SparseSparseProduct<Lhs,Rhs>& product)
|
---|
268 | {
|
---|
269 | return Base::operator=(product);
|
---|
270 | }
|
---|
271 | #endif
|
---|
272 |
|
---|
273 | friend std::ostream & operator << (std::ostream & s, const SparseVector& m)
|
---|
274 | {
|
---|
275 | for (Index i=0; i<m.nonZeros(); ++i)
|
---|
276 | s << "(" << m.m_data.value(i) << "," << m.m_data.index(i) << ") ";
|
---|
277 | s << std::endl;
|
---|
278 | return s;
|
---|
279 | }
|
---|
280 |
|
---|
281 | /** Destructor */
|
---|
282 | inline ~SparseVector() {}
|
---|
283 |
|
---|
284 | /** Overloaded for performance */
|
---|
285 | Scalar sum() const;
|
---|
286 |
|
---|
287 | public:
|
---|
288 |
|
---|
289 | /** \internal \deprecated use setZero() and reserve() */
|
---|
290 | EIGEN_DEPRECATED void startFill(Index reserve)
|
---|
291 | {
|
---|
292 | setZero();
|
---|
293 | m_data.reserve(reserve);
|
---|
294 | }
|
---|
295 |
|
---|
296 | /** \internal \deprecated use insertBack(Index,Index) */
|
---|
297 | EIGEN_DEPRECATED Scalar& fill(Index r, Index c)
|
---|
298 | {
|
---|
299 | eigen_assert(r==0 || c==0);
|
---|
300 | return fill(IsColVector ? r : c);
|
---|
301 | }
|
---|
302 |
|
---|
303 | /** \internal \deprecated use insertBack(Index) */
|
---|
304 | EIGEN_DEPRECATED Scalar& fill(Index i)
|
---|
305 | {
|
---|
306 | m_data.append(0, i);
|
---|
307 | return m_data.value(m_data.size()-1);
|
---|
308 | }
|
---|
309 |
|
---|
310 | /** \internal \deprecated use insert(Index,Index) */
|
---|
311 | EIGEN_DEPRECATED Scalar& fillrand(Index r, Index c)
|
---|
312 | {
|
---|
313 | eigen_assert(r==0 || c==0);
|
---|
314 | return fillrand(IsColVector ? r : c);
|
---|
315 | }
|
---|
316 |
|
---|
317 | /** \internal \deprecated use insert(Index) */
|
---|
318 | EIGEN_DEPRECATED Scalar& fillrand(Index i)
|
---|
319 | {
|
---|
320 | return insert(i);
|
---|
321 | }
|
---|
322 |
|
---|
323 | /** \internal \deprecated use finalize() */
|
---|
324 | EIGEN_DEPRECATED void endFill() {}
|
---|
325 |
|
---|
326 | // These two functions were here in the 3.1 release, so let's keep them in case some code rely on them.
|
---|
327 | /** \internal \deprecated use data() */
|
---|
328 | EIGEN_DEPRECATED Storage& _data() { return m_data; }
|
---|
329 | /** \internal \deprecated use data() */
|
---|
330 | EIGEN_DEPRECATED const Storage& _data() const { return m_data; }
|
---|
331 |
|
---|
332 | # ifdef EIGEN_SPARSEVECTOR_PLUGIN
|
---|
333 | # include EIGEN_SPARSEVECTOR_PLUGIN
|
---|
334 | # endif
|
---|
335 |
|
---|
336 | protected:
|
---|
337 |
|
---|
338 | static void check_template_parameters()
|
---|
339 | {
|
---|
340 | EIGEN_STATIC_ASSERT(NumTraits<Index>::IsSigned,THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE);
|
---|
341 | EIGEN_STATIC_ASSERT((_Options&(ColMajor|RowMajor))==Options,INVALID_MATRIX_TEMPLATE_PARAMETERS);
|
---|
342 | }
|
---|
343 |
|
---|
344 | Storage m_data;
|
---|
345 | Index m_size;
|
---|
346 | };
|
---|
347 |
|
---|
348 | template<typename Scalar, int _Options, typename _Index>
|
---|
349 | class SparseVector<Scalar,_Options,_Index>::InnerIterator
|
---|
350 | {
|
---|
351 | public:
|
---|
352 | InnerIterator(const SparseVector& vec, Index outer=0)
|
---|
353 | : m_data(vec.m_data), m_id(0), m_end(static_cast<Index>(m_data.size()))
|
---|
354 | {
|
---|
355 | EIGEN_UNUSED_VARIABLE(outer);
|
---|
356 | eigen_assert(outer==0);
|
---|
357 | }
|
---|
358 |
|
---|
359 | InnerIterator(const internal::CompressedStorage<Scalar,Index>& data)
|
---|
360 | : m_data(data), m_id(0), m_end(static_cast<Index>(m_data.size()))
|
---|
361 | {}
|
---|
362 |
|
---|
363 | inline InnerIterator& operator++() { m_id++; return *this; }
|
---|
364 |
|
---|
365 | inline Scalar value() const { return m_data.value(m_id); }
|
---|
366 | inline Scalar& valueRef() { return const_cast<Scalar&>(m_data.value(m_id)); }
|
---|
367 |
|
---|
368 | inline Index index() const { return m_data.index(m_id); }
|
---|
369 | inline Index row() const { return IsColVector ? index() : 0; }
|
---|
370 | inline Index col() const { return IsColVector ? 0 : index(); }
|
---|
371 |
|
---|
372 | inline operator bool() const { return (m_id < m_end); }
|
---|
373 |
|
---|
374 | protected:
|
---|
375 | const internal::CompressedStorage<Scalar,Index>& m_data;
|
---|
376 | Index m_id;
|
---|
377 | const Index m_end;
|
---|
378 | };
|
---|
379 |
|
---|
380 | template<typename Scalar, int _Options, typename _Index>
|
---|
381 | class SparseVector<Scalar,_Options,_Index>::ReverseInnerIterator
|
---|
382 | {
|
---|
383 | public:
|
---|
384 | ReverseInnerIterator(const SparseVector& vec, Index outer=0)
|
---|
385 | : m_data(vec.m_data), m_id(static_cast<Index>(m_data.size())), m_start(0)
|
---|
386 | {
|
---|
387 | EIGEN_UNUSED_VARIABLE(outer);
|
---|
388 | eigen_assert(outer==0);
|
---|
389 | }
|
---|
390 |
|
---|
391 | ReverseInnerIterator(const internal::CompressedStorage<Scalar,Index>& data)
|
---|
392 | : m_data(data), m_id(static_cast<Index>(m_data.size())), m_start(0)
|
---|
393 | {}
|
---|
394 |
|
---|
395 | inline ReverseInnerIterator& operator--() { m_id--; return *this; }
|
---|
396 |
|
---|
397 | inline Scalar value() const { return m_data.value(m_id-1); }
|
---|
398 | inline Scalar& valueRef() { return const_cast<Scalar&>(m_data.value(m_id-1)); }
|
---|
399 |
|
---|
400 | inline Index index() const { return m_data.index(m_id-1); }
|
---|
401 | inline Index row() const { return IsColVector ? index() : 0; }
|
---|
402 | inline Index col() const { return IsColVector ? 0 : index(); }
|
---|
403 |
|
---|
404 | inline operator bool() const { return (m_id > m_start); }
|
---|
405 |
|
---|
406 | protected:
|
---|
407 | const internal::CompressedStorage<Scalar,Index>& m_data;
|
---|
408 | Index m_id;
|
---|
409 | const Index m_start;
|
---|
410 | };
|
---|
411 |
|
---|
412 | namespace internal {
|
---|
413 |
|
---|
414 | template< typename Dest, typename Src>
|
---|
415 | struct sparse_vector_assign_selector<Dest,Src,SVA_Inner> {
|
---|
416 | static void run(Dest& dst, const Src& src) {
|
---|
417 | eigen_internal_assert(src.innerSize()==src.size());
|
---|
418 | for(typename Src::InnerIterator it(src, 0); it; ++it)
|
---|
419 | dst.insert(it.index()) = it.value();
|
---|
420 | }
|
---|
421 | };
|
---|
422 |
|
---|
423 | template< typename Dest, typename Src>
|
---|
424 | struct sparse_vector_assign_selector<Dest,Src,SVA_Outer> {
|
---|
425 | static void run(Dest& dst, const Src& src) {
|
---|
426 | eigen_internal_assert(src.outerSize()==src.size());
|
---|
427 | for(typename Dest::Index i=0; i<src.size(); ++i)
|
---|
428 | {
|
---|
429 | typename Src::InnerIterator it(src, i);
|
---|
430 | if(it)
|
---|
431 | dst.insert(i) = it.value();
|
---|
432 | }
|
---|
433 | }
|
---|
434 | };
|
---|
435 |
|
---|
436 | template< typename Dest, typename Src>
|
---|
437 | struct sparse_vector_assign_selector<Dest,Src,SVA_RuntimeSwitch> {
|
---|
438 | static void run(Dest& dst, const Src& src) {
|
---|
439 | if(src.outerSize()==1) sparse_vector_assign_selector<Dest,Src,SVA_Inner>::run(dst, src);
|
---|
440 | else sparse_vector_assign_selector<Dest,Src,SVA_Outer>::run(dst, src);
|
---|
441 | }
|
---|
442 | };
|
---|
443 |
|
---|
444 | }
|
---|
445 |
|
---|
446 | } // end namespace Eigen
|
---|
447 |
|
---|
448 | #endif // EIGEN_SPARSEVECTOR_H
|
---|