A versatile sparse matrix representation where each element is a block. More...

#include <BlockSparseMatrix.h>

Inheritance diagram for Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >:

Classes
class	BlockInnerIterator

class	InnerIterator

Public Types
enum	{ Options = _Options, Flags = Options, BlockSize =_BlockAtCompileTime, RowsAtCompileTime = Dynamic, ColsAtCompileTime = Dynamic, MaxRowsAtCompileTime = Dynamic, MaxColsAtCompileTime = Dynamic, IsVectorAtCompileTime = 0, IsColMajor = Flags&RowMajorBit ? 0 : 1 }

typedef Matrix< RealScalar, _BlockAtCompileTime, _BlockAtCompileTime, IsColMajor?ColMajor:RowMajor >	BlockRealScalar

typedef Matrix< Scalar, _BlockAtCompileTime, _BlockAtCompileTime, IsColMajor?ColMajor:RowMajor >	BlockScalar

typedef internal::conditional< _BlockAtCompileTime==Dynamic, Scalar, BlockScalar >::type	BlockScalarReturnType

typedef internal::ref_selector< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::type	Nested

typedef BlockSparseMatrix< Scalar, BlockSize, IsColMajor?ColMajor:RowMajor, StorageIndex >	PlainObject

typedef NumTraits< Scalar >::Real	RealScalar

typedef _Scalar	Scalar

typedef _StorageIndex	StorageIndex

Public Types inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >
enum

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > > >, Transpose< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > > >::type	AdjointReturnType

typedef EigenBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	Base

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	BlockXpr

typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type	CoeffReturnType

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ColsBlockXpr

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::RowsAtCompileTime, 1,!IsRowMajor >	ColXpr

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > & >::type	ConjugateReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType

typedef const Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	ConstBlockXpr

typedef const Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ConstColsBlockXpr

typedef const Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::RowsAtCompileTime, 1,!IsRowMajor >	ConstColXpr

typedef Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType

typedef Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType

typedef const Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Dynamic, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr

typedef const Block< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, 1, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr

typedef const VectorBlock< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	ConstSegmentReturnType

typedef internal::add_const< Transpose< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > > >::type	ConstTransposeReturnType

typedef CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	CwiseAbs2ReturnType

typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	CwiseAbsReturnType

typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	CwiseInverseReturnType

typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, Scalar, internal::cmp_EQ >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const ConstantReturnType >	CwiseScalarEqualReturnType

typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	CwiseSignReturnType

typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	CwiseSqrtReturnType

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType

typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	ImagReturnType

typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Dynamic, Dynamic, true >	InnerVectorsReturnType

typedef CwiseUnaryOp< internal::scalar_opposite_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	NegativeReturnType

typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	NonConstImagReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >, BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > & >::type	NonConstRealReturnType

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, StorageIndex >	PlainObject

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > & >::type	RealReturnType

typedef NumTraits< Scalar >::Real	RealScalar

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Dynamic, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr

typedef Block< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, 1, internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajor >	RowXpr

typedef internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::Scalar	Scalar

typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

typedef VectorBlock< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	SegmentReturnType

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType

typedef SparseMatrixBase	StorageBaseType

typedef internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::StorageIndex	StorageIndex

typedef internal::traits< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::StorageKind	StorageKind

typedef Transpose< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	TransposeReturnType

typedef Scalar	value_type

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
Index	blockCols () const

Index	blockColsIndex (Index bj) const

Index	blockInnerIndex (Index bi) const

Index	blockInnerSize (Index bi) const

Index	blockOuterIndex (Index bj) const

Index	blockOuterSize (Index bj) const

Index	blockPtr (Index id) const

Index	blockRows () const

Index	blockRowsIndex (Index bi) const

	BlockSparseMatrix ()

	BlockSparseMatrix (Index brow, Index bcol)
	Construct and resize. More...

	BlockSparseMatrix (const BlockSparseMatrix &other)
	Copy-constructor. More...

template<typename MatrixType >
	BlockSparseMatrix (const MatrixType &spmat)
	Constructor from a sparse matrix. More...

Map< const BlockScalar >	coeff (Index brow, Index bcol) const

Ref< BlockScalar >	coeffRef (Index brow, Index bcol)

Index	cols () const

Index	innerBlocks () const

StorageIndex *	innerIndexPtr ()

const StorageIndex *	innerIndexPtr () const

Index	innerSize () const

Index	innerToBlock (Index inner) const

