Eigen::BlockSparseMatrixView< BlockSparseMatrixT > Class Template Reference
+ Inheritance diagram for Eigen::BlockSparseMatrixView< BlockSparseMatrixT >:

Public Types

enum  {
  Flags ,
  Options ,
  RowsAtCompileTime ,
  ColsAtCompileTime ,
  MaxColsAtCompileTime ,
  MaxRowsAtCompileTime
}
 
typedef BlockSparseMatrixT::Index Index
 
typedef BlockSparseMatrixT Nested
 
typedef Ref< typename BlockSparseMatrixT::BlockRealScalar > RealScalar
 
typedef Ref< typename BlockSparseMatrixT::BlockScalar > Scalar
 
- Public Types inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
typedef std::conditional_t< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > > AdjointReturnType
 
typedef Transpose< const Derived > ConstTransposeReturnType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndexPlainObject
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< Derived >::StorageIndex StorageIndex
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
typedef Transpose< Derived > TransposeReturnType
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< class >
typedef Eigen::Index Index
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

 BlockSparseMatrixView (const BlockSparseMatrixT &spblockmat)
 
Scalar coeff (Index row, Index col)
 
Scalar coeffRef (Index row, Index col)
 
Index cols () const
 
Index outerSize () const
 
Index rows () const
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
const AdjointReturnType adjoint () const
 
RealScalar blueNorm () const
 
Index cols () const
 
const SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
const CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
internal::traits< Derived >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
internal::traits< Derived >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
const internal::eval< Derived >::type eval () const
 
Index innerSize () const
 
bool isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isRValue () const
 
bool isVector () const
 
Derived & markAsRValue ()
 
RealScalar norm () const
 
const Product< Derived, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< Derived, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
const Product< Derived, OtherDerived, AliasFreeProductoperator* (const SparseMatrixBase< OtherDerived > &other) const
 
Derived & operator*= (const Scalar &other)
 
Derived & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator+= (const DiagonalBase< OtherDerived > &other)
 
Derived & operator+= (const EigenBase< OtherDerived > &other)
 
Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator-= (const DiagonalBase< OtherDerived > &other)
 
Derived & operator-= (const EigenBase< OtherDerived > &other)
 
Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator/= (const Scalar &other)
 
Derived & operator= (const Derived &other)
 
Derived & operator= (const EigenBase< OtherDerived > &other)
 
Derived & operator= (const ReturnByValue< OtherDerived > &other)
 
Derived & operator= (const SparseMatrixBase< OtherDerived > &other)
 
Index outerSize () const
 
const SparseView< Derived > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
Index rows () const
 
SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
SparseMatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
Scalar sum () const
 
DenseMatrixType toDense () const
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 
const TriangularView< const Derived, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< Derived, Upper|LowertwistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
- Public Member Functions inherited from Eigen::EigenBase< class >
void addTo (Dest &dst) const
 
void applyThisOnTheLeft (Dest &dst) const
 
void applyThisOnTheRight (Dest &dst) const
 
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
Derived & const_cast_derived () const
 
const Derived & const_derived () const
 
Derived & derived ()
 
const Derived & derived () const
 
void evalTo (Dest &dst) const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
void subTo (Dest &dst) const
 

Protected Attributes

const BlockSparseMatrixT & m_spblockmat
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
bool m_isRValue
 

Additional Inherited Members

- Public Attributes inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
 ColsAtCompileTime
 
 Flags
 
 InnerSizeAtCompileTime
 
 IsRowMajor
 
 IsVectorAtCompileTime
 
 MaxColsAtCompileTime
 
 MaxRowsAtCompileTime
 
 MaxSizeAtCompileTime
 
 NumDimensions
 
 RowsAtCompileTime
 
 SizeAtCompileTime
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
Derived & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 
- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrixT >
static StorageIndex convert_index (const Index idx)
 

Detailed Description

template<typename BlockSparseMatrixT>
class Eigen::BlockSparseMatrixView< BlockSparseMatrixT >

Definition at line 104 of file BlockSparseMatrix.h.

Member Typedef Documentation

◆ Index

template<typename BlockSparseMatrixT >
typedef BlockSparseMatrixT::Index Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::Index

Definition at line 109 of file BlockSparseMatrix.h.

◆ Nested

template<typename BlockSparseMatrixT >
typedef BlockSparseMatrixT Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::Nested

Definition at line 110 of file BlockSparseMatrix.h.

◆ RealScalar

template<typename BlockSparseMatrixT >
typedef Ref<typename BlockSparseMatrixT::BlockRealScalar> Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::RealScalar

Definition at line 108 of file BlockSparseMatrix.h.

◆ Scalar

template<typename BlockSparseMatrixT >
typedef Ref<typename BlockSparseMatrixT::BlockScalar> Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::Scalar

Definition at line 107 of file BlockSparseMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename BlockSparseMatrixT >
anonymous enum
Enumerator
Flags 
Options 
RowsAtCompileTime 
ColsAtCompileTime 
MaxColsAtCompileTime 
MaxRowsAtCompileTime 

Definition at line 111 of file BlockSparseMatrix.h.

111  {
112  Flags = BlockSparseMatrixT::Options,
113  Options = BlockSparseMatrixT::Options,
114  RowsAtCompileTime = BlockSparseMatrixT::RowsAtCompileTime,
115  ColsAtCompileTime = BlockSparseMatrixT::ColsAtCompileTime,
116  MaxColsAtCompileTime = BlockSparseMatrixT::MaxColsAtCompileTime,
117  MaxRowsAtCompileTime = BlockSparseMatrixT::MaxRowsAtCompileTime
118  };

Constructor & Destructor Documentation

◆ BlockSparseMatrixView()

template<typename BlockSparseMatrixT >
Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::BlockSparseMatrixView ( const BlockSparseMatrixT &  spblockmat)
inline

Definition at line 120 of file BlockSparseMatrix.h.

121  : m_spblockmat(spblockmat)
122  {}
const BlockSparseMatrixT & m_spblockmat

Member Function Documentation

◆ coeff()

template<typename BlockSparseMatrixT >
Scalar Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::coeff ( Index  row,
Index  col 
)
inline

Definition at line 136 of file BlockSparseMatrix.h.

137  {
138  return m_spblockmat.coeff(row, col);
139  }

◆ coeffRef()

template<typename BlockSparseMatrixT >
Scalar Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::coeffRef ( Index  row,
Index  col 
)
inline

Definition at line 140 of file BlockSparseMatrix.h.

141  {
142  return m_spblockmat.coeffRef(row, col);
143  }

◆ cols()

template<typename BlockSparseMatrixT >
Index Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::cols ( void  ) const
inline

Definition at line 128 of file BlockSparseMatrix.h.

129  {
130  return m_spblockmat.blockCols();
131  }

◆ outerSize()

template<typename BlockSparseMatrixT >
Index Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::outerSize ( ) const
inline

Definition at line 124 of file BlockSparseMatrix.h.

125  {
126  return (Flags&RowMajorBit) == 1 ? this->rows() : this->cols();
127  }
const unsigned int RowMajorBit

◆ rows()

template<typename BlockSparseMatrixT >
Index Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::rows ( void  ) const
inline

Definition at line 132 of file BlockSparseMatrix.h.

133  {
134  return m_spblockmat.blockRows();
135  }

Member Data Documentation

◆ m_spblockmat

template<typename BlockSparseMatrixT >
const BlockSparseMatrixT& Eigen::BlockSparseMatrixView< BlockSparseMatrixT >::m_spblockmat
protected

Definition at line 155 of file BlockSparseMatrix.h.


The documentation for this class was generated from the following file: