diff options
| -rw-r--r-- | Eigen/src/plugins/ArrayCwiseUnaryOps.h | 12 | ||||
| -rw-r--r-- | doc/CoeffwiseMathFunctionsTable.dox | 12 |
2 files changed, 19 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 diff --git a/doc/CoeffwiseMathFunctionsTable.dox b/doc/CoeffwiseMathFunctionsTable.dox index 080e056e1..8186a5272 100644 --- a/doc/CoeffwiseMathFunctionsTable.dox +++ b/doc/CoeffwiseMathFunctionsTable.dox @@ -553,6 +553,18 @@ This also means that, unless specified, if the function \c std::foo is available </td> <td></td> </tr> +<tr> + <td class="code"> + \anchor cwisetable_ndtri + a.\link ArrayBase::ndtri ndtri\endlink(); \n + \link Eigen::ndtri ndtri\endlink(a); + </td> + <td>Inverse of the CDF of the Normal distribution function</td> + <td> + built-in for float and double + </td> + <td></td> +</tr> <tr><td colspan="4"></td></tr> </table> |