WPILibC++ 2023.4.3
Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseBlock.h>

Inheritance diagram for Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >:
Eigen::SparseCompressedBase< Block< SparseMatrixType, BlockRows, BlockCols, true > > Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > > Eigen::EigenBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >

Public Types

enum  { IsRowMajor = internal::traits<BlockType>::IsRowMajor }
 
- Public Types inherited from Eigen::SparseCompressedBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
typedef SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > > Base
 
- Public Types inherited from Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
enum  
 
typedef internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::Scalar Scalar
 
typedef Scalar value_type
 The numeric type of the expression' coefficients, e.g. More...
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::StorageKind StorageKind
 
typedef internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::StorageIndex StorageIndex
 The integer type used to store indices within a SparseMatrix. More...
 
typedef internal::add_const_on_value_type_if_arithmetic< typenameinternal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef SparseMatrixBase StorageBaseType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< constDerived > >, Transpose< constDerived > >::type AdjointReturnType
 
typedef Transpose< Block< SparseMatrixType, BlockRows, BlockCols, true > > TransposeReturnType
 
typedef internal::add_const< Transpose< constDerived > >::type ConstTransposeReturnType
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndexPlainObject
 
typedef NumTraits< Scalar >::Real RealScalar
 This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...
 
typedef internal::conditional< _HasDirectAccess, constScalar &, Scalar >::type CoeffReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 type of the equivalent dense matrix More...
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 type of the equivalent square matrix More...
 
typedef EigenBase< Block< SparseMatrixType, BlockRows, BlockCols, true > > Base
 
- Public Types inherited from Eigen::EigenBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::StorageKind StorageKind
 

