Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType > Class Template Reference

#include <BlockSparseMatrix.h>

Public Types
enum	{ ColsAtCompileTime = VectorType::ColsAtCompileTime , RowsAtCompileTime = VectorType::RowsAtCompileTime , Flags = VectorType::Flags }
typedef Ref< Matrix< typename VectorType::Scalar, RowsAtCompileTime, ColsAtCompileTime > >	Scalar
typedef BlockSparseMatrixT::Index	Index

Public Member Functions
	BlockVectorReturn (const BlockSparseMatrixT &spblockmat, VectorType &vec)
Index	size () const
Scalar	coeffRef (Index bi)
Scalar	coeffRef (Index bi, Index j)

Protected Attributes
const BlockSparseMatrixT &	m_spblockmat
VectorType &	m_vec

Member Typedef Documentation

Index

template<typename BlockSparseMatrixT , typename VectorType >

typedef BlockSparseMatrixT::Index Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::Index

Scalar

template<typename BlockSparseMatrixT , typename VectorType >

typedef Ref<Matrix<typename VectorType::Scalar, RowsAtCompileTime, ColsAtCompileTime> > Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::Scalar

Member Enumeration Documentation

anonymous enum

template<typename BlockSparseMatrixT , typename VectorType >

anonymous enum

Enumerator
ColsAtCompileTime
RowsAtCompileTime
Flags

       {
    ColsAtCompileTime = VectorType::ColsAtCompileTime,
    RowsAtCompileTime = VectorType::RowsAtCompileTime,
    Flags = VectorType::Flags
  };

Constructor & Destructor Documentation

BlockVectorReturn()

template<typename BlockSparseMatrixT , typename VectorType >

Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::BlockVectorReturn ( const BlockSparseMatrixT &  spblockmat, VectorType &  vec  )

inline

: m_spblockmat(spblockmat), m_vec(vec) {}

Member Function Documentation

coeffRef() [1/2]

template<typename BlockSparseMatrixT , typename VectorType >

Scalar Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::coeffRef ( Index  bi )

inline

                                   {
    Index startRow = m_spblockmat.blockRowsIndex(bi);
    Index rowSize = m_spblockmat.blockRowsIndex(bi + 1) - startRow;
    return m_vec.middleRows(startRow, rowSize);
  }

References Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_spblockmat, and Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_vec.

coeffRef() [2/2]

template<typename BlockSparseMatrixT , typename VectorType >

Scalar Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::coeffRef ( Index  bi, Index  j  )

inline

                                            {
    Index startRow = m_spblockmat.blockRowsIndex(bi);
    Index rowSize = m_spblockmat.blockRowsIndex(bi + 1) - startRow;
    return m_vec.block(startRow, j, rowSize, 1);
  }

References j, Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_spblockmat, and Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_vec.

size()

template<typename BlockSparseMatrixT , typename VectorType >

Index Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::size ( ) const

inline

{ return m_spblockmat.blockRows(); }

References Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_spblockmat.

Member Data Documentation

m_spblockmat

template<typename BlockSparseMatrixT , typename VectorType >

const BlockSparseMatrixT& Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_spblockmat

protected

Referenced by Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::coeffRef(), and Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::size().

m_vec

template<typename BlockSparseMatrixT , typename VectorType >

VectorType& Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::m_vec

protected

Referenced by Eigen::BlockVectorReturn< BlockSparseMatrixT, VectorType >::coeffRef().

---

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

• BlockSparseMatrix.h