Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
 
Loading...
Searching...
No Matches
SparseMatrixBase.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2014 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_SPARSEMATRIXBASE_H
11#define EIGEN_SPARSEMATRIXBASE_H
12
13namespace Eigen {
14
26template<typename Derived> class SparseMatrixBase
27 : public EigenBase<Derived>
28{
29 public:
30
31 typedef typename internal::traits<Derived>::Scalar Scalar;
32
36 typedef Scalar value_type;
37
38 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
39 typedef typename internal::traits<Derived>::StorageKind StorageKind;
40
43 typedef typename internal::traits<Derived>::StorageIndex StorageIndex;
44
45 typedef typename internal::add_const_on_value_type_if_arithmetic<
46 typename internal::packet_traits<Scalar>::type
47 >::type PacketReturnType;
48
50
53
54 template<typename OtherDerived>
55 Derived& operator=(const EigenBase<OtherDerived> &other);
56
57 enum {
58
59 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
65 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
72 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
73 internal::traits<Derived>::ColsAtCompileTime>::ret),
78 MaxRowsAtCompileTime = RowsAtCompileTime,
79 MaxColsAtCompileTime = ColsAtCompileTime,
80
81 MaxSizeAtCompileTime = (internal::size_at_compile_time<MaxRowsAtCompileTime,
82 MaxColsAtCompileTime>::ret),
83
90 NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0 : bool(IsVectorAtCompileTime) ? 1 : 2,
95 Flags = internal::traits<Derived>::Flags,
100 IsRowMajor = Flags&RowMajorBit ? 1 : 0,
101
102 InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
103 : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),
104
105 #ifndef EIGEN_PARSED_BY_DOXYGEN
106 _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0 // workaround sunCC
107 #endif
108 };
109
111 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
114 >::type AdjointReturnType;
116 typedef typename internal::add_const<Transpose<const Derived> >::type ConstTransposeReturnType;
117
118 // FIXME storage order do not match evaluator storage order
120
121#ifndef EIGEN_PARSED_BY_DOXYGEN
128 typedef typename NumTraits<Scalar>::Real RealScalar;
129
132 typedef typename internal::conditional<_HasDirectAccess, const Scalar&, Scalar>::type CoeffReturnType;
133
136
140 typedef Matrix<Scalar,EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime),
141 EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime)> SquareMatrixType;
142
143 inline const Derived& derived() const { return *static_cast<const Derived*>(this); }
144 inline Derived& derived() { return *static_cast<Derived*>(this); }
145 inline Derived& const_cast_derived() const
146 { return *static_cast<Derived*>(const_cast<SparseMatrixBase*>(this)); }
147
148 typedef EigenBase<Derived> Base;
149
150#endif // not EIGEN_PARSED_BY_DOXYGEN
151
152#define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::SparseMatrixBase
153#ifdef EIGEN_PARSED_BY_DOXYGEN
154#define EIGEN_DOC_UNARY_ADDONS(METHOD,OP)
155#define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
156#define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND)
157#else
158#define EIGEN_DOC_UNARY_ADDONS(X,Y)
159#define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
160#define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND)
161#endif
162# include "../plugins/CommonCwiseUnaryOps.h"
163# include "../plugins/CommonCwiseBinaryOps.h"
164# include "../plugins/MatrixCwiseUnaryOps.h"
165# include "../plugins/MatrixCwiseBinaryOps.h"
166# include "../plugins/BlockMethods.h"
167# ifdef EIGEN_SPARSEMATRIXBASE_PLUGIN
168# include EIGEN_SPARSEMATRIXBASE_PLUGIN
169# endif
170#undef EIGEN_CURRENT_STORAGE_BASE_CLASS
171#undef EIGEN_DOC_UNARY_ADDONS
172#undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
173#undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
174
176 inline Index rows() const { return derived().rows(); }
178 inline Index cols() const { return derived().cols(); }
181 inline Index size() const { return rows() * cols(); }
186 inline bool isVector() const { return rows()==1 || cols()==1; }
189 Index outerSize() const { return (int(Flags)&RowMajorBit) ? this->rows() : this->cols(); }
192 Index innerSize() const { return (int(Flags)&RowMajorBit) ? this->cols() : this->rows(); }
193
194 bool isRValue() const { return m_isRValue; }
195 Derived& markAsRValue() { m_isRValue = true; return derived(); }
196
197 SparseMatrixBase() : m_isRValue(false) { /* TODO check flags */ }
198
199
200 template<typename OtherDerived>
201 Derived& operator=(const ReturnByValue<OtherDerived>& other);
202
203 template<typename OtherDerived>
204 inline Derived& operator=(const SparseMatrixBase<OtherDerived>& other);
205
206 inline Derived& operator=(const Derived& other);
207
208 protected:
209
210 template<typename OtherDerived>
211 inline Derived& assign(const OtherDerived& other);
212
213 template<typename OtherDerived>
214 inline void assignGeneric(const OtherDerived& other);
215
216 public:
217
218 friend std::ostream & operator << (std::ostream & s, const SparseMatrixBase& m)
219 {
220 typedef typename Derived::Nested Nested;
221 typedef typename internal::remove_all<Nested>::type NestedCleaned;
222
223 if (Flags&RowMajorBit)
224 {
225 Nested nm(m.derived());
226 internal::evaluator<NestedCleaned> thisEval(nm);
227 for (Index row=0; row<nm.outerSize(); ++row)
228 {
229 Index col = 0;
230 for (typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval, row); it; ++it)
231 {
232 for ( ; col<it.index(); ++col)
233 s << "0 ";
234 s << it.value() << " ";
235 ++col;
236 }
237 for ( ; col<m.cols(); ++col)
238 s << "0 ";
239 s << std::endl;
240 }
241 }
242 else
243 {
244 Nested nm(m.derived());
245 internal::evaluator<NestedCleaned> thisEval(nm);
246 if (m.cols() == 1) {
247 Index row = 0;
248 for (typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval, 0); it; ++it)
249 {
250 for ( ; row<it.index(); ++row)
251 s << "0" << std::endl;
252 s << it.value() << std::endl;
253 ++row;
254 }
255 for ( ; row<m.rows(); ++row)
256 s << "0" << std::endl;
257 }
258 else
259 {
260 SparseMatrix<Scalar, RowMajorBit, StorageIndex> trans = m;
261 s << static_cast<const SparseMatrixBase<SparseMatrix<Scalar, RowMajorBit, StorageIndex> >&>(trans);
262 }
263 }
264 return s;
265 }
266
267 template<typename OtherDerived>
268 Derived& operator+=(const SparseMatrixBase<OtherDerived>& other);
269 template<typename OtherDerived>
270 Derived& operator-=(const SparseMatrixBase<OtherDerived>& other);
271
272 template<typename OtherDerived>
273 Derived& operator+=(const DiagonalBase<OtherDerived>& other);
274 template<typename OtherDerived>
275 Derived& operator-=(const DiagonalBase<OtherDerived>& other);
276
277 template<typename OtherDerived>
278 Derived& operator+=(const EigenBase<OtherDerived> &other);
279 template<typename OtherDerived>
280 Derived& operator-=(const EigenBase<OtherDerived> &other);
281
282 Derived& operator*=(const Scalar& other);
283 Derived& operator/=(const Scalar& other);
284
285 template<typename OtherDerived> struct CwiseProductDenseReturnType {
286 typedef CwiseBinaryOp<internal::scalar_product_op<typename ScalarBinaryOpTraits<
287 typename internal::traits<Derived>::Scalar,
288 typename internal::traits<OtherDerived>::Scalar
289 >::ReturnType>,
290 const Derived,
291 const OtherDerived
292 > Type;
293 };
294
295 template<typename OtherDerived>
296 EIGEN_STRONG_INLINE const typename CwiseProductDenseReturnType<OtherDerived>::Type
297 cwiseProduct(const MatrixBase<OtherDerived> &other) const;
298
299 // sparse * diagonal
300 template<typename OtherDerived>
301 const Product<Derived,OtherDerived>
302 operator*(const DiagonalBase<OtherDerived> &other) const
303 { return Product<Derived,OtherDerived>(derived(), other.derived()); }
304
305 // diagonal * sparse
306 template<typename OtherDerived> friend
307 const Product<OtherDerived,Derived>
308 operator*(const DiagonalBase<OtherDerived> &lhs, const SparseMatrixBase& rhs)
309 { return Product<OtherDerived,Derived>(lhs.derived(), rhs.derived()); }
310
311 // sparse * sparse
312 template<typename OtherDerived>
313 const Product<Derived,OtherDerived,AliasFreeProduct>
314 operator*(const SparseMatrixBase<OtherDerived> &other) const;
315
316 // sparse * dense
317 template<typename OtherDerived>
318 const Product<Derived,OtherDerived>
319 operator*(const MatrixBase<OtherDerived> &other) const
320 { return Product<Derived,OtherDerived>(derived(), other.derived()); }
321
322 // dense * sparse
323 template<typename OtherDerived> friend
324 const Product<OtherDerived,Derived>
325 operator*(const MatrixBase<OtherDerived> &lhs, const SparseMatrixBase& rhs)
326 { return Product<OtherDerived,Derived>(lhs.derived(), rhs.derived()); }
327
329 SparseSymmetricPermutationProduct<Derived,Upper|Lower> twistedBy(const PermutationMatrix<Dynamic,Dynamic,StorageIndex>& perm) const
330 {
331 return SparseSymmetricPermutationProduct<Derived,Upper|Lower>(derived(), perm);
332 }
333
334 template<typename OtherDerived>
335 Derived& operator*=(const SparseMatrixBase<OtherDerived>& other);
336
337 template<int Mode>
338 inline const TriangularView<const Derived, Mode> triangularView() const;
339
340 template<unsigned int UpLo> struct SelfAdjointViewReturnType { typedef SparseSelfAdjointView<Derived, UpLo> Type; };
341 template<unsigned int UpLo> struct ConstSelfAdjointViewReturnType { typedef const SparseSelfAdjointView<const Derived, UpLo> Type; };
342
343 template<unsigned int UpLo> inline
344 typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView() const;
345 template<unsigned int UpLo> inline
346 typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
347
348 template<typename OtherDerived> Scalar dot(const MatrixBase<OtherDerived>& other) const;
349 template<typename OtherDerived> Scalar dot(const SparseMatrixBase<OtherDerived>& other) const;
350 RealScalar squaredNorm() const;
351 RealScalar norm() const;
352 RealScalar blueNorm() const;
353
354 TransposeReturnType transpose() { return TransposeReturnType(derived()); }
355 const ConstTransposeReturnType transpose() const { return ConstTransposeReturnType(derived()); }
356 const AdjointReturnType adjoint() const { return AdjointReturnType(transpose()); }
357
358 DenseMatrixType toDense() const
359 {
360 return DenseMatrixType(derived());
361 }
362
363 template<typename OtherDerived>
364 bool isApprox(const SparseMatrixBase<OtherDerived>& other,
365 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
366
367 template<typename OtherDerived>
368 bool isApprox(const MatrixBase<OtherDerived>& other,
369 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const
370 { return toDense().isApprox(other,prec); }
371
377 inline const typename internal::eval<Derived>::type eval() const
378 { return typename internal::eval<Derived>::type(derived()); }
379
380 Scalar sum() const;
381
382 inline const SparseView<Derived>
383 pruned(const Scalar& reference = Scalar(0), const RealScalar& epsilon = NumTraits<Scalar>::dummy_precision()) const;
384
385 protected:
386
387 bool m_isRValue;
388
389 static inline StorageIndex convert_index(const Index idx) {
390 return internal::convert_index<StorageIndex>(idx);
391 }
392 private:
393 template<typename Dest> void evalTo(Dest &) const;
394};
395
396} // end namespace Eigen
397
398#endif // EIGEN_SPARSEMATRIXBASE_H
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:61
Generic expression where a coefficient-wise unary operator is applied to an expression.
Definition: CwiseUnaryOp.h:56
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Definition: Diagonal.h:65
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
Permutation matrix.
Definition: PermutationMatrix.h:298
Base class of any sparse matrices or sparse expressions.
Definition: SparseMatrixBase.h:28
internal::traits< Derived >::StorageIndex StorageIndex
Definition: SparseMatrixBase.h:43
Index size() const
Definition: SparseMatrixBase.h:181
Index innerSize() const
Definition: SparseMatrixBase.h:192
Index rows() const
Definition: SparseMatrixBase.h:176
bool isVector() const
Definition: SparseMatrixBase.h:186
@ IsVectorAtCompileTime
Definition: SparseMatrixBase.h:84
@ NumDimensions
Definition: SparseMatrixBase.h:90
@ ColsAtCompileTime
Definition: SparseMatrixBase.h:65
@ Flags
Definition: SparseMatrixBase.h:95
@ RowsAtCompileTime
Definition: SparseMatrixBase.h:59
@ SizeAtCompileTime
Definition: SparseMatrixBase.h:72
Scalar value_type
Definition: SparseMatrixBase.h:36
Index outerSize() const
Definition: SparseMatrixBase.h:189
const SparseView< Derived > pruned(const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Definition: SparseView.h:246
Index cols() const
Definition: SparseMatrixBase.h:178
SparseSymmetricPermutationProduct< Derived, Upper|Lower > twistedBy(const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
Definition: SparseMatrixBase.h:329
const internal::eval< Derived >::type eval() const
Definition: SparseMatrixBase.h:377
A versatible sparse matrix representation.
Definition: SparseMatrix.h:98
Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix.
Definition: SparseSelfAdjointView.h:45
Expression of a dense or sparse matrix with zero or too small values removed.
Definition: SparseView.h:46
Expression of the transpose of a matrix.
Definition: Transpose.h:54
Expression of a triangular part in a matrix.
Definition: TriangularMatrix.h:189
const unsigned int DirectAccessBit
Definition: Constants.h:155
const unsigned int RowMajorBit
Definition: Constants.h:66
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Definition: EigenBase.h:30
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:39
Derived & derived()
Definition: EigenBase.h:46
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition: NumTraits.h:233