WPILibC++ 2023.4.3
Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > Class Template Reference

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

Inheritance diagram for Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >:
Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > > Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >

Public Types

typedef internal::traits< BandMatrixWrapper >::Scalar Scalar
 
typedef internal::traits< BandMatrixWrapper >::CoefficientsType CoefficientsType
 
typedef internal::traits< BandMatrixWrapper >::StorageIndex StorageIndex
 
- Public Types inherited from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
enum  
 
typedef internal::traits< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::Scalar Scalar
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef DenseMatrixType::StorageIndex StorageIndex
 
typedef internal::traits< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::CoefficientsType CoefficientsType
 
typedef EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > > Base
 
- Public Types inherited from Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::StorageKind StorageKind
 

Public Member Functions

 BandMatrixWrapper (const CoefficientsType &coeffs, Index rows=_Rows, Index cols=_Cols, Index supers=_Supers, Index subs=_Subs)
 
EIGEN_CONSTEXPR Index rows () const
 
EIGEN_CONSTEXPR Index cols () const
 
EIGEN_CONSTEXPR Index supers () const
 
EIGEN_CONSTEXPR Index subs () const
 
const CoefficientsTypecoeffs () const
 
- Public Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
Index supers () const
 
Index subs () const
 
const CoefficientsTypecoeffs () const
 
CoefficientsTypecoeffs ()
 
Block< CoefficientsType, Dynamic, 1 > col (Index i)
 
Block< CoefficientsType, 1, SizeAtCompileTimediagonal ()
 
const Block< const CoefficientsType, 1, SizeAtCompileTimediagonal () const
 
DiagonalIntReturnType< N >::Type diagonal ()
 
const DiagonalIntReturnType< N >::Type diagonal () const
 
Block< CoefficientsType, 1, Dynamic > diagonal (Index i)
 
const Block< const CoefficientsType, 1, Dynamic > diagonal (Index i) const
 
void evalTo (Dest &dst) const
 
DenseMatrixType toDenseMatrix () const
 
EIGEN_DEVICE_FUNC BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & derived ()
 
EIGEN_DEVICE_FUNC const BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & derived () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
- Public Member Functions inherited from Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
EIGEN_DEVICE_FUNC BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & derived ()
 
EIGEN_DEVICE_FUNC const BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & derived () const
 
EIGEN_DEVICE_FUNC BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & 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 Attributes

const CoefficientsTypem_coeffs
 
internal::variable_if_dynamic< Index, _Rows > m_rows
 
internal::variable_if_dynamic< Index, _Supers > m_supers
 
internal::variable_if_dynamic< Index, _Subs > m_subs
 

Additional Inherited Members

- Protected Types inherited from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
enum  
 
- Protected Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >
Index diagonalLength (Index i) const
 

Member Typedef Documentation

◆ CoefficientsType

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
typedef internal::traits<BandMatrixWrapper>::CoefficientsType Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::CoefficientsType

◆ Scalar

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
typedef internal::traits<BandMatrixWrapper>::Scalar Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::Scalar

◆ StorageIndex

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
typedef internal::traits<BandMatrixWrapper>::StorageIndex Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::StorageIndex

Constructor & Destructor Documentation

◆ BandMatrixWrapper()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::BandMatrixWrapper ( const CoefficientsType coeffs,
Index  rows = _Rows,
Index  cols = _Cols,
Index  supers = _Supers,
Index  subs = _Subs 
)
inlineexplicit

Member Function Documentation

◆ coeffs()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
const CoefficientsType & Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::coeffs ( ) const
inline

◆ cols()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::cols ( void  ) const
inline
Returns
the number of rows

◆ rows()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::rows ( void  ) const
inline
Returns
the number of columns

◆ subs()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::subs ( ) const
inline
Returns
the number of sub diagonals

◆ supers()

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::supers ( ) const
inline
Returns
the number of super diagonals

Member Data Documentation

◆ m_coeffs

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
const CoefficientsType& Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_coeffs
protected

◆ m_rows

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
internal::variable_if_dynamic<Index, _Rows> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_rows
protected

◆ m_subs

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
internal::variable_if_dynamic<Index, _Subs> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_subs
protected

◆ m_supers

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
internal::variable_if_dynamic<Index, _Supers> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_supers
protected

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