devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve doc of special math functions

Browse Source
This commit is contained in:
Gael Guennebaud
2016-05-20 14:18:48 +02:00
parent 0ba32f99bd
commit c028d96089
4 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Eigen/src/plugins/ArrayCwiseBinaryOps.h
View File

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

24
Eigen/src/plugins/ArrayCwiseUnaryOps.h
View File

@@ -311,7 +311,11 @@ cosh() const
* Example: \include Cwise_lgamma.cpp
* Output: \verbinclude Cwise_lgamma.out
*
* \sa cos(), sin(), tan()
* \note This function supports only float and double scalar types in c++11 mode. To support other scalar types,
* or float/double in non c++11 mode, the user has to provide implementations of lgamma(T) for any scalar
* type T to be supported.
*
* \sa digamma()
*/
inline const LgammaReturnType
lgamma() const
@@ -321,7 +325,11 @@ lgamma() const
/** \returns an expression of the coefficient-wise digamma (psi, derivative of lgamma).
*
* \sa cos(), sin(), tan()
* \note This function supports only float and double scalar types. To support other scalar types,
* the user has to provide implementations of digamma(T) for any scalar
* type T to be supported.
*
* \sa Eigen::digamma(), Eigen::polygamma(), lgamma()
*/
inline const DigammaReturnType
digamma() const
@@ -335,7 +343,11 @@ digamma() const
* Example: \include Cwise_erf.cpp
* Output: \verbinclude Cwise_erf.out
*
* \sa cos(), sin(), tan()
* \note This function supports only float and double scalar types in c++11 mode. To support other scalar types,
* or float/double in non c++11 mode, the user has to provide implementations of erf(T) for any scalar
* type T to be supported.
*
* \sa erfc()
*/
inline const ErfReturnType
erf() const
@@ -349,7 +361,11 @@ erf() const
* Example: \include Cwise_erfc.cpp
* Output: \verbinclude Cwise_erfc.out
*
* \sa cos(), sin(), tan()
* \note This function supports only float and double scalar types in c++11 mode. To support other scalar types,
* or float/double in non c++11 mode, the user has to provide implementations of erfc(T) for any scalar
* type T to be supported.
*
* \sa erf()
*/
inline const ErfcReturnType
erfc() const