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

Inheritance diagram for Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >:

Public Types
enum	{ Options , Flags , BlockSize , RowsAtCompileTime , ColsAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , IsVectorAtCompileTime , IsColMajor }

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

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

typedef std::conditional_t< _BlockAtCompileTime==Dynamic, Scalar, BlockScalar >	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_ > >
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, StorageIndex >	PlainObject

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
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 (const BlockSparseMatrix &other)
	Copy-constructor. More...

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

	BlockSparseMatrix (Index brow, Index bcol)
	Construct and resize. 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

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, AliasFreeProduct >	operator* (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\|Lower >	twistedBy (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 Member Functions
Map< BlockScalar >	insert (Index brow, Index bcol)

Protected Member Functions inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ > >
Derived &	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

Additional Inherited Members
Public Attributes inherited from Eigen::SparseMatrixBase< BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ > >
	ColsAtCompileTime

	Flags

	InnerSizeAtCompileTime

	IsRowMajor

	IsVectorAtCompileTime

	MaxColsAtCompileTime

	MaxRowsAtCompileTime

	MaxSizeAtCompileTime

	NumDimensions

	RowsAtCompileTime

	SizeAtCompileTime

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);

Code
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);

Code
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 286 of file BlockSparseMatrix.h.

Member Typedef Documentation

◆ BlockRealScalar

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 306 of file BlockSparseMatrix.h.

◆ BlockScalar

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 305 of file BlockSparseMatrix.h.

◆ BlockScalarReturnType

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

typedef std::conditional_t<_BlockAtCompileTime==Dynamic, Scalar, BlockScalar> Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::BlockScalarReturnType

Definition at line 307 of file BlockSparseMatrix.h.

◆ Nested

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 292 of file BlockSparseMatrix.h.

◆ PlainObject

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 308 of file BlockSparseMatrix.h.

◆ RealScalar

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

typedef NumTraits<Scalar>::Real Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::RealScalar

Definition at line 290 of file BlockSparseMatrix.h.

◆ Scalar

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

typedef Scalar_ Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::Scalar

Definition at line 289 of file BlockSparseMatrix.h.

◆ StorageIndex

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

typedef StorageIndex_ Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::StorageIndex

Definition at line 291 of file BlockSparseMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

anonymous enum

Enumerator
Options
Flags
BlockSize
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
IsVectorAtCompileTime
IsColMajor

Definition at line 294 of file BlockSparseMatrix.h.

          {
       Options = Options_,
       Flags = Options,
       BlockSize=_BlockAtCompileTime,
       RowsAtCompileTime = Dynamic,
       ColsAtCompileTime = Dynamic,
       MaxRowsAtCompileTime = Dynamic,
       MaxColsAtCompileTime = Dynamic,
       IsVectorAtCompileTime = 0,
       IsColMajor = Flags&RowMajorBit ? 0 : 1
     };

Code

Constructor & Destructor Documentation

◆ BlockSparseMatrix() [1/4]

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::BlockSparseMatrix ( )

inline

Definition at line 311 of file BlockSparseMatrix.h.

     : m_innerBSize(0),m_outerBSize(0),m_innerOffset(0),m_outerOffset(0),
       m_nonzerosblocks(0),m_values(0),m_blockPtr(0),m_indices(0),
       m_outerIndex(0),m_blockSize(BlockSize)
     { }

Code

◆ BlockSparseMatrix() [2/4]

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 322 of file BlockSparseMatrix.h.

       : m_innerBSize(IsColMajor ? brow : bcol),
         m_outerBSize(IsColMajor ? bcol : brow),
         m_innerOffset(0),m_outerOffset(0),m_nonzerosblocks(0),
         m_values(0),m_blockPtr(0),m_indices(0),
         m_outerIndex(0),m_blockSize(BlockSize)
     { }

Code

