aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/plugins/CommonCwiseUnaryOps.h
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 16:35:25 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 16:35:25 +0000
commit657013c9743d9774d2fbb227b16e575b2f1ac2b0 (patch)
treec393a7a1a1f71cdc73b69c0f7e27064a282cb0d3 /Eigen/src/plugins/CommonCwiseUnaryOps.h
parent265e1ef4ef4e44d9b3e69040d84044c19b60370b (diff)
Mention ptr_fun in docs for .unaryExpr()
Diffstat (limited to 'Eigen/src/plugins/CommonCwiseUnaryOps.h')
-rw-r--r--Eigen/src/plugins/CommonCwiseUnaryOps.h14
1 files changed, 11 insertions, 3 deletions
diff --git a/Eigen/src/plugins/CommonCwiseUnaryOps.h b/Eigen/src/plugins/CommonCwiseUnaryOps.h
index f2da51efa..631d6197b 100644
--- a/Eigen/src/plugins/CommonCwiseUnaryOps.h
+++ b/Eigen/src/plugins/CommonCwiseUnaryOps.h
@@ -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