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 >:

List of all members.

Public Member Functions
Index	cols () const
template<typename Dest >
void	evalTo (Dest &dst) const
	Evaluate the Kronecker tensor product.
	KroneckerProductSparse (const Lhs &A, const Rhs &B)
	Constructor.
template<typename Scalar , int Options, typename Index >
	operator SparseMatrix< Scalar, Options, Index > ()
Index	rows () const
Private Types
typedef internal::traits < KroneckerProductSparse > ::Index	Index
Private Attributes
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:

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

Definition at line 80 of file KroneckerTensorProduct.h.

---

Member Typedef Documentation

template<typename Lhs , typename Rhs >

typedef internal::traits<KroneckerProductSparse>::Index Eigen::KroneckerProductSparse< Lhs, Rhs >::Index [private]

Reimplemented from Eigen::EigenBase< KroneckerProductSparse< Lhs, Rhs > >.

Definition at line 83 of file KroneckerTensorProduct.h.

---

Constructor & Destructor Documentation

template<typename Lhs , typename Rhs >

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

Constructor.

Definition at line 87 of file KroneckerTensorProduct.h.

---

Member Function Documentation

template<typename Lhs , typename Rhs >

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

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from Eigen::EigenBase< KroneckerProductSparse< Lhs, Rhs > >.

Definition at line 95 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

template<typename Dest >

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

(

Dest &

dst

)

const

Evaluate the Kronecker tensor product.

Reimplemented from Eigen::EigenBase< KroneckerProductSparse< Lhs, Rhs > >.

Definition at line 125 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

template<typename Scalar , int Options, typename Index >

Eigen::KroneckerProductSparse< Lhs, Rhs >::operator SparseMatrix< Scalar, Options, Index >

(

)

[inline]

Definition at line 98 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

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

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< KroneckerProductSparse< Lhs, Rhs > >.

Definition at line 94 of file KroneckerTensorProduct.h.

---

Member Data Documentation

template<typename Lhs , typename Rhs >

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

Definition at line 106 of file KroneckerTensorProduct.h.

template<typename Lhs , typename Rhs >

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

Definition at line 107 of file KroneckerTensorProduct.h.

---

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

• KroneckerTensorProduct.h