◆ BlockSparseMatrix() [3/4]

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 333 of file BlockSparseMatrix.h.

       : m_innerBSize(other.m_innerBSize),m_outerBSize(other.m_outerBSize),
         m_nonzerosblocks(other.m_nonzerosblocks),m_nonzeros(other.m_nonzeros),
         m_blockPtr(0),m_blockSize(other.m_blockSize)
     {
       // should we allow copying between variable-size blocks and fixed-size blocks ??
       eigen_assert(m_blockSize == BlockSize && " CAN NOT COPY BETWEEN FIXED-SIZE AND VARIABLE-SIZE BLOCKS");
  
       std::copy(other.m_innerOffset, other.m_innerOffset+m_innerBSize+1, m_innerOffset);
       std::copy(other.m_outerOffset, other.m_outerOffset+m_outerBSize+1, m_outerOffset);
       std::copy(other.m_values, other.m_values+m_nonzeros, m_values);
  
       if(m_blockSize != Dynamic)
         std::copy(other.m_blockPtr, other.m_blockPtr+m_nonzerosblocks, m_blockPtr);
  
       std::copy(other.m_indices, other.m_indices+m_nonzerosblocks, m_indices);
       std::copy(other.m_outerIndex, other.m_outerIndex+m_outerBSize, m_outerIndex);
     }

Code

◆ ~BlockSparseMatrix()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::~BlockSparseMatrix ( )

inline

Definition at line 375 of file BlockSparseMatrix.h.

     {
       delete[] m_outerIndex;
       delete[] m_innerOffset;
       delete[] m_outerOffset;
       delete[] m_indices;
       delete[] m_blockPtr;
       delete[] m_values;
     }

Code

◆ BlockSparseMatrix() [4/4]

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 391 of file BlockSparseMatrix.h.

                                                       : m_blockSize(BlockSize)
     {
       EIGEN_STATIC_ASSERT((m_blockSize != Dynamic), THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE);
  
       *this = spmat;
     }

Code

Member Function Documentation

◆ blockCols()

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 772 of file BlockSparseMatrix.h.

     {
       return (IsColMajor ? m_outerBSize : m_innerBSize);
     }

Code

◆ blockColsIndex()

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 886 of file BlockSparseMatrix.h.

     {
       return IsColMajor ? blockOuterIndex(bj) : blockInnerIndex(bj);
     }

Code

◆ blockInnerIndex()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::blockInnerIndex ( Index bi ) const

inline

Definition at line 895 of file BlockSparseMatrix.h.

     {
       return (m_blockSize == Dynamic) ? m_innerOffset[bi] : (bi * m_blockSize);
     }

Code

◆ blockInnerSize()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::blockInnerSize ( Index bi ) const

inline

Definition at line 901 of file BlockSparseMatrix.h.

     {
       return (m_blockSize == Dynamic) ? (m_innerOffset[bi+1] - m_innerOffset[bi]) : m_blockSize;
     }

Code

◆ blockOuterIndex()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::blockOuterIndex ( Index bj ) const

inline

Definition at line 891 of file BlockSparseMatrix.h.

     {
       return (m_blockSize == Dynamic) ? m_outerOffset[bj] : (bj * m_blockSize);
     }

Code

◆ blockOuterSize()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::blockOuterSize ( Index bj ) const

inline

Definition at line 905 of file BlockSparseMatrix.h.

     {
       return (m_blockSize == Dynamic) ? (m_outerOffset[bj+1]- m_outerOffset[bj]) : m_blockSize;
     }

Code

◆ blockPtr()

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 938 of file BlockSparseMatrix.h.

     {
       if(m_blockSize == Dynamic) return m_blockPtr[id];
       else return id * m_blockSize * m_blockSize;
       //return blockDynIdx(id, std::conditional_t<(BlockSize==Dynamic), internal::true_type, internal::false_type>());
     }

Code

◆ blockRows()

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 767 of file BlockSparseMatrix.h.

     {
       return (IsColMajor ? m_innerBSize : m_outerBSize);
     }

