Public Member Functions | Private Types | Private Attributes | List of all members
Eigen::KroneckerProductSparse< Lhs, Rhs > Class Template Reference

Kronecker tensor product helper class for sparse matrices. More...

#include <KroneckerTensorProduct.h>

Inheritance diagram for Eigen::KroneckerProductSparse< Lhs, Rhs >:
Inheritance graph
[legend]

Public Member Functions

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

Private Types

typedef KroneckerProductBase< KroneckerProductSparseBase
 

Private Attributes

Lhs::Nested m_A
 
Rhs::Nested m_B
 

Additional Inherited Members

- Public Types inherited from Eigen::ReturnByValue< KroneckerProductSparse< Lhs, Rhs > >
typedef internal::dense_xpr_base< ReturnByValue >::type Base
 
typedef internal::traits< KroneckerProductSparse< Lhs, Rhs > >::ReturnType ReturnType
 
- Protected Types inherited from Eigen::KroneckerProductBase< KroneckerProductSparse< Lhs, Rhs > >
typedef Traits::Lhs Lhs
 
typedef Traits::Rhs Rhs
 
- Protected Attributes inherited from Eigen::KroneckerProductBase< KroneckerProductSparse< Lhs, Rhs > >
Lhs::Nested m_A
 
Rhs::Nested m_B
 

Detailed Description

template<typename Lhs, typename Rhs>
class Eigen::KroneckerProductSparse< Lhs, Rhs >

Kronecker tensor product helper class for sparse matrices.

If at least one of the operands is a sparse matrix expression, then this class is returned and evaluates into a sparse matrix.

This class is the return value of kroneckerProduct(EigenBase, EigenBase). Use the function rather than construct this class directly to avoid specifying template prarameters.

Template Parameters
LhsType of the left-hand side, a matrix expression.
RhsType of the rignt-hand side, a matrix expression.

Definition at line 115 of file KroneckerTensorProduct.h.

Member Typedef Documentation

◆ Base

template<typename Lhs , typename Rhs >
typedef KroneckerProductBase<KroneckerProductSparse> Eigen::KroneckerProductSparse< Lhs, Rhs >::Base
private

Definition at line 118 of file KroneckerTensorProduct.h.

Constructor & Destructor Documentation

◆ KroneckerProductSparse()

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

Constructor.

Definition at line 124 of file KroneckerTensorProduct.h.

Member Function Documentation

◆ evalTo()

template<typename Lhs , typename Rhs >
template<typename Dest >
void Eigen::KroneckerProductSparse< Lhs, Rhs >::evalTo ( Dest &  dst) const

Evaluate the Kronecker tensor product.

Definition at line 147 of file KroneckerTensorProduct.h.

Member Data Documentation

◆ m_A

template<typename Lhs , typename Rhs >
Lhs::Nested Eigen::KroneckerProductBase< Derived >::m_A
private

Definition at line 65 of file KroneckerTensorProduct.h.

◆ m_B

template<typename Lhs , typename Rhs >
Rhs::Nested Eigen::KroneckerProductBase< Derived >::m_B
private

Definition at line 66 of file KroneckerTensorProduct.h.


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


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:10:57