bool	isCompressed () const
	for compatibility purposes with the SparseMatrix class More...

Index	nonZeros () const

Index	nonZerosBlocks () const

template<typename VecType >
BlockSparseTimeDenseProduct< BlockSparseMatrix, VecType >	operator* (const VecType &lhs) const

BlockSparseMatrix &	operator= (BlockSparseMatrix other)

template<typename MatrixType >
BlockSparseMatrix &	operator= (const MatrixType &spmat)
	Assignment from a sparse matrix with the same storage order. More...

Index	outerBlocks () const

StorageIndex *	outerIndexPtr ()

const StorageIndex *	outerIndexPtr () const

Index	outerSize () const

Index	outerToBlock (Index outer) const

void	reserve (const Index nonzerosblocks)
	Allocate the internal array of pointers to blocks and their inner indices. More...

void	resize (Index brow, Index bcol)
	Set the number of rows and columns blocks. More...

Index	rows () const

void	setBlockLayout (const VectorXi &rowBlocks, const VectorXi &colBlocks)
	Set the row and column block layouts,. More...

void	setBlockSize (Index blockSize)
	set the block size at runtime for fixed-size block layout More...

template<typename MatrixType >
void	setBlockStructure (const MatrixType &blockPattern)
	Set the nonzero block pattern of the matrix. More...

template<typename InputIterator >
void	setFromTriplets (const InputIterator &begin, const InputIterator &end)
	Fill values in a matrix from a triplet list. More...

BlockScalarReturnType *	valuePtr ()

	~BlockSparseMatrix ()

Public Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >
const AdjointReturnType	adjoint () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

EIGEN_DEVICE_FUNC const ConstBlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). */. More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). */. More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...

RealScalar	blueNorm () const

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	bottomLeftCorner (Index cRows, Index cCols)

EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	bottomRightCorner (Index cRows, Index cCols)

EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...

EIGEN_DEVICE_FUNC RowsBlockXpr	bottomRows (Index n)

EIGEN_DEVICE_FUNC ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index). More...

EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>(). More...

EIGEN_DEVICE_FUNC CastXpr< NewType >::Type	cast () const

EIGEN_DEVICE_FUNC ColXpr	col (Index i)

EIGEN_DEVICE_FUNC ConstColXpr	col (Index i) const
	This is the const version of col(). More...

Index	cols () const

EIGEN_DEVICE_FUNC ConjugateReturnType	conjugate () const

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	const_cast_derived () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType	cwiseAbs () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType	cwiseAbs2 () const

EIGEN_DEVICE_FUNC const CwiseBinaryOp< std::equal_to< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

EIGEN_DEVICE_FUNC const CwiseInverseReturnType	cwiseInverse () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const ConstantReturnType >	cwiseMax (const Scalar &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const ConstantReturnType >	cwiseMin (const Scalar &other) const

EIGEN_DEVICE_FUNC const CwiseBinaryOp< std::not_equal_to< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC const CwiseSignReturnType	cwiseSign () const

EIGEN_DEVICE_FUNC const CwiseSqrtReturnType	cwiseSqrt () const

const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	derived () const

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	derived ()

Scalar	dot (const MatrixBase< OtherDerived > &other) const

Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	EIGEN_CWISE_BINARY_RETURN_TYPE (BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, OtherDerived, product) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const internal::eval< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >::type	eval () const

EIGEN_DEVICE_FUNC SegmentReturnType	head (Index n)

EIGEN_DEVICE_FUNC ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index). More...

EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	head (Index n=N)

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...

EIGEN_DEVICE_FUNC const ImagReturnType	imag () const

EIGEN_DEVICE_FUNC NonConstImagReturnType	imag ()

Index	innerSize () const

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isRValue () const

bool	isVector () const

EIGEN_DEVICE_FUNC ColsBlockXpr	leftCols (Index n)

EIGEN_DEVICE_FUNC ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index). More...

EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	leftCols (Index n=N)

EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>(). More...

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	markAsRValue ()

EIGEN_DEVICE_FUNC ColsBlockXpr	middleCols (Index startCol, Index numCols)

EIGEN_DEVICE_FUNC ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index). More...

EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). More...

EIGEN_DEVICE_FUNC RowsBlockXpr	middleRows (Index startRow, Index n)

EIGEN_DEVICE_FUNC ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index). More...

EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>(). More...

RealScalar	norm () const

EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_and_op, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const Product< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const