Code

◆ blockRowsIndex()

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 878 of file BlockSparseMatrix.h.

     {
       return IsColMajor ? blockInnerIndex(bi) : blockOuterIndex(bi);
     }

Code

◆ coeff()

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 834 of file BlockSparseMatrix.h.

     {
       eigen_assert(brow < blockRows() && "BLOCK ROW INDEX OUT OF BOUNDS");
       eigen_assert(bcol < blockCols() && "BLOCK COLUMN OUT OF BOUNDS");
  
       StorageIndex rsize = IsColMajor ? blockInnerSize(brow): blockOuterSize(bcol);
       StorageIndex csize = IsColMajor ? blockOuterSize(bcol) : blockInnerSize(brow);
       StorageIndex inner = IsColMajor ? brow : bcol;
       StorageIndex outer = IsColMajor ? bcol : brow;
       StorageIndex offset = m_outerIndex[outer];
       while(offset < m_outerIndex[outer+1] && m_indices[offset] != inner) offset++;
       if(m_indices[offset] == inner)
       {
         return Map<const BlockScalar> (&(m_values[blockPtr(offset)]), rsize, csize);
       }
       else
 //        return BlockScalar::Zero(rsize, csize);
         eigen_assert("NOT YET SUPPORTED");
     }

Code

◆ coeffRef()

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 808 of file BlockSparseMatrix.h.

     {
       eigen_assert(brow < blockRows() && "BLOCK ROW INDEX OUT OF BOUNDS");
       eigen_assert(bcol < blockCols() && "BLOCK nzblocksFlagCOLUMN OUT OF BOUNDS");
  
       StorageIndex rsize = IsColMajor ? blockInnerSize(brow): blockOuterSize(bcol);
       StorageIndex csize = IsColMajor ? blockOuterSize(bcol) : blockInnerSize(brow);
       StorageIndex inner = IsColMajor ? brow : bcol;
       StorageIndex outer = IsColMajor ? bcol : brow;
       StorageIndex offset = m_outerIndex[outer];
       while(offset < m_outerIndex[outer+1] && m_indices[offset] != inner)
         offset++;
       if(m_indices[offset] == inner)
       {
         return Map<BlockScalar>(&(m_values[blockPtr(offset)]), rsize, csize);
       }
       else
       {
         //FIXME the block does not exist, Insert it !!!!!!!!!
         eigen_assert("DYNAMIC INSERTION IS NOT YET SUPPORTED");
       }
     }

Code

◆ cols()

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 749 of file BlockSparseMatrix.h.

     {
 //      return blockCols();
       return (IsColMajor ? outerSize() : innerSize());
     }

Code

◆ innerBlocks()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::innerBlocks ( ) const

inline

Definition at line 778 of file BlockSparseMatrix.h.

778 { return m_innerBSize; }

Code

◆ innerIndexPtr() [1/2]

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::innerIndexPtr ( )

inline

Definition at line 868 of file BlockSparseMatrix.h.

868 {return m_indices; }

Code

◆ innerIndexPtr() [2/2]

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

const StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::innerIndexPtr ( ) const

inline

Definition at line 869 of file BlockSparseMatrix.h.

869 {return m_indices; }

Code

◆ innerSize()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::innerSize ( ) const

inline

Definition at line 755 of file BlockSparseMatrix.h.

     {
       if(m_blockSize == Dynamic) return m_innerOffset[m_innerBSize];
       else return  (m_innerBSize * m_blockSize) ;
     }

Code

◆ innerToBlock()

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 793 of file BlockSparseMatrix.h.

     {
       eigen_assert(inner < innerSize() && "OUTER INDEX OUT OF BOUNDS");
  
       if(m_blockSize != Dynamic)
         return (inner / m_blockSize); // Integer division
  
       StorageIndex b_inner = 0;
       while(m_innerOffset[b_inner] <= inner) ++b_inner;
       return b_inner - 1;
     }

