Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Static Private Member Functions | Friends | List of all members
Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse > Class Template Reference

#include <SparseBlock.h>

Inheritance diagram for Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >:
Inheritance graph
[legend]

Public Types

enum  { IsRowMajor = internal::traits<BlockType>::IsRowMajor }
 
typedef internal::remove_all< typename XprType::Nested >::type _MatrixTypeNested
 
- Public Types inherited from Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >
enum  
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > >::type AdjointReturnType
 
typedef EigenBase< Derived > Base
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef internal::add_const< Transpose< const Derived > >::type ConstTransposeReturnType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndexPlainObject
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< Derived >::StorageIndex StorageIndex
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
typedef Transpose< Derived > TransposeReturnType
 
typedef Scalar value_type
 

Public Member Functions

Index blockCols () const
 
 BlockImpl (XprType &xpr, Index i)
 
 BlockImpl (XprType &xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
 
Index blockRows () const
 
const Scalar coeff (Index index) const
 
const Scalar coeff (Index row, Index col) const
 
ScalarcoeffRef (Index index)
 
ScalarcoeffRef (Index row, Index col)
 
Index cols () const
 
XprTypenestedExpression ()
 
const XprTypenestedExpression () const
 
Index rows () const
 
Index startCol () const
 
Index startRow () const
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >
const AdjointReturnType adjoint () const
 
RealScalar blueNorm () const
 
Index cols () const
 
Derived & const_cast_derived () const
 
const EIGEN_STRONG_INLINE CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
const EIGEN_STRONG_INLINE SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
Derived & derived ()
 
const Derived & derived () 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
 
EIGEN_STRONG_INLINE Derived & operator*= (const Scalar &other)
 
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)
 
EIGEN_STRONG_INLINE Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator-= (const DiagonalBase< OtherDerived > &other)
 
Derived & operator-= (const EigenBase< OtherDerived > &other)
 
Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator/= (const Scalar &other)
 
Derived & operator= (const Derived &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
 
SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
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
 

Protected Member Functions

Index nonZeros () const
 
template<typename T >
BlockImploperator= (const T &)
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >
Derived & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 

Protected Attributes

const internal::variable_if_dynamic< Index, ColsAtCompileTimem_blockCols
 
const internal::variable_if_dynamic< Index, RowsAtCompileTimem_blockRows
 
internal::ref_selector< XprType >::non_const_type m_matrix
 
const internal::variable_if_dynamic< Index, XprType::ColsAtCompileTime==1 ? 0 :Dynamicm_startCol
 
const internal::variable_if_dynamic< Index, XprType::RowsAtCompileTime==1 ? 0 :Dynamicm_startRow
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >
bool m_isRValue
 

Private Types

typedef SparseMatrixBase< BlockTypeBase
 
typedef Block< XprType, BlockRows, BlockCols, InnerPanel > BlockType
 

Static Private Member Functions

static StorageIndex convert_index (const Index idx)
 

Friends

struct internal::unary_evaluator< Block< XprType, BlockRows, BlockCols, InnerPanel >, internal::IteratorBased, Scalar >
 

Additional Inherited Members

- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >
static StorageIndex convert_index (const Index idx)
 

Detailed Description

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
class Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >

Generic implementation of sparse Block expression. Real-only.

Definition at line 333 of file SparseBlock.h.

Member Typedef Documentation

◆ _MatrixTypeNested

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
typedef internal::remove_all<typename XprType::Nested>::type Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::_MatrixTypeNested

Definition at line 343 of file SparseBlock.h.

◆ Base

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
typedef SparseMatrixBase<BlockType> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::Base
private

Definition at line 337 of file SparseBlock.h.

◆ BlockType

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
typedef Block<XprType, BlockRows, BlockCols, InnerPanel> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::BlockType
private

Definition at line 336 of file SparseBlock.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
anonymous enum
Enumerator
IsRowMajor 

Definition at line 340 of file SparseBlock.h.

Constructor & Destructor Documentation

◆ BlockImpl() [1/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::BlockImpl ( XprType xpr,
Index  i 
)
inline

Column or Row constructor

Definition at line 347 of file SparseBlock.h.

◆ BlockImpl() [2/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::BlockImpl ( XprType xpr,
Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline

Dynamic-size constructor

Definition at line 357 of file SparseBlock.h.

Member Function Documentation

◆ blockCols()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::blockCols ( ) const
inline

Definition at line 391 of file SparseBlock.h.

◆ blockRows()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::blockRows ( ) const
inline

Definition at line 390 of file SparseBlock.h.

◆ coeff() [1/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const Scalar Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::coeff ( Index  index) const
inline

Definition at line 380 of file SparseBlock.h.

◆ coeff() [2/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const Scalar Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::coeff ( Index  row,
Index  col 
) const
inline

Definition at line 369 of file SparseBlock.h.

◆ coeffRef() [1/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Scalar& Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::coeffRef ( Index  index)
inline

Definition at line 374 of file SparseBlock.h.

◆ coeffRef() [2/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Scalar& Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::coeffRef ( Index  row,
Index  col 
)
inline

Definition at line 364 of file SparseBlock.h.

◆ cols()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::cols ( ) const
inline

Definition at line 362 of file SparseBlock.h.

◆ convert_index()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
static StorageIndex Eigen::SparseMatrixBase::convert_index
inlinestaticprivate

Definition at line 389 of file SparseMatrixBase.h.

◆ nestedExpression() [1/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
XprType& Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::nestedExpression ( )
inline

Definition at line 387 of file SparseBlock.h.

◆ nestedExpression() [2/2]

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const XprType& Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::nestedExpression ( ) const
inline

Definition at line 386 of file SparseBlock.h.

◆ nonZeros()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::nonZeros ( ) const
inlineprotected

Definition at line 397 of file SparseBlock.h.

◆ operator=()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
template<typename T >
BlockImpl& Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::operator= ( const T )
inlineprotected

Definition at line 409 of file SparseBlock.h.

◆ rows()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::rows ( ) const
inline

Definition at line 361 of file SparseBlock.h.

◆ startCol()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::startCol ( ) const
inline

Definition at line 389 of file SparseBlock.h.

◆ startRow()

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
Index Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::startRow ( ) const
inline

Definition at line 388 of file SparseBlock.h.

Friends And Related Function Documentation

◆ internal::unary_evaluator< Block< XprType, BlockRows, BlockCols, InnerPanel >, internal::IteratorBased, Scalar >

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
friend struct internal::unary_evaluator< Block< XprType, BlockRows, BlockCols, InnerPanel >, internal::IteratorBased, Scalar >
friend

Definition at line 395 of file SparseBlock.h.

Member Data Documentation

◆ m_blockCols

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::m_blockCols
protected

Definition at line 403 of file SparseBlock.h.

◆ m_blockRows

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::m_blockRows
protected

Definition at line 402 of file SparseBlock.h.

◆ m_matrix

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
internal::ref_selector<XprType>::non_const_type Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::m_matrix
protected

Definition at line 399 of file SparseBlock.h.

◆ m_startCol

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const internal::variable_if_dynamic<Index, XprType::ColsAtCompileTime == 1 ? 0 : Dynamic> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::m_startCol
protected

Definition at line 401 of file SparseBlock.h.

◆ m_startRow

template<typename XprType , int BlockRows, int BlockCols, bool InnerPanel>
const internal::variable_if_dynamic<Index, XprType::RowsAtCompileTime == 1 ? 0 : Dynamic> Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >::m_startRow
protected

Definition at line 400 of file SparseBlock.h.


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


gtsam
Author(s):
autogenerated on Wed May 15 2024 15:27:56