Public Member Functions | Protected Types | Protected Attributes | Private Types | List of all members
Eigen::KroneckerProductBase< Derived > Class Template Reference

The base class of dense and sparse Kronecker product. More...

#include <KroneckerTensorProduct.h>

Inheritance diagram for Eigen::KroneckerProductBase< Derived >:
Inheritance graph
[legend]

Public Member Functions

Scalar coeff (Index row, Index col) const
 
Scalar coeff (Index i) const
 
Index cols () const
 
 KroneckerProductBase (const Lhs &A, const Rhs &B)
 Constructor. More...
 
Index rows () const
 
- Public Member Functions inherited from Eigen::ReturnByValue< Derived >
const Unusablecoeff (Index) const
 
const Unusablecoeff (Index, Index) const
 
UnusablecoeffRef (Index)
 
UnusablecoeffRef (Index, Index)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 

Protected Types

typedef Traits::Lhs Lhs
 
typedef Traits::Rhs Rhs
 

Protected Attributes

Lhs::Nested m_A
 
Rhs::Nested m_B
 

Private Types

typedef Traits::Scalar Scalar
 
typedef internal::traits< Derived > Traits
 

Additional Inherited Members

- Public Types inherited from Eigen::ReturnByValue< Derived >
typedef internal::dense_xpr_base< ReturnByValue >::type Base
 
typedef internal::traits< Derived >::ReturnType ReturnType
 

Detailed Description

template<typename Derived>
class Eigen::KroneckerProductBase< Derived >

The base class of dense and sparse Kronecker product.

Template Parameters
Derivedis the derived type.

Definition at line 25 of file KroneckerTensorProduct.h.

Member Typedef Documentation

◆ Lhs

template<typename Derived>
typedef Traits::Lhs Eigen::KroneckerProductBase< Derived >::Lhs
protected

Definition at line 32 of file KroneckerTensorProduct.h.

◆ Rhs

template<typename Derived>
typedef Traits::Rhs Eigen::KroneckerProductBase< Derived >::Rhs
protected

Definition at line 33 of file KroneckerTensorProduct.h.

◆ Scalar

template<typename Derived>
typedef Traits::Scalar Eigen::KroneckerProductBase< Derived >::Scalar
private

Definition at line 29 of file KroneckerTensorProduct.h.

◆ Traits

template<typename Derived>
typedef internal::traits<Derived> Eigen::KroneckerProductBase< Derived >::Traits
private

Definition at line 28 of file KroneckerTensorProduct.h.

Constructor & Destructor Documentation

◆ KroneckerProductBase()

template<typename Derived>
Eigen::KroneckerProductBase< Derived >::KroneckerProductBase ( const Lhs A,
const Rhs B 
)
inline

Constructor.

Definition at line 37 of file KroneckerTensorProduct.h.

Member Function Documentation

◆ coeff() [1/2]

template<typename Derived>
Scalar Eigen::KroneckerProductBase< Derived >::coeff ( Index  row,
Index  col 
) const
inline

This overrides ReturnByValue::coeff because this function is efficient enough.

Definition at line 48 of file KroneckerTensorProduct.h.

◆ coeff() [2/2]

template<typename Derived>
Scalar Eigen::KroneckerProductBase< Derived >::coeff ( Index  i) const
inline

This overrides ReturnByValue::coeff because this function is efficient enough.

Definition at line 58 of file KroneckerTensorProduct.h.

◆ cols()

template<typename Derived>
Index Eigen::KroneckerProductBase< Derived >::cols ( void  ) const
inline

Definition at line 42 of file KroneckerTensorProduct.h.

◆ rows()

template<typename Derived>
Index Eigen::KroneckerProductBase< Derived >::rows ( void  ) const
inline

Definition at line 41 of file KroneckerTensorProduct.h.

Member Data Documentation

◆ m_A

template<typename Derived>
Lhs::Nested Eigen::KroneckerProductBase< Derived >::m_A
protected

Definition at line 65 of file KroneckerTensorProduct.h.

◆ m_B

template<typename Derived>
Rhs::Nested Eigen::KroneckerProductBase< Derived >::m_B
protected

Definition at line 66 of file KroneckerTensorProduct.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:51