Eigen::KroneckerProduct< Lhs, Rhs > Class Template Reference

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

#include <KroneckerTensorProduct.h>

Inheritance diagram for Eigen::KroneckerProduct< Lhs, Rhs >:

List of all members.

Public Member Functions
Scalar	coeff (Index row, Index col) const
Scalar	coeff (Index i) const
Index	cols () const
template<typename Dest >
void	evalTo (Dest &dst) const
	Evaluate the Kronecker tensor product.
	KroneckerProduct (const Lhs &A, const Rhs &B)
	Constructor.
Index	rows () const
Private Types
typedef ReturnByValue < KroneckerProduct >	Base
typedef Base::Index	Index
typedef Base::Scalar	Scalar
Private Attributes
Lhs::Nested	m_A
Rhs::Nested	m_B

---

Detailed Description

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

Kronecker tensor product helper class for dense matrices.

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

Template Parameters:

Lhs	Type of the left-hand side, a matrix expression.
Rhs	Type of the rignt-hand side, a matrix expression.

Definition at line 30 of file KroneckerTensorProduct.h.

---

Member Typedef Documentation

template<typename Lhs , typename Rhs >

typedef ReturnByValue<KroneckerProduct> Eigen::KroneckerProduct< Lhs, Rhs >::Base [private]

Reimplemented from Eigen::ReturnByValue< KroneckerProduct< Lhs, Rhs > >.

Definition at line 33 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

typedef Base::Index Eigen::KroneckerProduct< Lhs, Rhs >::Index [private]

Definition at line 35 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

typedef Base::Scalar Eigen::KroneckerProduct< Lhs, Rhs >::Scalar [private]

Definition at line 34 of file KroneckerTensorProduct.h.

---

Constructor & Destructor Documentation

template<typename Lhs , typename Rhs >

Eigen::KroneckerProduct< Lhs, Rhs >::KroneckerProduct	(	const Lhs &	A,
		const Rhs &	B
	)		[inline]

Constructor.

Definition at line 39 of file KroneckerTensorProduct.h.

---

Member Function Documentation

template<typename Lhs , typename Rhs >

Scalar Eigen::KroneckerProduct< Lhs, Rhs >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 49 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

Scalar Eigen::KroneckerProduct< Lhs, Rhs >::coeff

(

Index

i

)

const [inline]

Definition at line 55 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

Index Eigen::KroneckerProduct< Lhs, Rhs >::cols

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< KroneckerProduct< Lhs, Rhs > >.

Definition at line 47 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

template<typename Dest >

void Eigen::KroneckerProduct< Lhs, Rhs >::evalTo

(

Dest &

dst

)

const

Evaluate the Kronecker tensor product.

Reimplemented from Eigen::ReturnByValue< KroneckerProduct< Lhs, Rhs > >.

Definition at line 112 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

Index Eigen::KroneckerProduct< Lhs, Rhs >::rows

(

void

)

const [inline]

Reimplemented from Eigen::ReturnByValue< KroneckerProduct< Lhs, Rhs > >.

Definition at line 46 of file KroneckerTensorProduct.h.

---

Member Data Documentation

template<typename Lhs , typename Rhs >

Lhs::Nested Eigen::KroneckerProduct< Lhs, Rhs >::m_A [private]

Definition at line 62 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

Rhs::Nested Eigen::KroneckerProduct< Lhs, Rhs >::m_B [private]

Definition at line 63 of file KroneckerTensorProduct.h.

---

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

• KroneckerTensorProduct.h