Lightweight interface adaptor that binds a RooAbsReal object to a subset of its servers and present it as a simple array oriented interface.

Definition at line 29 of file RooRealBinding.h.

Public Member Functions
	RooRealBinding (const RooAbsReal &func, const RooArgSet &vars, const RooArgSet nset=0, Bool_t clipInvalid=kFALSE, const TNamed rangeName=0)
	Construct a lightweight function binding of RooAbsReal func to variables 'vars'.

	RooRealBinding (const RooRealBinding &other, const RooArgSet *nset=0)
	Construct a lightweight function binding of RooAbsReal func to variables 'vars'.

virtual	~RooRealBinding ()
	Destructor.

virtual std::list< Double_t > *	binBoundaries (Int_t) const

virtual Double_t	getMaxLimit (UInt_t dimension) const
	Return upper limit on i-th variable.

virtual Double_t	getMinLimit (UInt_t dimension) const
	Return lower limit on i-th variable.

virtual const char *	getName () const
	Return name of function.

virtual RooSpan< const double >	getValues (std::vector< RooSpan< const double > > coordinates) const
	Evaluate the bound object at all locations indicated by the data in `coordinates`.

RooSpan< const double >	getValuesOfBoundFunction (RooBatchCompute::RunContext &evalData) const
	Evaluate the bound object at all locations indicated by the data in `evalData`.

RooAbsRealLValue *	observable (unsigned int i) const
	Return a pointer to the observable that defines the `i`-th dimension of the function.

virtual Double_t	operator() (const Double_t xvector[]) const
	Evaluate the bound RooAbsReal at the variable values provided in xvector.

virtual std::list< Double_t > *	plotSamplingHint (RooAbsRealLValue &, Double_t, Double_t) const
	Interface for returning an optional hint for initial sampling points when constructing a curve projected on observable.

virtual void	restoreXVec () const
	Restore value of all variables to previously saved values by saveXVec()

virtual void	saveXVec () const
	Save value of all variables.

Public Member Functions inherited from RooAbsFunc
	RooAbsFunc (const RooAbsFunc &other)

	RooAbsFunc (UInt_t dimension)

virtual	~RooAbsFunc ()

UInt_t	getDimension () const

Bool_t	isValid () const

Int_t	numCall () const

void	resetNumCall () const

Protected Member Functions
void	loadValues (const Double_t xvector[]) const
	Load the vector of variable values into the RooRealVars associated as variables with the bound RooAbsReal function.

Protected Attributes
Bool_t	_clipInvalid

std::vector< RooAbsReal * >	_compList

std::vector< Double_t >	_compSave

std::unique_ptr< RooBatchCompute::RunContext >	_evalData

const RooAbsReal *	_func

Double_t	_funcSave

const RooArgSet *	_nset

const TNamed *	_rangeName

std::vector< RooAbsRealLValue * >	_vars

Double_t *	_xsave

Bool_t	_xvecValid

Protected Attributes inherited from RooAbsFunc
UInt_t	_dimension

Int_t	_ncall

Bool_t	_valid

#include <RooRealBinding.h>

Inheritance diagram for RooRealBinding:

[legend]

Constructor & Destructor Documentation

◆ RooRealBinding() [1/2]

RooRealBinding::RooRealBinding	(	const RooAbsReal &	func,
		const RooArgSet &	vars,
		const RooArgSet *	nset = `0`,
		Bool_t	clipInvalid = `kFALSE`,
		const TNamed *	rangeName = `0`
	)

Construct a lightweight function binding of RooAbsReal func to variables 'vars'.

Use the provided nset as normalization set to be passed to RooAbsReal::getVal() If rangeName is not null, use the range of with that name as range associated with the variables of this function binding. If clipInvalid is true, values requested to the function binding that are outside the defined range of the variables are clipped to fit in the defined range.

Definition at line 55 of file RooRealBinding.cxx.

◆ RooRealBinding() [2/2]

RooRealBinding::RooRealBinding	(	const RooRealBinding &	other,
		const RooArgSet *	nset = `0`
	)

Construct a lightweight function binding of RooAbsReal func to variables 'vars'.

Use the provided nset as normalization set to be passed to RooAbsReal::getVal() If rangeName is not null, use the range of with that name as range associated with the variables of this function binding. If clipInvalid is true, values requested to the function binding that are outside the defined range of the variables are clipped to fit in the defined range.

Definition at line 87 of file RooRealBinding.cxx.

◆ ~RooRealBinding()

RooRealBinding::~RooRealBinding ( )

virtual

Destructor.

Definition at line 98 of file RooRealBinding.cxx.

Member Function Documentation

◆ binBoundaries()

std::list< Double_t > * RooRealBinding::binBoundaries ( Int_t index ) const

virtual

Reimplemented from RooAbsFunc.

Definition at line 313 of file RooRealBinding.cxx.

◆ getMaxLimit()

Double_t RooRealBinding::getMaxLimit ( UInt_t dimension ) const

virtual

Return upper limit on i-th variable.

Implements RooAbsFunc.

Definition at line 287 of file RooRealBinding.cxx.

◆ getMinLimit()

Double_t RooRealBinding::getMinLimit ( UInt_t dimension ) const

virtual

Return lower limit on i-th variable.

Implements RooAbsFunc.

Definition at line 276 of file RooRealBinding.cxx.

◆ getName()

const char * RooRealBinding::getName ( ) const

virtual

Return name of function.

Reimplemented from RooAbsFunc.

Definition at line 297 of file RooRealBinding.cxx.

◆ getValues()

RooSpan< const double > RooRealBinding::getValues ( std::vector< RooSpan< const double > > coordinates ) const