const Product< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const

const Product< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator*= (const Scalar &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator*= (const SparseMatrixBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator+= (const DiagonalBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator+= (const EigenBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC const NegativeReturnType	operator- () const

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator-= (const DiagonalBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator-= (const EigenBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator/= (const Scalar &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator= (const EigenBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator= (const ReturnByValue< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator= (const SparseMatrixBase< OtherDerived > &other)

BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	operator= (const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &other)

EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_or_op, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, const OtherDerived >	operator\|\| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

Index	outerSize () const

const SparseView< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const

EIGEN_DEVICE_FUNC RealReturnType	real () const

EIGEN_DEVICE_FUNC NonConstRealReturnType	real ()

EIGEN_DEVICE_FUNC ColsBlockXpr	rightCols (Index n)

EIGEN_DEVICE_FUNC ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index). More...

EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	rightCols (Index n=N)

EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>(). More...

EIGEN_DEVICE_FUNC RowXpr	row (Index i)

EIGEN_DEVICE_FUNC ConstRowXpr	row (Index i) const
	This is the const version of row(). */. More...

Index	rows () const

EIGEN_DEVICE_FUNC SegmentReturnType	segment (Index start, Index n)

EIGEN_DEVICE_FUNC ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index). More...

EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...

ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const

SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()

Index	size () const

	SparseMatrixBase ()

RealScalar	squaredNorm () const

Scalar	sum () const

EIGEN_DEVICE_FUNC SegmentReturnType	tail (Index n)

EIGEN_DEVICE_FUNC ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index). More...

EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	tail (Index n=N)

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>. More...

DenseMatrixType	toDense () const

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	topLeftCorner (Index cRows, Index cCols)

EIGEN_DEVICE_FUNC const ConstBlockXpr	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	topRightCorner (Index cRows, Index cCols)

EIGEN_DEVICE_FUNC const ConstBlockXpr	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...

EIGEN_DEVICE_FUNC RowsBlockXpr	topRows (Index n)

EIGEN_DEVICE_FUNC ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index). More...

EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	topRows (Index n=N)

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>(). More...

TransposeReturnType	transpose ()

const ConstTransposeReturnType	transpose () const

const TriangularView< const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Mode >	triangularView () const

SparseSymmetricPermutationProduct< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >, Upper\|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const

EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	size () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Protected Member Functions
Map< BlockScalar >	insert (Index brow, Index bcol)

Protected Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >
BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	assign (const OtherDerived &other)

void	assignGeneric (const OtherDerived &other)

Protected Attributes
StorageIndex *	m_blockPtr

Index	m_blockSize

StorageIndex *	m_indices

Index	m_innerBSize

StorageIndex *	m_innerOffset

Index	m_nonzeros

Index	m_nonzerosblocks

Index	m_outerBSize

StorageIndex *	m_outerIndex

StorageIndex *	m_outerOffset

Scalar *	m_values

Protected Attributes inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >
bool	m_isRValue

Friends
std::ostream &	operator<< (std::ostream &s, const BlockSparseMatrix &m)

void	swap (BlockSparseMatrix &first, BlockSparseMatrix &second)

Additional Inherited Members
Static Protected Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > >
static StorageIndex	convert_index (const Index idx)

Detailed Description

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>
class Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >

A versatile sparse matrix representation where each element is a block.

This class provides routines to manipulate block sparse matrices stored in a BSR-like representation. There are two main types :

All blocks have the same number of rows and columns, called block size in the following. In this case, if this block size is known at compile time, it can be given as a template parameter like
BlockSparseMatrix<Scalar, 3, ColMajor> bmat(b_rows, b_cols);
Here, bmat is a b_rows x b_cols block sparse matrix where each coefficient is a 3x3 dense matrix. If the block size is fixed but will be given at runtime,
BlockSparseMatrix<Scalar, Dynamic, ColMajor> bmat(b_rows, b_cols);
bmat.setBlockSize(block_size);
The second case is for variable-block sparse matrices. Here each block has its own dimensions. The only restriction is that all the blocks in a row (resp. a column) should have the same number of rows (resp. of columns). It is thus required in this case to describe the layout of the matrix by calling setBlockLayout(rowBlocks, colBlocks).

In any of the previous case, the matrix can be filled by calling setFromTriplets(). A regular sparse matrix can be converted to a block sparse matrix and vice versa. It is obviously required to describe the block layout beforehand by calling either setBlockSize() for fixed-size blocks or setBlockLayout for variable-size blocks.

Template Parameters

_Scalar	The Scalar type
_BlockAtCompileTime	The block layout option. It takes the following values Dynamic : block size known at runtime a numeric number : fixed-size block known at compile time

Definition at line 54 of file BlockSparseMatrix.h.

Member Typedef Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef Matrix<RealScalar, _BlockAtCompileTime, _BlockAtCompileTime,IsColMajor ? ColMajor : RowMajor> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockRealScalar

Definition at line 304 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef Matrix<Scalar, _BlockAtCompileTime, _BlockAtCompileTime,IsColMajor ? ColMajor : RowMajor> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockScalar

Definition at line 303 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef internal::conditional<_BlockAtCompileTime==Dynamic, Scalar, BlockScalar>::type Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockScalarReturnType

Definition at line 305 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef internal::ref_selector<BlockSparseMatrix<_Scalar, _BlockAtCompileTime, _Options, _StorageIndex> >::type Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::Nested

Definition at line 290 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef BlockSparseMatrix<Scalar, BlockSize, IsColMajor ? ColMajor : RowMajor, StorageIndex> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::PlainObject

Definition at line 306 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef NumTraits<Scalar>::Real Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::RealScalar

Definition at line 288 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef _Scalar Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::Scalar

Definition at line 287 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

typedef _StorageIndex Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::StorageIndex

Definition at line 289 of file BlockSparseMatrix.h.

Member Enumeration Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

anonymous enum

Enumerator
Options
Flags
BlockSize
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
IsVectorAtCompileTime
IsColMajor

Definition at line 292 of file BlockSparseMatrix.h.

Constructor & Destructor Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockSparseMatrix ( )

inline

Definition at line 309 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockSparseMatrix	(	Index	brow,
		Index	bcol
	)

inline

Construct and resize.

Definition at line 320 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockSparseMatrix ( const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > & other )

inline

Copy-constructor.

Definition at line 331 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::~BlockSparseMatrix ( )

inline

Definition at line 373 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

template<typename MatrixType >

Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::BlockSparseMatrix ( const MatrixType & spmat )

inline

Constructor from a sparse matrix.

Definition at line 389 of file BlockSparseMatrix.h.

Member Function Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockCols ( ) const

inline

Returns: the number of columns grouped by blocks

Definition at line 770 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockColsIndex ( Index bj ) const

inline

Returns: the starting index of the bj col block

Definition at line 884 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockInnerIndex ( Index bi ) const

inline

Definition at line 893 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockInnerSize ( Index bi ) const

inline

Definition at line 899 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockOuterIndex ( Index bj ) const

inline

Definition at line 889 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockOuterSize ( Index bj ) const

inline

Definition at line 903 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockPtr ( Index id ) const

inline

Returns: the starting position of the block id in the array of values

Definition at line 936 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockRows ( ) const

inline

Returns: the number of rows grouped by blocks

Definition at line 765 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::blockRowsIndex ( Index bi ) const

inline

Returns: the starting index of the bi row block

Definition at line 876 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Map<const BlockScalar> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::coeff	(	Index	brow,
		Index	bcol
	)		const

inline

Returns: the value of the (i,j) block as an Eigen Dense Matrix

Definition at line 832 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Ref<BlockScalar> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::coeffRef	(	Index	brow,
		Index	bcol
	)

inline

Returns: a reference to the (i,j) block as an Eigen Dense Matrix

Definition at line 806 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::cols ( void ) const

inline

Returns: the number of cols

Definition at line 747 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::innerBlocks ( ) const

inline

Definition at line 776 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::innerIndexPtr ( )

inline

Definition at line 866 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

const StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::innerIndexPtr ( ) const

inline

Definition at line 867 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::innerSize ( ) const

inline

Definition at line 753 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::innerToBlock ( Index inner ) const

inline

Returns: the block index where inner belongs to

Definition at line 791 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Map<BlockScalar> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::insert	(	Index	brow,
		Index	bcol
	)

protected

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

bool Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::isCompressed ( ) const

inline

for compatibility purposes with the SparseMatrix class

Definition at line 872 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::nonZeros ( ) const

inline

Returns: the total number of nonzero elements, including eventual explicit zeros in blocks

Definition at line 862 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::nonZerosBlocks ( ) const

inline

Returns: the number of nonzero blocks

Definition at line 860 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

template<typename VecType >

BlockSparseTimeDenseProduct<BlockSparseMatrix, VecType> Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::operator* ( const VecType & lhs ) const

inline

Definition at line 854 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

BlockSparseMatrix& Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::operator= ( BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > other )

inline

Definition at line 365 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

template<typename MatrixType >

BlockSparseMatrix& Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::operator= ( const MatrixType & spmat )

inline

Assignment from a sparse matrix with the same storage order.

Convert from a sparse matrix to block sparse matrix.

Warning: Before calling this function, tt is necessary to call either setBlockLayout() (matrices with variable-size blocks) or setBlockSize() (for fixed-size blocks).

Definition at line 405 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::outerBlocks ( ) const

inline

Definition at line 775 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::outerIndexPtr ( )

inline

Definition at line 868 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

const StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::outerIndexPtr ( ) const

inline

Definition at line 869 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::outerSize ( ) const

inline

Definition at line 759 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::outerToBlock ( Index outer ) const

inline

Returns: the block index where outer belongs to

Definition at line 779 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::reserve ( const Index nonzerosblocks )

inline

Allocate the internal array of pointers to blocks and their inner indices.

Note: For fixed-size blocks, call setBlockSize() to set the block. And For variable-size blocks, call setBlockLayout() before using this function

Parameters

nonzerosblocks Number of nonzero blocks. The total number of nonzeros is is computed in setBlockLayout() for variable-size blocks

See also: setBlockSize()

Definition at line 596 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::resize	(	Index	brow,
		Index	bcol
	)

inline

Set the number of rows and columns blocks.

Definition at line 538 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::rows ( void ) const

inline

Returns: the number of rows

Definition at line 738 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::setBlockLayout	(	const VectorXi &	rowBlocks,
		const VectorXi &	colBlocks
	)

inline

Set the row and column block layouts,.

This function set the size of each row and column block. So this function should be used only for blocks with variable size.

Parameters

rowBlocks	: Number of rows per row block
colBlocks	: Number of columns per column block

See also: resize(), setBlockSize()

Definition at line 563 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::setBlockSize ( Index blockSize )

inline

set the block size at runtime for fixed-size block layout

Call this only for fixed-size blocks

Definition at line 549 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

template<typename MatrixType >

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::setBlockStructure ( const MatrixType & blockPattern )

inline

Set the nonzero block pattern of the matrix.

Given a sparse matrix describing the nonzero block pattern, this function prepares the internal pointers for values. After calling this function, any nonzero block (bi, bj) can be set with a simple call to coeffRef(bi,bj).

Warning: Before calling this function, tt is necessary to call either setBlockLayout() (matrices with variable-size blocks) or setBlockSize() (for fixed-size blocks).

Parameters

blockPattern Sparse matrix of boolean elements describing the block structure

See also: setBlockLayout(); setBlockSize()

Definition at line 498 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

template<typename InputIterator >

void Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::setFromTriplets	(	const InputIterator &	begin,
		const InputIterator &	end
	)

inline

Fill values in a matrix from a triplet list.

Each triplet item has a block stored in an Eigen dense matrix. The InputIterator class should provide the functions row(), col() and value()

Note: For fixed-size blocks, call setBlockSize() before this function.

FIXME Do not accept duplicates

Definition at line 631 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

BlockScalarReturnType* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::valuePtr ( )

inline

Definition at line 864 of file BlockSparseMatrix.h.

Friends And Related Function Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

std::ostream& operator<<	(	std::ostream &	s,
		const BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	m
	)

friend

Definition at line 918 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

void swap	(	BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	first,
		BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > &	second
	)

friend

Definition at line 350 of file BlockSparseMatrix.h.

Member Data Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_blockPtr

protected

Definition at line 965 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_blockSize

protected

Definition at line 968 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_indices

protected

Definition at line 966 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_innerBSize

protected

Definition at line 958 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_innerOffset

protected

Definition at line 960 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_nonzeros

protected

Definition at line 963 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_nonzerosblocks

protected

Definition at line 962 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Index Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_outerBSize

protected

Definition at line 959 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_outerIndex

protected

Definition at line 967 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

StorageIndex* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_outerOffset

protected

Definition at line 961 of file BlockSparseMatrix.h.

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>

Scalar* Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >::m_values

protected

Definition at line 964 of file BlockSparseMatrix.h.

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

BlockSparseMatrix.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex> class Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename _Scalar, int _BlockAtCompileTime, int _Options, typename _StorageIndex>
class Eigen::BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex >