ROOT::Math::Functor Class Reference

Documentation for class Functor class.

It is used to wrap in a very simple and convenient way multi-dimensional function objects. It can wrap all the following types:

• any C++ callable object implementation double operator()( const double * )
• a free C function of type double ()(const double * )
• an std::function of type std::function<double (double const *)>
• a member function with the correct signature like Foo::Eval(const double * ). In this case one pass the object pointer and a pointer to the member function (&Foo::Eval)

The function dimension is required when constructing the functor.

Definition at line 473 of file Functor.h.

Public Types
typedef FunctorImpl< IBaseFunctionMultiDim >	Impl
typedef IBaseFunctionMultiDim::BaseFunc	ImplBase
Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< double >
typedef double	BackendType
typedef IBaseFunctionMultiDimTempl< double >	BaseFunc

Public Member Functions
	Functor ()
	Default constructor. More...
template<typename Func >
	Functor (const Func &f, unsigned int dim)
	construct from a callable object of multi-dimension with the right signature (implementing operator()(const double *x) More...
	Functor (const Functor &rhs)
	Copy constructor for functor based on ROOT::Math::IMultiGenFunction. More...
template<class PtrObj , typename MemFn >
	Functor (const PtrObj &p, MemFn memFn, unsigned int dim)
	construct from a pointer to member function (multi-dim type) More...
	Functor (const std::function< double(double const *)> &f, unsigned int dim)
	specialized constructor from a std::function of multi-dimension with the right signature (double operator()(double const *x) This specialized constructor is introduced in order to use the Functor class in Python passing Python user defined functions More...
virtual	~Functor ()
	Destructor (no operations) More...
ImplBase *	Clone () const
	Clone a function. More...
unsigned int	NDim () const
	Retrieve the dimension of the function. More...
Functor &	operator= (const Functor &rhs)
	Assignment operator. More...
Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< double >
	IBaseFunctionMultiDimTempl ()
virtual	~IBaseFunctionMultiDimTempl ()
	virtual destructor More...
virtual IBaseFunctionMultiDimTempl< double > *	Clone () const=0
	Clone a function. More...
virtual unsigned int	NDim () const=0
	Retrieve the dimension of the function. More...
double	operator() (const double *x) const
	Evaluate the function at a point x[]. More...

Private Member Functions
double	DoEval (const double *x) const
	Implementation of the evaluation function. More...

Private Attributes
std::unique_ptr< Impl >	fImpl

#include <Math/Functor.h>

Inheritance diagram for ROOT::Math::Functor:

Member Typedef Documentation

Impl

typedef FunctorImpl<IBaseFunctionMultiDim> ROOT::Math::Functor::Impl

Definition at line 478 of file Functor.h.

ImplBase

typedef IBaseFunctionMultiDim::BaseFunc ROOT::Math::Functor::ImplBase

Definition at line 479 of file Functor.h.

Constructor & Destructor Documentation

Functor() [1/5]

ROOT::Math::Functor::Functor ( )

inline

Default constructor.

Definition at line 484 of file Functor.h.

Functor() [2/5]

template<class PtrObj , typename MemFn >

ROOT::Math::Functor::Functor ( const PtrObj &  p, MemFn  memFn, unsigned int  dim  )

inline

construct from a pointer to member function (multi-dim type)

Definition at line 491 of file Functor.h.

Functor() [3/5]

template<typename Func >

ROOT::Math::Functor::Functor ( const Func &  f, unsigned int  dim  )

inline

construct from a callable object of multi-dimension with the right signature (implementing operator()(const double *x)

Definition at line 502 of file Functor.h.

Functor() [4/5]

ROOT::Math::Functor::Functor ( const std::function< double(double const *)> &  f, unsigned int  dim  )

inline

specialized constructor from a std::function of multi-dimension with the right signature (double operator()(double const *x) This specialized constructor is introduced in order to use the Functor class in Python passing Python user defined functions

Definition at line 513 of file Functor.h.

~Functor()

virtual ROOT::Math::Functor::~Functor ( )

inlinevirtual

Destructor (no operations)

Definition at line 520 of file Functor.h.

Functor() [5/5]

ROOT::Math::Functor::Functor ( const Functor &  rhs )

inline

Copy constructor for functor based on ROOT::Math::IMultiGenFunction.

Definition at line 525 of file Functor.h.

Member Function Documentation

Clone()

ImplBase * ROOT::Math::Functor::Clone ( ) const

inlinevirtual

Clone a function.

Each derived class must implement their version of the Clone method

Implements ROOT::Math::IBaseFunctionMultiDimTempl< double >.

Definition at line 545 of file Functor.h.

DoEval()

double ROOT::Math::Functor::DoEval ( const double *  x ) const

inlineprivatevirtual

Implementation of the evaluation function.

Must be implemented by derived classes

Implements ROOT::Math::IBaseFunctionMultiDimTempl< double >.

Definition at line 553 of file Functor.h.

NDim()

unsigned int ROOT::Math::Functor::NDim ( ) const

inlinevirtual

Retrieve the dimension of the function.

Implements ROOT::Math::IBaseFunctionMultiDimTempl< double >.

Definition at line 548 of file Functor.h.

operator=()

Functor & ROOT::Math::Functor::operator= ( const Functor &  rhs )

inline

Assignment operator.

Definition at line 537 of file Functor.h.

Member Data Documentation

fImpl

std::unique_ptr<Impl> ROOT::Math::Functor::fImpl

private

Definition at line 558 of file Functor.h.

Libraries for ROOT::Math::Functor:

[legend]