Code

◆ insert()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Map<BlockScalar> Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::insert	(	Index	brow,
		Index	bcol
	)

protected

◆ isCompressed()

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 874 of file BlockSparseMatrix.h.

874 {return true;}

Code

◆ nonZeros()

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 864 of file BlockSparseMatrix.h.

864 { return m_nonzeros; }

Code

◆ nonZerosBlocks()

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 862 of file BlockSparseMatrix.h.

862 { return m_nonzerosblocks; }

Code

◆ operator*()

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 856 of file BlockSparseMatrix.h.

     {
       return BlockSparseTimeDenseProduct<BlockSparseMatrix, VecType>(*this, lhs);
     }

Code

◆ operator=() [1/2]

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 367 of file BlockSparseMatrix.h.

     {
       //Copy-and-swap paradigm ... avoid leaked data if thrown
       swap(*this, other);
       return *this;
     }

Code

◆ operator=() [2/2]

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 407 of file BlockSparseMatrix.h.

     {
       eigen_assert((m_innerBSize != 0 && m_outerBSize != 0)
                    && "Trying to assign to a zero-size matrix, call resize() first");
       eigen_assert(((MatrixType::Options&RowMajorBit) != IsColMajor) && "Wrong storage order");
       typedef SparseMatrix<bool,MatrixType::Options,typename MatrixType::Index> MatrixPatternType;
       MatrixPatternType  blockPattern(blockRows(), blockCols());
       m_nonzeros = 0;
  
       // First, compute the number of nonzero blocks and their locations
       for(StorageIndex bj = 0; bj < m_outerBSize; ++bj)
       {
         // Browse each outer block and compute the structure
         std::vector<bool> nzblocksFlag(m_innerBSize,false);  // Record the existing blocks
         blockPattern.startVec(bj);
         for(StorageIndex j = blockOuterIndex(bj); j < blockOuterIndex(bj+1); ++j)
         {
           typename MatrixType::InnerIterator it_spmat(spmat, j);
           for(; it_spmat; ++it_spmat)
           {
             StorageIndex bi = innerToBlock(it_spmat.index()); // Index of the current nonzero block
             if(!nzblocksFlag[bi])
             {
               // Save the index of this nonzero block
               nzblocksFlag[bi] = true;
               blockPattern.insertBackByOuterInnerUnordered(bj, bi) = true;
               // Compute the total number of nonzeros (including explicit zeros in blocks)
               m_nonzeros += blockOuterSize(bj) * blockInnerSize(bi);
             }
           }
         } // end current outer block
       }
       blockPattern.finalize();
  
       // Allocate the internal arrays
       setBlockStructure(blockPattern);
  
       for(StorageIndex nz = 0; nz < m_nonzeros; ++nz) m_values[nz] = Scalar(0);
       for(StorageIndex bj = 0; bj < m_outerBSize; ++bj)
       {
         // Now copy the values
         for(StorageIndex j = blockOuterIndex(bj); j < blockOuterIndex(bj+1); ++j)
         {
           // Browse the outer block column by column (for column-major matrices)
           typename MatrixType::InnerIterator it_spmat(spmat, j);
           for(; it_spmat; ++it_spmat)
           {
             StorageIndex idx = 0; // Position of this block in the column block
             StorageIndex bi = innerToBlock(it_spmat.index()); // Index of the current nonzero block
             // Go to the inner block where this element belongs to
             while(bi > m_indices[m_outerIndex[bj]+idx]) ++idx; // Not expensive for ordered blocks
             StorageIndex idxVal;// Get the right position in the array of values for this element
             if(m_blockSize == Dynamic)
             {
               // Offset from all blocks before ...
               idxVal =  m_blockPtr[m_outerIndex[bj]+idx];
               // ... and offset inside the block
               idxVal += (j - blockOuterIndex(bj)) * blockOuterSize(bj) + it_spmat.index() - m_innerOffset[bi];
             }
             else
             {
               // All blocks before
               idxVal = (m_outerIndex[bj] + idx) * m_blockSize * m_blockSize;
               // inside the block
               idxVal += (j - blockOuterIndex(bj)) * m_blockSize + (it_spmat.index()%m_blockSize);
             }
             // Insert the value
             m_values[idxVal] = it_spmat.value();
           } // end of this column
         } // end of this block
       } // end of this outer block
  
       return *this;
     }

