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

Mention ptr_fun in docs for .unaryExpr()

Browse Source
This commit is contained in:
Jitse Niesen
2010-12-27 16:35:25 +00:00
parent 265e1ef4ef
commit 657013c974
2 changed files with 31 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Eigen/src/plugins/CommonCwiseUnaryOps.h
View File

@@ -130,10 +130,18 @@ real() const { return derived(); }
inline const ImagReturnType
imag() const { return derived(); }
/** \returns an expression of a custom coefficient-wise unary operator \a func of *this
/** \brief Apply a unary operator coefficient-wise
* \param[in] func Functor implementing the unary operator
* \tparam CustomUnaryOp Type of \a func
* \returns An expression of a custom coefficient-wise unary operator \a func of *this
*
* The template parameter \a CustomUnaryOp is the type of the functor
* of the custom unary operator.
* The function \c ptr_fun() from the C++ standard library can be used to make functors out of normal functions.
*
* Example:
* \include class_CwiseUnaryOp_ptrfun.cpp
* Output: \verbinclude class_CwiseUnaryOp_ptrfun.out
*
* Genuine functors allow for more possibilities, for instance it may contain a state.
*
* Example:
* \include class_CwiseUnaryOp.cpp