GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-25 15:53:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add doc for KroneckerProductSparse.

Browse Source
This commit is contained in:
Chen-Pang He 2012-10-15 00:31:09 +08:00
parent c4b83461d9
commit 8284e7134b
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h
View File

@ -122,6 +122,19 @@ class KroneckerProduct : public MatrixBase<KroneckerProduct<Lhs,Rhs> >
typename Rhs::Nested m_B; typename Rhs::Nested m_B;
}; };
/*!
* \brief 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.
*
* \tparam Lhs Type of the left-hand side, a matrix expression.
* \tparam Rhs Type of the rignt-hand side, a matrix expression.
*/
template<typename Lhs, typename Rhs> template<typename Lhs, typename Rhs>
class KroneckerProductSparse : public SparseMatrixBase<KroneckerProductSparse<Lhs,Rhs> > class KroneckerProductSparse : public SparseMatrixBase<KroneckerProductSparse<Lhs,Rhs> >
{ {