Code

◆ outerBlocks()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::outerBlocks ( ) const

inline

Definition at line 777 of file BlockSparseMatrix.h.

777 { return m_outerBSize; }

Code

◆ outerIndexPtr() [1/2]

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::outerIndexPtr ( )

inline

Definition at line 870 of file BlockSparseMatrix.h.

870 {return m_outerIndex; }

Code

◆ outerIndexPtr() [2/2]

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

const StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::outerIndexPtr ( ) const

inline

Definition at line 871 of file BlockSparseMatrix.h.

871 {return m_outerIndex; }

Code

◆ outerSize()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::outerSize ( ) const

inline

Definition at line 761 of file BlockSparseMatrix.h.

     {
       if(m_blockSize == Dynamic) return m_outerOffset[m_outerBSize];
       else return  (m_outerBSize * m_blockSize) ;
     }

Code

◆ outerToBlock()

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 781 of file BlockSparseMatrix.h.

     {
       eigen_assert(outer < outerSize() && "OUTER INDEX OUT OF BOUNDS");
  
       if(m_blockSize != Dynamic)
         return (outer / m_blockSize); // Integer division
  
       StorageIndex b_outer = 0;
       while(m_outerOffset[b_outer] <= outer) ++b_outer;
       return b_outer - 1;
     }

Code

◆ reserve()

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 598 of file BlockSparseMatrix.h.

     {
       eigen_assert((m_innerBSize != 0 && m_outerBSize != 0) &&
           "TRYING TO RESERVE ZERO-SIZE MATRICES, CALL resize() first");
  
       //FIXME Should free if already allocated
       m_outerIndex = new StorageIndex[m_outerBSize+1];
  
       m_nonzerosblocks = nonzerosblocks;
       if(m_blockSize != Dynamic)
       {
         m_nonzeros = nonzerosblocks * (m_blockSize * m_blockSize);
         m_blockPtr = 0;
       }
       else
       {
         // m_nonzeros  is already computed in setBlockLayout()
         m_blockPtr = new StorageIndex[m_nonzerosblocks+1];
       }
       m_indices = new StorageIndex[m_nonzerosblocks+1];
       m_values = new Scalar[m_nonzeros];
     }

Code

◆ resize()

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 540 of file BlockSparseMatrix.h.

     {
       m_innerBSize = IsColMajor ? brow : bcol;
       m_outerBSize = IsColMajor ? bcol : brow;
     }

Code

◆ rows()

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 740 of file BlockSparseMatrix.h.

     {
 //      return blockRows();
       return (IsColMajor ? innerSize() : outerSize());
     }

Code

◆ setBlockLayout()

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 565 of file BlockSparseMatrix.h.

     {
       const VectorXi& innerBlocks = IsColMajor ? rowBlocks : colBlocks;
       const VectorXi& outerBlocks = IsColMajor ? colBlocks : rowBlocks;
       eigen_assert(m_innerBSize == innerBlocks.size() && "CHECK THE NUMBER OF ROW OR COLUMN BLOCKS");
       eigen_assert(m_outerBSize == outerBlocks.size() && "CHECK THE NUMBER OF ROW OR COLUMN BLOCKS");
       m_outerBSize = outerBlocks.size();
       //  starting index of blocks... cumulative sums
       m_innerOffset = new StorageIndex[m_innerBSize+1];
       m_outerOffset = new StorageIndex[m_outerBSize+1];
       m_innerOffset[0] = 0;
       m_outerOffset[0] = 0;
       std::partial_sum(&innerBlocks[0], &innerBlocks[m_innerBSize-1]+1, &m_innerOffset[1]);
       std::partial_sum(&outerBlocks[0], &outerBlocks[m_outerBSize-1]+1, &m_outerOffset[1]);
  
       // Compute the total number of nonzeros
       m_nonzeros = 0;
       for(StorageIndex bj = 0; bj < m_outerBSize; ++bj)
         for(StorageIndex bi = 0; bi < m_innerBSize; ++bi)
           m_nonzeros += outerBlocks[bj] * innerBlocks[bi];
  
     }