Public Member Functions

 sparse_matrix_block_impl (SparseMatrixType &xpr, Index i)
 
 sparse_matrix_block_impl (SparseMatrixType &xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
 
template<typename OtherDerived >
BlockTypeoperator= (const SparseMatrixBase< OtherDerived > &other)
 
BlockTypeoperator= (const BlockType &other)
 
const ScalarvaluePtr () const
 
ScalarvaluePtr ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
bool isCompressed () const
 
ScalarcoeffRef (Index row, Index col)
 
const Scalar coeff (Index row, Index col) const
 
const Scalar coeff (Index index) const
 
const ScalarlastCoeff () const
 
EIGEN_STRONG_INLINE Index rows () const
 
EIGEN_STRONG_INLINE Index cols () const
 
const SparseMatrixType & nestedExpression () const
 
SparseMatrixType & nestedExpression ()
 
Index startRow () const
 
Index startCol () const
 
Index blockRows () const
 
Index blockCols () const
 
- Public Member Functions inherited from Eigen::SparseCompressedBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
Index nonZeros () const
 
const ScalarvaluePtr () const
 
ScalarvaluePtr ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
bool isCompressed () const
 
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
 
Map< Array< Scalar, Dynamic, 1 > > coeffs ()
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator= (const EigenBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator= (const ReturnByValue< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator= (const Block< SparseMatrixType, BlockRows, BlockCols, true > &other)
 
const Block< SparseMatrixType, BlockRows, BlockCols, true > & derived () const
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & derived ()
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & const_cast_derived () const
 
Index rows () const
 
Index cols () const
 
Index size () const
 
bool isVector () const
 
Index outerSize () const
 
Index innerSize () const
 
bool isRValue () const
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & markAsRValue ()
 
 SparseMatrixBase ()
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator+= (const DiagonalBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator+= (const EigenBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE Block< SparseMatrixType, BlockRows, BlockCols, true > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator-= (const DiagonalBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator-= (const EigenBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE Block< SparseMatrixType, BlockRows, BlockCols, true > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator*= (const Scalar &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
Block< SparseMatrixType, BlockRows, BlockCols, true > & operator/= (const Scalar &other)
 
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
const Product< Block< SparseMatrixType, BlockRows, BlockCols, true >, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< Block< SparseMatrixType, BlockRows, BlockCols, true >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
const Product< Block< SparseMatrixType, BlockRows, BlockCols, true >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
SparseSymmetricPermutationProduct< Block< SparseMatrixType, BlockRows, BlockCols, true >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
const TriangularView< const Block< SparseMatrixType, BlockRows, BlockCols, true >, Mode > triangularView () const
 
ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
internal::traits< Block< SparseMatrixType, BlockRows, BlockCols, true > >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
RealScalar squaredNorm () const
 
RealScalar norm () const
 
RealScalar blueNorm () const
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 
const AdjointReturnType adjoint () const
 
DenseMatrixType toDense () 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
 
const internal::eval< Block< SparseMatrixType, BlockRows, BlockCols, true > >::type eval () const
 
Scalar sum () const
 
const SparseView< Block< SparseMatrixType, BlockRows, BlockCols, true > > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
- Public Member Functions inherited from Eigen::EigenBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
EIGEN_DEVICE_FUNC Block< SparseMatrixType, BlockRows, BlockCols, true > & derived ()
 
EIGEN_DEVICE_FUNC const Block< SparseMatrixType, BlockRows, BlockCols, true > & derived () const
 
EIGEN_DEVICE_FUNC Block< SparseMatrixType, BlockRows, BlockCols, true > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Block< SparseMatrixType, BlockRows, BlockCols, true > & const_derived () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 

Protected Types

enum  { OuterSize = IsRowMajor ? BlockRows : BlockCols }
 
typedef Base::IndexVector IndexVector
 
- Protected Types inherited from Eigen::SparseCompressedBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
typedef Base::IndexVector IndexVector
 

Protected Attributes

internal::ref_selector< SparseMatrixType >::non_const_type m_matrix
 
Index m_outerStart
 
const internal::variable_if_dynamic< Index, OuterSizem_outerSize
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
bool m_isRValue
 

Additional Inherited Members

- Protected Member Functions inherited from Eigen::SparseCompressedBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
Eigen::Map< IndexVectorinnerNonZeros ()
 
const Eigen::Map< const IndexVectorinnerNonZeros () const
 
 SparseCompressedBase ()
 Default constructor. More...
 
internal::LowerBoundIndex lower_bound (Index row, Index col) const
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
Block< SparseMatrixType, BlockRows, BlockCols, true > & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 
- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >
static StorageIndex convert_index (const Index idx)
 

Member Typedef Documentation

◆ IndexVector

template<typename SparseMatrixType , int BlockRows, int BlockCols>
typedef Base::IndexVector Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::IndexVector
protected

Member Enumeration Documentation

◆ anonymous enum

template<typename SparseMatrixType , int BlockRows, int BlockCols>
anonymous enum
Enumerator
IsRowMajor 

◆ anonymous enum

template<typename SparseMatrixType , int BlockRows, int BlockCols>
anonymous enum
protected
Enumerator
OuterSize 

Constructor & Destructor Documentation

◆ sparse_matrix_block_impl() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::sparse_matrix_block_impl ( SparseMatrixType &  xpr,
Index  i 
)
inline

◆ sparse_matrix_block_impl() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::sparse_matrix_block_impl ( SparseMatrixType &  xpr,
Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline

Member Function Documentation

◆ blockCols()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::blockCols ( ) const
inline

◆ blockRows()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::blockRows ( ) const
inline

◆ coeff() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const Scalar Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::coeff ( Index  index) const
inline

◆ coeff() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const Scalar Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::coeff ( Index  row,
Index  col 
) const
inline

◆ coeffRef()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Scalar & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::coeffRef ( Index  row,
Index  col 
)
inline

◆ cols()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
EIGEN_STRONG_INLINE Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::cols ( ) const
inline

◆ innerIndexPtr() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::innerIndexPtr ( )
inline

◆ innerIndexPtr() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::innerIndexPtr ( ) const
inline

◆ innerNonZeroPtr() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::innerNonZeroPtr ( )
inline

◆ innerNonZeroPtr() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::innerNonZeroPtr ( ) const
inline

◆ isCompressed()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
bool Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::isCompressed ( ) const
inline

◆ lastCoeff()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const Scalar & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::lastCoeff ( ) const
inline

◆ nestedExpression() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
SparseMatrixType & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::nestedExpression ( )
inline

◆ nestedExpression() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const SparseMatrixType & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::nestedExpression ( ) const
inline

◆ operator=() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
BlockType & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::operator= ( const BlockType other)
inline

◆ operator=() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
template<typename OtherDerived >
BlockType & Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::operator= ( const SparseMatrixBase< OtherDerived > &  other)
inline

◆ outerIndexPtr() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::outerIndexPtr ( )
inline

◆ outerIndexPtr() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const StorageIndex * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::outerIndexPtr ( ) const
inline

◆ rows()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
EIGEN_STRONG_INLINE Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::rows ( ) const
inline

◆ startCol()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::startCol ( ) const
inline

◆ startRow()

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::startRow ( ) const
inline

◆ valuePtr() [1/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Scalar * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::valuePtr ( )
inline

◆ valuePtr() [2/2]

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const Scalar * Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::valuePtr ( ) const
inline

Member Data Documentation

◆ m_matrix

template<typename SparseMatrixType , int BlockRows, int BlockCols>
internal::ref_selector<SparseMatrixType>::non_const_type Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::m_matrix
protected

◆ m_outerSize

template<typename SparseMatrixType , int BlockRows, int BlockCols>
const internal::variable_if_dynamic<Index, OuterSize> Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::m_outerSize
protected

◆ m_outerStart

template<typename SparseMatrixType , int BlockRows, int BlockCols>
Index Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >::m_outerStart
protected

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