mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-04-20 08:39:37 +08:00
Mention ptr_fun in docs for .unaryExpr()
This commit is contained in:
parent
265e1ef4ef
commit
657013c974
@ -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
|
||||
|
20
doc/examples/class_CwiseUnaryOp_ptrfun.cpp
Normal file
20
doc/examples/class_CwiseUnaryOp_ptrfun.cpp
Normal file
@ -0,0 +1,20 @@
|
||||
#include <Eigen/Core>
|
||||
#include <iostream>
|
||||
using namespace Eigen;
|
||||
using namespace std;
|
||||
|
||||
// define function to be applied coefficient-wise
|
||||
double ramp(double x)
|
||||
{
|
||||
if (x > 0)
|
||||
return x;
|
||||
else
|
||||
return 0;
|
||||
}
|
||||
|
||||
int main(int, char**)
|
||||
{
|
||||
Matrix4d m1 = Matrix4d::Random();
|
||||
cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(ptr_fun(ramp)) << endl;
|
||||
return 0;
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user