Code

◆ setBlockSize()

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 551 of file BlockSparseMatrix.h.

     {
       m_blockSize = blockSize;
     }

Code

◆ setBlockStructure()

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 500 of file BlockSparseMatrix.h.

     {
       resize(blockPattern.rows(), blockPattern.cols());
       reserve(blockPattern.nonZeros());
  
       // Browse the block pattern and set up the various pointers
       m_outerIndex[0] = 0;
       if(m_blockSize == Dynamic) m_blockPtr[0] = 0;
       for(StorageIndex nz = 0; nz < m_nonzeros; ++nz) m_values[nz] = Scalar(0);
       for(StorageIndex bj = 0; bj < m_outerBSize; ++bj)
       {
         //Browse each outer block
  
         //First, copy and save the indices of nonzero blocks
         //FIXME : find a way to avoid this ...
         std::vector<int> nzBlockIdx;
         typename MatrixType::InnerIterator it(blockPattern, bj);
         for(; it; ++it)
         {
           nzBlockIdx.push_back(it.index());
         }
         std::sort(nzBlockIdx.begin(), nzBlockIdx.end());
  
         // Now, fill block indices and (eventually) pointers to blocks
         for(StorageIndex idx = 0; idx < nzBlockIdx.size(); ++idx)
         {
           StorageIndex offset = m_outerIndex[bj]+idx; // offset in m_indices
           m_indices[offset] = nzBlockIdx[idx];
           if(m_blockSize == Dynamic)
             m_blockPtr[offset] = m_blockPtr[offset-1] + blockInnerSize(nzBlockIdx[idx]) * blockOuterSize(bj);
           // There is no blockPtr for fixed-size blocks... not needed !???
         }
         // Save the pointer to the next outer block
         m_outerIndex[bj+1] = m_outerIndex[bj] + nzBlockIdx.size();
       }
     }

Code

