10 #ifndef EIGEN_SPARSEMATRIXBASE_H 11 #define EIGEN_SPARSEMATRIXBASE_H 26 template<
typename Derived>
class SparseMatrixBase
27 :
public EigenBase<Derived>
31 typedef typename internal::traits<Derived>::Scalar Scalar;
38 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
39 typedef typename internal::traits<Derived>::StorageKind StorageKind;
40 typedef typename internal::traits<Derived>::StorageIndex StorageIndex;
41 typedef typename internal::add_const_on_value_type_if_arithmetic<
42 typename internal::packet_traits<Scalar>::type
43 >::type PacketReturnType;
50 template<
typename OtherDerived>
68 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
69 internal::traits<Derived>::ColsAtCompileTime>::ret),
77 MaxSizeAtCompileTime = (internal::size_at_compile_time<MaxRowsAtCompileTime,
78 MaxColsAtCompileTime>::ret),
86 Flags = internal::traits<Derived>::Flags,
96 #ifndef EIGEN_PARSED_BY_DOXYGEN
102 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
105 >::type AdjointReturnType;
112 #ifndef EIGEN_PARSED_BY_DOXYGEN 123 typedef typename internal::conditional<_HasDirectAccess, const Scalar&, Scalar>::type CoeffReturnType;
134 inline const Derived&
derived()
const {
return *
static_cast<const Derived*
>(
this); }
135 inline Derived&
derived() {
return *
static_cast<Derived*
>(
this); }
136 inline Derived& const_cast_derived()
const 141 #endif // not EIGEN_PARSED_BY_DOXYGEN 143 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::SparseMatrixBase 144 #ifdef EIGEN_PARSED_BY_DOXYGEN 145 #define EIGEN_DOC_UNARY_ADDONS(METHOD,OP) 146 #define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL 147 #define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND) 149 #define EIGEN_DOC_UNARY_ADDONS(X,Y) 150 #define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL 151 #define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND) 153 # include "../plugins/CommonCwiseUnaryOps.h" 154 # include "../plugins/CommonCwiseBinaryOps.h" 155 # include "../plugins/MatrixCwiseUnaryOps.h" 156 # include "../plugins/MatrixCwiseBinaryOps.h" 157 # include "../plugins/BlockMethods.h" 158 # ifdef EIGEN_SPARSEMATRIXBASE_PLUGIN 159 # include EIGEN_SPARSEMATRIXBASE_PLUGIN 161 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS 162 #undef EIGEN_DOC_UNARY_ADDONS 163 #undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL 164 #undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF 185 bool isRValue()
const {
return m_isRValue; }
186 Derived& markAsRValue() { m_isRValue =
true;
return derived(); }
191 template<
typename OtherDerived>
192 Derived& operator=(
const ReturnByValue<OtherDerived>& other);
194 template<
typename OtherDerived>
197 inline Derived& operator=(
const Derived& other);
201 template<
typename OtherDerived>
202 inline Derived& assign(
const OtherDerived& other);
204 template<
typename OtherDerived>
205 inline void assignGeneric(
const OtherDerived& other);
209 friend std::ostream & operator << (std::ostream & s,
const SparseMatrixBase& m)
211 typedef typename Derived::Nested Nested;
212 typedef typename internal::remove_all<Nested>::type NestedCleaned;
216 const Nested nm(m.derived());
217 internal::evaluator<NestedCleaned> thisEval(nm);
221 for (
typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval,
row); it; ++it)
223 for ( ; col<it.index(); ++
col)
225 s << it.value() <<
" ";
228 for ( ; col<m.cols(); ++
col)
235 const Nested nm(m.derived());
236 internal::evaluator<NestedCleaned> thisEval(nm);
239 for (
typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval, 0); it; ++it)
241 for ( ; row<it.index(); ++
row)
242 s <<
"0" << std::endl;
243 s << it.value() << std::endl;
246 for ( ; row<m.rows(); ++
row)
247 s <<
"0" << std::endl;
252 s << static_cast<const SparseMatrixBase<SparseMatrix<Scalar, RowMajorBit, StorageIndex> >&>(trans);
258 template<
typename OtherDerived>
260 template<
typename OtherDerived>
263 template<
typename OtherDerived>
264 Derived& operator+=(
const DiagonalBase<OtherDerived>& other);
265 template<
typename OtherDerived>
266 Derived& operator-=(
const DiagonalBase<OtherDerived>& other);
268 Derived& operator*=(
const Scalar& other);
269 Derived& operator/=(
const Scalar& other);
271 template<
typename OtherDerived>
struct CwiseProductDenseReturnType {
273 typename internal::traits<Derived>::Scalar,
274 typename internal::traits<OtherDerived>::Scalar
281 template<
typename OtherDerived>
282 EIGEN_STRONG_INLINE
const typename CwiseProductDenseReturnType<OtherDerived>::Type
286 template<
typename OtherDerived>
288 operator*(
const DiagonalBase<OtherDerived> &other)
const 292 template<
typename OtherDerived>
friend 298 template<
typename OtherDerived>
303 template<
typename OtherDerived>
309 template<
typename OtherDerived>
friend 317 return SparseSymmetricPermutationProduct<Derived,Upper|Lower>(
derived(), perm);
320 template<
typename OtherDerived>
329 template<
unsigned int UpLo>
inline 330 typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
331 template<
unsigned int UpLo>
inline 332 typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
336 RealScalar squaredNorm()
const;
337 RealScalar norm()
const;
338 RealScalar blueNorm()
const;
340 TransposeReturnType transpose() {
return TransposeReturnType(
derived()); }
341 const ConstTransposeReturnType transpose()
const {
return ConstTransposeReturnType(
derived()); }
342 const AdjointReturnType adjoint()
const {
return AdjointReturnType(transpose()); }
356 DenseMatrixType toDense()
const 358 return DenseMatrixType(
derived());
361 template<
typename OtherDerived>
365 template<
typename OtherDerived>
368 {
return toDense().isApprox(other,prec); }
375 inline const typename internal::eval<Derived>::type
eval()
const 376 {
return typename internal::eval<Derived>::type(
derived()); }
380 inline const SparseView<Derived>
387 static inline StorageIndex convert_index(
const Index idx) {
388 return internal::convert_index<StorageIndex>(idx);
391 template<
typename Dest>
void evalTo(Dest &)
const;
396 #endif // EIGEN_SPARSEMATRIXBASE_H Definition: SparseMatrixBase.h:61
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:60
Index innerSize() const
Definition: SparseMatrixBase.h:183
Index cols() const
Definition: SparseMatrixBase.h:169
Expression of the product of two arbitrary matrices or vectors.
Definition: Product.h:71
A versatible sparse matrix representation.
Definition: SparseMatrix.h:92
Expression of the transpose of a matrix.
Definition: Transpose.h:52
const unsigned int DirectAccessBit
Definition: Constants.h:150
RowXpr row(Index i)
Definition: SparseMatrixBase.h:860
Namespace containing all symbols from the Eigen library.
Definition: Core:287
Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix.
Definition: SparseSelfAdjointView.h:43
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:150
Index outerSize() const
Definition: SparseMatrixBase.h:180
Derived & derived()
Definition: EigenBase.h:44
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:37
const unsigned int RowMajorBit
Definition: Constants.h:61
bool isVector() const
Definition: SparseMatrixBase.h:177
Definition: EigenBase.h:28
Index size() const
Definition: SparseMatrixBase.h:172
const SparseView< Derived > pruned(const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Definition: SparseView.h:214
Generic expression where a coefficient-wise binary operator is applied to two expressions.
Definition: CwiseBinaryOp.h:77
Index rows() const
Definition: SparseMatrixBase.h:167
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:281
Definition: SparseMatrixBase.h:80
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, Derived, Constant< T > > operator*(const T &scalar) const
InnerVectorReturnType innerVector(Index outer)
Definition: SparseBlock.h:333
Definition: SparseMatrixBase.h:68
Scalar value_type
Definition: SparseMatrixBase.h:36
Definition: SparseMatrixBase.h:86
InnerVectorsReturnType innerVectors(Index outerStart, Index outerSize)
Definition: SparseBlock.h:348
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
Expression of a triangular part in a matrix.
Definition: TriangularMatrix.h:186
SparseSymmetricPermutationProduct< Derived, Upper|Lower > twistedBy(const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
Definition: SparseMatrixBase.h:315
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
Definition: XprHelper.h:757
const internal::eval< Derived >::type eval() const
Definition: SparseMatrixBase.h:375
ColXpr col(Index i)
Definition: SparseMatrixBase.h:839
Generic expression where a coefficient-wise unary operator is applied to an expression.
Definition: CwiseUnaryOp.h:55
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48
Definition: SparseMatrixBase.h:55