GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-06-04 18:54:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doc issues regarding ndtri

Browse Source
This commit is contained in:
Gael Guennebaud 2019-09-04 23:00:21 +02:00
parent 5702a57926
commit e6c183f8fd
2 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -608,16 +608,18 @@ erfc() const
return ErfcReturnType(derived()); 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. * function of *this.
* *
* \specialfunctions_module * \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, * \note This function supports only float and double scalar types. 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 * the user has to provide implementations of ndtri(T) for any scalar type T to be supported.
* 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 EIGEN_DEVICE_FUNC
inline const NdtriReturnType inline const NdtriReturnType

12
doc/CoeffwiseMathFunctionsTable.dox
View File

@ -553,6 +553,18 @@ This also means that, unless specified, if the function \c std::foo is available
</td> </td>
<td></td> <td></td>
</tr> </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> <tr><td colspan="4"></td></tr>
</table> </table>