◆ setFromTriplets()

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 633 of file BlockSparseMatrix.h.

     {
       eigen_assert((m_innerBSize!=0 && m_outerBSize !=0) && "ZERO BLOCKS, PLEASE CALL resize() before");
  
       /* First, sort the triplet list
         * FIXME This can be unnecessarily expensive since only the inner indices have to be sorted
         * The best approach is like in SparseMatrix::setFromTriplets()
         */
       internal::TripletComp<InputIterator, IsColMajor> tripletcomp;
       std::sort(begin, end, tripletcomp);
  
       /* Count the number of rows and column blocks,
        * and the number of nonzero blocks per outer dimension
        */
       VectorXi rowBlocks(m_innerBSize); // Size of each block row
       VectorXi colBlocks(m_outerBSize); // Size of each block column
       rowBlocks.setZero(); colBlocks.setZero();
       VectorXi nzblock_outer(m_outerBSize); // Number of nz blocks per outer vector
       VectorXi nz_outer(m_outerBSize); // Number of nz per outer vector...for variable-size blocks
       nzblock_outer.setZero();
       nz_outer.setZero();
       for(InputIterator it(begin); it !=end; ++it)
       {
         eigen_assert(it->row() >= 0 && it->row() < this->blockRows() && it->col() >= 0 && it->col() < this->blockCols());
         eigen_assert((it->value().rows() == it->value().cols() && (it->value().rows() == m_blockSize))
                      || (m_blockSize == Dynamic));
  
         if(m_blockSize == Dynamic)
         {
           eigen_assert((rowBlocks[it->row()] == 0 || rowBlocks[it->row()] == it->value().rows()) &&
               "NON CORRESPONDING SIZES FOR ROW BLOCKS");
           eigen_assert((colBlocks[it->col()] == 0 || colBlocks[it->col()] == it->value().cols()) &&
               "NON CORRESPONDING SIZES FOR COLUMN BLOCKS");
           rowBlocks[it->row()] =it->value().rows();
           colBlocks[it->col()] = it->value().cols();
         }
         nz_outer(IsColMajor ? it->col() : it->row()) += it->value().rows() * it->value().cols();
         nzblock_outer(IsColMajor ? it->col() : it->row())++;
       }
       // Allocate member arrays
       if(m_blockSize == Dynamic) setBlockLayout(rowBlocks, colBlocks);
       StorageIndex nzblocks = nzblock_outer.sum();
       reserve(nzblocks);
  
        // Temporary markers
       VectorXi block_id(m_outerBSize); // To be used as a block marker during insertion
  
       // Setup outer index pointers and markers
       m_outerIndex[0] = 0;
       if (m_blockSize == Dynamic)  m_blockPtr[0] =  0;
       for(StorageIndex bj = 0; bj < m_outerBSize; ++bj)
       {
         m_outerIndex[bj+1] = m_outerIndex[bj] + nzblock_outer(bj);
         block_id(bj) = m_outerIndex[bj];
         if(m_blockSize==Dynamic)
         {
           m_blockPtr[m_outerIndex[bj+1]] = m_blockPtr[m_outerIndex[bj]] + nz_outer(bj);
         }
       }
  
       // Fill the matrix
       for(InputIterator it(begin); it!=end; ++it)
       {
         StorageIndex outer = IsColMajor ? it->col() : it->row();
         StorageIndex inner = IsColMajor ? it->row() : it->col();
         m_indices[block_id(outer)] = inner;
         StorageIndex block_size = it->value().rows()*it->value().cols();
         StorageIndex nz_marker = blockPtr(block_id[outer]);
         memcpy(&(m_values[nz_marker]), it->value().data(), block_size * sizeof(Scalar));
         if(m_blockSize == Dynamic)
         {
           m_blockPtr[block_id(outer)+1] = m_blockPtr[block_id(outer)] + block_size;
         }
         block_id(outer)++;
       }
  
       // An alternative when the outer indices are sorted...no need to use an array of markers
 //      for(Index bcol = 0; bcol < m_outerBSize; ++bcol)
 //      {
 //      Index id = 0, id_nz = 0, id_nzblock = 0;
 //      for(InputIterator it(begin); it!=end; ++it)
 //      {
 //        while (id<bcol) // one pass should do the job unless there are empty columns
 //        {
 //          id++;
 //          m_outerIndex[id+1]=m_outerIndex[id];
 //        }
 //        m_outerIndex[id+1] += 1;
 //        m_indices[id_nzblock]=brow;
 //        Index block_size = it->value().rows()*it->value().cols();
 //        m_blockPtr[id_nzblock+1] = m_blockPtr[id_nzblock] + block_size;
 //        id_nzblock++;
 //        memcpy(&(m_values[id_nz]),it->value().data(), block_size*sizeof(Scalar));
 //        id_nz += block_size;
 //      }
 //      while(id < m_outerBSize-1) // Empty columns at the end
 //      {
 //        id++;
 //        m_outerIndex[id+1]=m_outerIndex[id];
 //      }
 //      }
     }

Code

◆ valuePtr()

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

BlockScalarReturnType* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::valuePtr ( )

inline

Definition at line 866 of file BlockSparseMatrix.h.

