diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2019-09-04 23:00:21 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2019-09-04 23:00:21 +0200 |
| commit | e6c183f8fd0c9c093eb30e08bd08e8e48a80264c (patch) | |
| tree | bf1c2901f46c86dc366ae7a065fa60a80c292a32 /Eigen/src/plugins | |
| parent | 5702a579261b7227089a7e642fa9be0cb0fe1ad5 (diff) | |
Fix doc issues regarding ndtri
Diffstat (limited to 'Eigen/src/plugins')
| -rw-r--r-- | Eigen/src/plugins/ArrayCwiseUnaryOps.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Eigen/src/plugins/ArrayCwiseUnaryOps.h b/Eigen/src/plugins/ArrayCwiseUnaryOps.h index 4aef72d92..06ac7aad0 100644 --- a/Eigen/src/plugins/ArrayCwiseUnaryOps.h +++ b/Eigen/src/plugins/ArrayCwiseUnaryOps.h @@ -608,16 +608,18 @@ erfc() const return ErfcReturnType(derived()); } -/** \cpp11 \returns an expression of the coefficient-wise Complementary error +/** \returns an expression of the coefficient-wise inverse of the CDF of the Normal distribution function * function of *this. * * \specialfunctions_module + * + * In other words, considering `x = ndtri(y)`, it returns the argument, x, for which the area under the + * Gaussian probability density function (integrated from minus infinity to x) is equal to y. * - * \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 ndtri(T) for any scalar - * type T to be supported. + * \note This function supports only float and double scalar types. To support other scalar types, + * the user has to provide implementations of ndtri(T) for any scalar type T to be supported. * - * \sa <a href="group__CoeffwiseMathFunctions.html#cwisetable_ndtri">Math functions</a>, erf() + * \sa <a href="group__CoeffwiseMathFunctions.html#cwisetable_ndtri">Math functions</a> */ EIGEN_DEVICE_FUNC inline const NdtriReturnType |