MathUtils::ScalarLambdaWithDerivative< Lambda > Class Template Reference

Lambda wrapper for scalar functions with value and derivative. Wraps a lambda/callable into a functor with Values() method. More...

#include <MathUtils_FunctorScalar.hxx>

Public Member Functions
	ScalarLambdaWithDerivative (Lambda theLambda)
	Constructor from lambda/callable.
bool	Values (double theX, double &theY, double &theDY) const
	Evaluates function and derivative at theX.
bool	Value (double theX, double &theY) const
	Evaluates only the function value (for algorithms that don't need derivative).

Detailed Description

template<typename Lambda>
class MathUtils::ScalarLambdaWithDerivative< Lambda >

Lambda wrapper for scalar functions with value and derivative. Wraps a lambda/callable into a functor with Values() method.

Usage:

auto aFunc = ScalarLambdaWithDerivative([](double x, double& y, double& dy) {
  y = x * x - 2.0;
  dy = 2.0 * x;
  return true;
});
auto aResult = MathRoot::Newton(aFunc, 1.0);

Template Parameters

Lambda

callable type with signature bool(double, double&, double&)

Constructor & Destructor Documentation

ScalarLambdaWithDerivative()

template<typename Lambda >

MathUtils::ScalarLambdaWithDerivative< Lambda >::ScalarLambdaWithDerivative ( Lambda theLambda )

inlineexplicit

Constructor from lambda/callable.

Parameters

theLambda

callable with signature bool(double theX, double& theY, double& theDY)

Member Function Documentation

Value()

template<typename Lambda >

bool MathUtils::ScalarLambdaWithDerivative< Lambda >::Value ( double theX, double & theY ) const

inline

Evaluates only the function value (for algorithms that don't need derivative).

Parameters

[in]	theX	input value
[out]	theY	function value f(theX)

Returns

true if evaluation succeeded

Values()

template<typename Lambda >

bool MathUtils::ScalarLambdaWithDerivative< Lambda >::Values ( double theX, double & theY, double & theDY ) const

inline

Evaluates function and derivative at theX.

Parameters

[in]	theX	input value
[out]	theY	function value f(theX)
[out]	theDY	derivative value f'(theX)

Returns

true if evaluation succeeded

---

The documentation for this class was generated from the following file:

• MathUtils_FunctorScalar.hxx