virtual

Evaluate the bound object at all locations indicated by the data in coordinates.

If _clipInvalid is set, the function is set to zero at all points in the arguments that are not within the range of the observables.

Parameters

coordinates Vector of spans that contain the points where the function should be evaluated. The ordinal position in the vector corresponds to the ordinal position in the set of {observables, parameters} that were passed to the constructor. The spans can either have a size of n, in which case a batch of n results is returned, or they can have a size of 1. In the latter case, the value in the span is broadcast to all n events.

Returns: Batch of function values for each coordinate given in the input spans. If a parameter is invalid, i.e., out of its range, an empty span is returned. If an observable is invalid, the function value is 0.

Reimplemented in RooDataProjBinding, and RooRealAnalytic.

Definition at line 209 of file RooRealBinding.cxx.

◆ getValuesOfBoundFunction()

RooSpan< const double > RooRealBinding::getValuesOfBoundFunction ( RooBatchCompute::RunContext & evalData ) const

Evaluate the bound object at all locations indicated by the data in evalData.

See also: RooAbsReal::getValues().

Parameters

[in/out] evalData Struct with spans pointing to the data to be used for evaluation. The spans can either have a size of n, in which case a batch of n results is returned, or they can have a size of 1. In the latter case, the value in the span is broadcast to all n events.

Returns: Batch of function values for each coordinate given in the input spans.

Definition at line 268 of file RooRealBinding.cxx.

◆ loadValues()

void RooRealBinding::loadValues ( const Double_t xvector[] ) const

protected

Load the vector of variable values into the RooRealVars associated as variables with the bound RooAbsReal function.

Warning: This will load as many values as the dimensionality of the function requires. The size of xvector is not checked.

Definition at line 171 of file RooRealBinding.cxx.

◆ observable()

RooAbsRealLValue * RooRealBinding::observable ( unsigned int i ) const

inline

Return a pointer to the observable that defines the i-th dimension of the function.

Definition at line 48 of file RooRealBinding.h.

◆ operator()()

Double_t RooRealBinding::operator() ( const Double_t xvector[] ) const

virtual

Evaluate the bound RooAbsReal at the variable values provided in xvector.

Implements RooAbsFunc.

Reimplemented in RooDataProjBinding, and RooRealAnalytic.

Definition at line 189 of file RooRealBinding.cxx.

◆ plotSamplingHint()

std::list< Double_t > * RooRealBinding::plotSamplingHint	(	RooAbsRealLValue &	,
		Double_t	,
		Double_t
	)		const

virtual

Interface for returning an optional hint for initial sampling points when constructing a curve projected on observable.

Reimplemented from RooAbsFunc.

Definition at line 305 of file RooRealBinding.cxx.

◆ restoreXVec()

void RooRealBinding::restoreXVec ( ) const

virtual

Restore value of all variables to previously saved values by saveXVec()

Reimplemented from RooAbsFunc.

Definition at line 143 of file RooRealBinding.cxx.

◆ saveXVec()

void RooRealBinding::saveXVec ( ) const

virtual

Save value of all variables.

Reimplemented from RooAbsFunc.

Definition at line 108 of file RooRealBinding.cxx.

Member Data Documentation

◆ _clipInvalid

Bool_t RooRealBinding::_clipInvalid

protected

Definition at line 58 of file RooRealBinding.h.

◆ _compList

std::vector<RooAbsReal*> RooRealBinding::_compList

mutableprotected

Definition at line 62 of file RooRealBinding.h.

◆ _compSave

std::vector<Double_t> RooRealBinding::_compSave

mutableprotected

Definition at line 63 of file RooRealBinding.h.

◆ _evalData

std::unique_ptr<RooBatchCompute::RunContext> RooRealBinding::_evalData

mutableprotected

Definition at line 65 of file RooRealBinding.h.

◆ _func

const RooAbsReal* RooRealBinding::_func

protected

Definition at line 54 of file RooRealBinding.h.

◆ _funcSave

Double_t RooRealBinding::_funcSave

mutableprotected

Definition at line 64 of file RooRealBinding.h.

◆ _nset

const RooArgSet* RooRealBinding::_nset

protected

Definition at line 56 of file RooRealBinding.h.

◆ _rangeName

const TNamed* RooRealBinding::_rangeName

protected

Definition at line 60 of file RooRealBinding.h.

◆ _vars

std::vector<RooAbsRealLValue*> RooRealBinding::_vars

protected

Definition at line 55 of file RooRealBinding.h.

◆ _xsave

Double_t* RooRealBinding::_xsave

mutableprotected

Definition at line 59 of file RooRealBinding.h.

◆ _xvecValid

Bool_t RooRealBinding::_xvecValid

mutableprotected

Definition at line 57 of file RooRealBinding.h.

Libraries for RooRealBinding:

[legend]

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

roofit/roofitcore/inc/RooRealBinding.h
roofit/roofitcore/src/RooRealBinding.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ RooRealBinding() [1/2]

◆ RooRealBinding() [2/2]

◆ ~RooRealBinding()

Member Function Documentation

◆ binBoundaries()

◆ getMaxLimit()

◆ getMinLimit()

◆ getName()

◆ getValues()

◆ getValuesOfBoundFunction()

◆ loadValues()

◆ observable()

◆ operator()()

◆ plotSamplingHint()

◆ restoreXVec()

◆ saveXVec()

Member Data Documentation

◆ _clipInvalid

◆ _compList

◆ _compSave

◆ _evalData

◆ _func

◆ _funcSave

◆ _nset

◆ _rangeName

◆ _vars

◆ _xsave

◆ _xvecValid