866 {return static_cast<BlockScalarReturnType *>(m_values);}

Eigen::BlockSparseMatrix::BlockScalarReturnType

std::conditional_t< _BlockAtCompileTime==Dynamic, Scalar, BlockScalar > BlockScalarReturnType

Definition: BlockSparseMatrix.h:307

Code

Member Data Documentation

◆ m_blockPtr

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_blockPtr

protected

Definition at line 967 of file BlockSparseMatrix.h.

◆ m_blockSize

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_blockSize

protected

Definition at line 970 of file BlockSparseMatrix.h.

◆ m_indices

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_indices

protected

Definition at line 968 of file BlockSparseMatrix.h.

◆ m_innerBSize

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_innerBSize

protected

Definition at line 960 of file BlockSparseMatrix.h.

◆ m_innerOffset

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_innerOffset

protected

Definition at line 962 of file BlockSparseMatrix.h.

◆ m_nonzeros

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_nonzeros

protected

Definition at line 965 of file BlockSparseMatrix.h.

◆ m_nonzerosblocks

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_nonzerosblocks

protected

Definition at line 964 of file BlockSparseMatrix.h.

◆ m_outerBSize

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Index Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_outerBSize

protected

Definition at line 961 of file BlockSparseMatrix.h.

◆ m_outerIndex

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_outerIndex

protected

Definition at line 969 of file BlockSparseMatrix.h.

◆ m_outerOffset

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

StorageIndex* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_outerOffset

protected

Definition at line 963 of file BlockSparseMatrix.h.

◆ m_values

template<typename Scalar_ , int _BlockAtCompileTime, int Options_, typename StorageIndex_ >

Scalar* Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >::m_values

protected

Definition at line 966 of file BlockSparseMatrix.h.

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

BlockSparseMatrix.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename Scalar_, int _BlockAtCompileTime, int Options_, typename StorageIndex_> class Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >

Member Typedef Documentation

◆ BlockRealScalar

◆ BlockScalar

◆ BlockScalarReturnType

◆ Nested

◆ PlainObject

◆ RealScalar

◆ Scalar

◆ StorageIndex

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ BlockSparseMatrix() [1/4]

◆ BlockSparseMatrix() [2/4]

◆ BlockSparseMatrix() [3/4]

◆ ~BlockSparseMatrix()

◆ BlockSparseMatrix() [4/4]

Member Function Documentation

◆ blockCols()

◆ blockColsIndex()

◆ blockInnerIndex()

◆ blockInnerSize()

◆ blockOuterIndex()

◆ blockOuterSize()

◆ blockPtr()

◆ blockRows()

◆ blockRowsIndex()

◆ coeff()

◆ coeffRef()

◆ cols()

◆ innerBlocks()

◆ innerIndexPtr() [1/2]

◆ innerIndexPtr() [2/2]

◆ innerSize()

◆ innerToBlock()

◆ insert()

◆ isCompressed()

◆ nonZeros()

◆ nonZerosBlocks()

◆ operator*()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ outerBlocks()

◆ outerIndexPtr() [1/2]

◆ outerIndexPtr() [2/2]

◆ outerSize()

◆ outerToBlock()

◆ reserve()

◆ resize()

◆ rows()

◆ setBlockLayout()

◆ setBlockSize()

◆ setBlockStructure()

◆ setFromTriplets()

◆ valuePtr()

Member Data Documentation

◆ m_blockPtr

◆ m_blockSize

◆ m_indices

◆ m_innerBSize

◆ m_innerOffset

◆ m_nonzeros

◆ m_nonzerosblocks

◆ m_outerBSize

◆ m_outerIndex

◆ m_outerOffset

◆ m_values

template<typename Scalar_, int _BlockAtCompileTime, int Options_, typename StorageIndex_>
class Eigen::BlockSparseMatrix< Scalar_, _BlockAtCompileTime, Options_, StorageIndex_ >