From 8284e7134b59bb8d4307d1207cc4bea5c68d5674 Mon Sep 17 00:00:00 2001 From: Chen-Pang He Date: Mon, 15 Oct 2012 00:31:09 +0800 Subject: [PATCH] Add doc for KroneckerProductSparse. --- .../src/KroneckerProduct/KroneckerTensorProduct.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h b/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h index a7cb5215b..c33d8f0ce 100644 --- a/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h +++ b/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h @@ -122,6 +122,19 @@ class KroneckerProduct : public MatrixBase > 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 class KroneckerProductSparse : public SparseMatrixBase > {