diff options
| author |  Chen-Pang He <jdh8@ms63.hinet.net> | 2013-07-21 00:19:46 +0800 |
|---|---|---|
| committer | Chen-Pang He <jdh8@ms63.hinet.net> | 2013-07-21 00:19:46 +0800 |
| commit | 1191949e8725106035d0f7276857217585a115ef (patch) | |
| tree | d21eb7eb9104862185f7f226e7ec2452ad435206 /unsupported/Eigen/src/KroneckerProduct | |
| parent | 3d94ed9fa0bc06771c39970bcae6705ca2524cad (diff) | |
Improve documentation on Kronecker product module.
Diffstat (limited to 'unsupported/Eigen/src/KroneckerProduct')
| -rw-r--r-- | unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h b/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h index 6ec8eb558..80be9fd7a 100644 --- a/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h +++ b/unsupported/Eigen/src/KroneckerProduct/KroneckerTensorProduct.h @@ -12,8 +12,15 @@ #ifndef KRONECKER_TENSOR_PRODUCT_H #define KRONECKER_TENSOR_PRODUCT_H -namespace Eigen { +namespace Eigen { +/*! + * \ingroup KroneckerProduct_Module + * + * \brief The base class of dense and sparse Kronecker product. + * + * \tparam Derived is the derived type. + */ template<typename Derived> class KroneckerProductBase : public ReturnByValue<Derived> { @@ -27,6 +34,7 @@ class KroneckerProductBase : public ReturnByValue<Derived> typedef typename Traits::Index Index; public: + /*! \brief Constructor. */ KroneckerProductBase(const Lhs& A, const Rhs& B) : m_A(A), m_B(B) {} @@ -34,12 +42,20 @@ class KroneckerProductBase : public ReturnByValue<Derived> inline Index rows() const { return m_A.rows() * m_B.rows(); } inline Index cols() const { return m_A.cols() * m_B.cols(); } + /*! + * This overrides ReturnByValue::coeff because this function is + * efficient enough. + */ Scalar coeff(Index row, Index col) const { return m_A.coeff(row / m_B.rows(), col / m_B.cols()) * m_B.coeff(row % m_B.rows(), col % m_B.cols()); } + /*! + * This overrides ReturnByValue::coeff because this function is + * efficient enough. + */ Scalar coeff(Index i) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived); @@ -52,6 +68,8 @@ class KroneckerProductBase : public ReturnByValue<Derived> }; /*! + * \ingroup KroneckerProduct_Module + * * \brief Kronecker tensor product helper class for dense matrices * * This class is the return value of kroneckerProduct(MatrixBase, @@ -80,6 +98,8 @@ class KroneckerProduct : public KroneckerProductBase<KroneckerProduct<Lhs,Rhs> > }; /*! + * \ingroup KroneckerProduct_Module + * * \brief Kronecker tensor product helper class for sparse matrices * * If at least one of the operands is a sparse matrix expression, |