Derivator Class Reference

#include <CepGen/Utils/Derivator.h>

Inheritance diagram for Derivator:

Collaboration diagram for Derivator:

Public Member Functions
	Derivator (const ParametersList &params)
double	derivate (const std::function< double(double)> &func, double x, double h=-1.) const
	Evaluate the derivative of a function at a given value.
virtual double	derivate (const Function1D &func, double x, double h=-1.) const =0
	Evaluate the derivative of a function at a given value.
const std::string &	name () const
	Module unique indexing name.
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
const ParametersList &	parameters () const override
	Module user-defined parameters.
virtual void	setParameters (const ParametersList &params) override
	Set module parameters.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Protected Member Functions
template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.
template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.
std::string	steerName () const
	Retrieve module name from parameters.
std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
const double	h_
const std::string	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Detailed Description

Definition at line 27 of file Derivator.h.

Constructor & Destructor Documentation

Derivator()

Derivator ( const ParametersList &  params )

explicit

Definition at line 29 of file Derivator.h.

Member Function Documentation

derivate() [1/2]

virtual double derivate ( const Function1D &  func, double  x, double  h = -1.  ) const

pure virtual

Parameters

[in]	func	function to derive
[in]	x	coordinate
[in]	h	(optional) step size ; if not provided, will use default algorithm value

Implemented in GSLDerivator, and ROOTDerivator.

derivate() [2/2]

double derivate	(	const std::function< double(double)> &	func,
		double	x,
		double	h = -1.
	)		const

Parameters

[in]	func	function to derive
[in]	x	coordinate
[in]	h	(optional) step size ; if not provided, will use default algorithm value

Definition at line 41 of file Derivator.h.

description()

static ParametersDescription description ( )

static

Definition at line 31 of file Derivator.h.

name()

const std::string & name ( ) const

inherited

Definition at line 42 of file NamedModule.h.

operator!=()

template<typename T >

bool operator!= ( const SteeredObject< T > &  oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

template<typename T >

bool operator== ( const SteeredObject< T > &  oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

template<typename T >

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

steer()

template<typename T >

T steer ( const std::string &  key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

U steerAs ( const std::string &  key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

steerPath()

std::string steerPath ( const std::string &  key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

h_

const double h_

protected

Definition at line 51 of file Derivator.h.

name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.