diff options
author | Gael Guennebaud <g.gael@free.fr> | 2016-05-20 14:18:48 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2016-05-20 14:18:48 +0200 |
commit | c028d9608914f3ef56cea19cba9797a02f8e4dd8 (patch) | |
tree | 80bf7daa545c6e13b35556c5713d4bc2adf5c71a /Eigen/src/plugins/ArrayCwiseBinaryOps.h | |
parent | 0ba32f99bdccc2a2c3c8169fd5ccd2091a0d88d4 (diff) |
Improve doc of special math functions
Diffstat (limited to 'Eigen/src/plugins/ArrayCwiseBinaryOps.h')
-rw-r--r-- | Eigen/src/plugins/ArrayCwiseBinaryOps.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Eigen/src/plugins/ArrayCwiseBinaryOps.h b/Eigen/src/plugins/ArrayCwiseBinaryOps.h index 99f4048d7..c3f8c2575 100644 --- a/Eigen/src/plugins/ArrayCwiseBinaryOps.h +++ b/Eigen/src/plugins/ArrayCwiseBinaryOps.h @@ -317,13 +317,18 @@ polygamma(const EIGEN_CURRENT_STORAGE_BASE_CLASS<DerivedN> &n) const } #endif -/** \cpp11 \returns an expression of the coefficient-wise zeta function. +/** \returns an expression of the coefficient-wise zeta function. * * It returns the Riemann zeta function of two arguments \c *this and \a q: * * \param *this is the exposent, it must be > 1 * \param q is the shift, it must be > 0 * + * \note This function supports only float and double scalar types. To support other scalar types, the user has + * to provide implementations of zeta(T,T) for any scalar type T to be supported. + * + * This method is an alias for zeta(*this,q); + * * \sa Eigen::zeta() */ template<typename DerivedQ> |