From e6c183f8fd0c9c093eb30e08bd08e8e48a80264c Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Wed, 4 Sep 2019 23:00:21 +0200 Subject: Fix doc issues regarding ndtri --- Eigen/src/plugins/ArrayCwiseUnaryOps.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'Eigen/src/plugins') 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 Math functions, erf() + * \sa Math functions */ EIGEN_DEVICE_FUNC inline const NdtriReturnType -- cgit v1.2.3