A class to maintain the context for squashing of RooFit models into code.

Definition at line 42 of file CodeSquashContext.h.

Classes
class	LoopScope
	A class to manage loop scopes using the RAII technique. More...

Public Member Functions
	CodeSquashContext (std::map< RooFit::Detail::DataKey, std::size_t > const &outputSizes, std::vector< double > &xlarr, Experimental::RooFuncWrapper &wrapper)

void	addResult (const char *key, std::string const &value)
	Adds (or overwrites) the string representing the result of a node.

void	addResult (RooAbsArg const *key, std::string const &value)
	A function to save an expression that includes/depends on the result of the input node.

void	addToCodeBody (RooAbsArg const *klass, std::string const &in)
	Adds the input string to the squashed code body.

void	addToCodeBody (std::string const &in, bool isScopeIndep=false)
	A variation of the previous addToCodeBody that takes in a bool value that determines if input is independent.

void	addToGlobalScope (std::string const &str)
	Adds the given string to the string block that will be emitted at the top of the squashed function.

void	addVecObs (const char *key, int idx)
	Since the squashed code represents all observables as a single flattened array, it is important to keep track of the start index for a vector valued observable which can later be expanded to access the correct element.

std::string	assembleCode (std::string const &returnExpr)
	Assemble and return the final code with the return expression and global statements.

std::unique_ptr< LoopScope >	beginLoop (RooAbsArg const *in)
	Create a RAII scope for iterating over vector observables.

std::string	buildArg (RooAbsCollection const &x)
	Function to save a RooListProxy as an array in the squashed code.

std::string	buildArg (std::span< const double > arr)

std::string	buildArg (std::span< const int > arr)

template<typename... Args_t>
std::string	buildCall (std::string const &funcname, Args_t const &...args)
	Build the code to call the function with name `funcname`, passing some arguments.

void	collectFunction (std::string const &name)
	Register a function that is only know to the interpreter to the context.

std::string const &	getResult (RooAbsArg const &arg)
	Gets the result for the given node using the node name.

template<class T >
std::string const &	getResult (RooTemplateProxy< T > const &key)

std::string	getTmpVarName () const
	Get a unique variable name to be used in the generated code.

std::size_t	outputSize (RooFit::Detail::DataKey key) const
	Figure out the output size of a node.

Public Attributes
Experimental::RooFuncWrapper *	_wrapper = nullptr

Private Member Functions
void	addResult (TNamed const *key, std::string const &value)

std::string	buildArg (RooAbsArg const &arg)

template<class T >
std::string	buildArg (RooTemplateProxy< T > const &arg)

std::string	buildArg (std::nullptr_t)

std::string	buildArg (std::string const &x)

template<class T , typename std::enable_if< std::is_floating_point< T >{}, bool >::type = true>
std::string	buildArg (T x)

template<class T , typename std::enable_if< std::is_integral< T >{}, bool >::type = true>
std::string	buildArg (T x)

std::string	buildArgs ()

template<class Arg_t >
std::string	buildArgs (Arg_t const &arg)

template<typename Arg_t , typename... Args_t>
std::string	buildArgs (Arg_t const &arg, Args_t const &...args)

template<class T >
std::string	buildArgSpanImpl (std::span< const T > arr)

void	endLoop (LoopScope const &scope)

bool	isScopeIndependent (RooAbsArg const *in) const

template<class T >
std::string	typeName () const

template<>
std::string	typeName () const

template<>
std::string	typeName () const

Private Attributes
std::string	_code
	Stores the squashed code body.

std::string	_globalScope
	Block of code that is placed before the rest of the function body.

int	_loopLevel = 0
	The current number of for loops the started.

std::unordered_map< const TNamed *, std::string >	_nodeNames
	Map of node names to their result strings.

std::map< RooFit::Detail::DataKey, std::size_t >	_nodeOutputSizes
	Map of node output sizes.

int	_scopePtr = -1
	Keeps track of the position to go back and insert code to.

std::string	_tempScope
	Stores code that eventually gets injected into main code body.

int	_tmpVarIdx = 0
	Index to get unique names for temporary variables.

std::unordered_map< const TNamed *, int >	_vecObsIndices
	A map to keep track of the observable indices if they are non scalar.

std::vector< double > &	_xlArr

std::unordered_map< RooFit::UniqueId< RooAbsCollection >::Value_t, std::string >	listNames
	A map to keep track of list names as assigned by addResult.

#include <RooFit/Detail/CodeSquashContext.h>

Constructor & Destructor Documentation

◆ CodeSquashContext()

RooFit::Detail::CodeSquashContext::CodeSquashContext	(	std::map< RooFit::Detail::DataKey, std::size_t > const &	outputSizes,
		std::vector< double > &	xlarr,
		Experimental::RooFuncWrapper &	wrapper
	)

Definition at line 27 of file CodeSquashContext.cxx.

Member Function Documentation

◆ addResult() [1/3]

void RooFit::Detail::CodeSquashContext::addResult	(	const char *	key,
		std::string const &	value
	)

Adds (or overwrites) the string representing the result of a node.

Parameters

key	The name of the node to add the result for.
value	The new name to assign/overwrite.

Definition at line 36 of file CodeSquashContext.cxx.

◆ addResult() [2/3]

void RooFit::Detail::CodeSquashContext::addResult	(	RooAbsArg const *	in,
		std::string const &	valueToSave
	)

A function to save an expression that includes/depends on the result of the input node.

Parameters

in	The node on which the valueToSave depends on/belongs to.
valueToSave	The actual string value to save as a temporary.

Definition at line 199 of file CodeSquashContext.cxx.

◆ addResult() [3/3]

void RooFit::Detail::CodeSquashContext::addResult	(	TNamed const *	key,
		std::string const &	value
	)

private

Definition at line 43 of file CodeSquashContext.cxx.

◆ addToCodeBody() [1/2]

void RooFit::Detail::CodeSquashContext::addToCodeBody	(	RooAbsArg const *	klass,
		std::string const &	in
	)

Adds the input string to the squashed code body.

If a class implements a translate function that wants to emit something to the squashed code body, it must call this function with the code it wants to emit. In case of loops, automatically determines if code needs to be stored inside or outside loop scope.

Parameters

klass	The class requesting this addition, usually 'this'.
in	String to add to the squashed code.

Definition at line 111 of file CodeSquashContext.cxx.

◆ addToCodeBody() [2/2]

void RooFit::Detail::CodeSquashContext::addToCodeBody	(	std::string const &	in,
		bool	isScopeIndep = `false`
	)

A variation of the previous addToCodeBody that takes in a bool value that determines if input is independent.

This overload exists because there might other ways to determine if a value/collection of values is scope independent.

Parameters

in	String to add to the squashed code.
isScopeIndep	The value determining if the input is scope dependent.

Definition at line 123 of file CodeSquashContext.cxx.

◆ addToGlobalScope()

void RooFit::Detail::CodeSquashContext::addToGlobalScope ( std::string const & str )

Adds the given string to the string block that will be emitted at the top of the squashed function.

Useful for variable declarations.

Parameters

str	The string to add to the global scope.

Definition at line 81 of file CodeSquashContext.cxx.

◆ addVecObs()

void RooFit::Detail::CodeSquashContext::addVecObs	(	const char *	key,
		int	idx
	)

Since the squashed code represents all observables as a single flattened array, it is important to keep track of the start index for a vector valued observable which can later be expanded to access the correct element.

For example, a vector valued variable x with 10 entries will be squashed to obs[start_idx + i].

Parameters

key	The name of the node representing the vector valued observable.
idx	The start index (or relative position of the observable in the set of all observables).

Definition at line 99 of file CodeSquashContext.cxx.

◆ assembleCode()

std::string RooFit::Detail::CodeSquashContext::assembleCode ( std::string const & returnExpr )

Assemble and return the final code with the return expression and global statements.

Parameters

returnExpr The string representation of what the squashed function should return, usually the head node.

Returns: The final body of the function.

Definition at line 89 of file CodeSquashContext.cxx.

◆ beginLoop()

std::unique_ptr< CodeSquashContext::LoopScope > RooFit::Detail::CodeSquashContext::beginLoop ( RooAbsArg const * in )

Create a RAII scope for iterating over vector observables.

You can't use the result of vector observables outside these loop scopes.

Parameters

in	A pointer to the calling class, used to determine the loop dependent variables.

Definition at line 137 of file CodeSquashContext.cxx.

◆ buildArg() [1/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( RooAbsArg const & arg )

inlineprivate

Definition at line 147 of file CodeSquashContext.h.

◆ buildArg() [2/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( RooAbsCollection const & in )

Function to save a RooListProxy as an array in the squashed code.

Parameters

in	The list to convert to array.

Returns: Name of the array that stores the input list in the squashed code.

Definition at line 224 of file CodeSquashContext.cxx.

◆ buildArg() [3/9]

template<class T >

std::string RooFit::Detail::CodeSquashContext::buildArg ( RooTemplateProxy< T > const & arg )

inlineprivate

Definition at line 150 of file CodeSquashContext.h.

◆ buildArg() [4/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( std::nullptr_t )

inlineprivate

Definition at line 145 of file CodeSquashContext.h.

◆ buildArg() [5/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( std::span< const double > arr )

Definition at line 252 of file CodeSquashContext.cxx.

◆ buildArg() [6/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( std::span< const int > arr )

inline

Definition at line 114 of file CodeSquashContext.h.

◆ buildArg() [7/9]

std::string RooFit::Detail::CodeSquashContext::buildArg ( std::string const & x )

inlineprivate

Definition at line 143 of file CodeSquashContext.h.

◆ buildArg() [8/9]

template<class T , typename std::enable_if< std::is_floating_point< T >{}, bool >::type = true>

std::string RooFit::Detail::CodeSquashContext::buildArg ( T x )

inlineprivate

Definition at line 131 of file CodeSquashContext.h.

◆ buildArg() [9/9]

template<class T , typename std::enable_if< std::is_integral< T >{}, bool >::type = true>

std::string RooFit::Detail::CodeSquashContext::buildArg ( T x )

inlineprivate

Definition at line 138 of file CodeSquashContext.h.

◆ buildArgs() [1/3]

std::string RooFit::Detail::CodeSquashContext::buildArgs ( )

inlineprivate

Definition at line 155 of file CodeSquashContext.h.

◆ buildArgs() [2/3]

template<class Arg_t >

std::string RooFit::Detail::CodeSquashContext::buildArgs ( Arg_t const & arg )

inlineprivate

Definition at line 158 of file CodeSquashContext.h.

◆ buildArgs() [3/3]

template<typename Arg_t , typename... Args_t>

std::string RooFit::Detail::CodeSquashContext::buildArgs	(	Arg_t const &	arg,
		Args_t const &...	args
	)

inlineprivate

Definition at line 164 of file CodeSquashContext.h.

◆ buildArgSpanImpl()

template<class T >

std::string RooFit::Detail::CodeSquashContext::buildArgSpanImpl ( std::span< const T > arr )

private

Definition at line 208 of file CodeSquashContext.h.

◆ buildCall()

template<typename... Args_t>

std::string RooFit::Detail::CodeSquashContext::buildCall	(	std::string const &	funcname,
		Args_t const &...	args
	)

inline

Build the code to call the function with name funcname, passing some arguments.

The arguments can either be doubles or some RooFit arguments whose results will be looked up in the context.

Definition at line 82 of file CodeSquashContext.h.

◆ collectFunction()

void RooFit::Detail::CodeSquashContext::collectFunction ( std::string const & name )

Register a function that is only know to the interpreter to the context.

This is useful to dump the standalone C++ code for the computation graph.

Definition at line 270 of file CodeSquashContext.cxx.

◆ endLoop()

void RooFit::Detail::CodeSquashContext::endLoop ( LoopScope const & scope )

private

Definition at line 173 of file CodeSquashContext.cxx.

◆ getResult() [1/2]

std::string const & RooFit::Detail::CodeSquashContext::getResult ( RooAbsArg const & arg )

Gets the result for the given node using the node name.

This node also performs the necessary code generation through recursive calls to 'translate'. A call to this function modifies the already existing code body.

Parameters

key	The node to get the result string for.

Returns: String representing the result of this node.

Definition at line 53 of file CodeSquashContext.cxx.

◆ getResult() [2/2]

template<class T >

std::string const & RooFit::Detail::CodeSquashContext::getResult ( RooTemplateProxy< T > const & key )

inline

Definition at line 53 of file CodeSquashContext.h.

◆ getTmpVarName()

std::string RooFit::Detail::CodeSquashContext::getTmpVarName ( ) const

Get a unique variable name to be used in the generated code.

Definition at line 191 of file CodeSquashContext.cxx.

◆ isScopeIndependent()

bool RooFit::Detail::CodeSquashContext::isScopeIndependent ( RooAbsArg const * in ) const

private

Definition at line 263 of file CodeSquashContext.cxx.

◆ outputSize()

std::size_t RooFit::Detail::CodeSquashContext::outputSize ( RooFit::Detail::DataKey key ) const

inline

Figure out the output size of a node.

It is the size of the vector observable that it depends on, or 1 if it doesn't depend on any or is a reducer node.

Parameters

key	The node to look up the size for.

Definition at line 62 of file CodeSquashContext.h.

◆ typeName() [1/3]

template<class T >

std::string RooFit::Detail::CodeSquashContext::typeName ( ) const

private

◆ typeName() [2/3]

template<>

std::string RooFit::Detail::CodeSquashContext::typeName ( ) const

inlineprivate

Definition at line 197 of file CodeSquashContext.h.

◆ typeName() [3/3]

template<>

std::string RooFit::Detail::CodeSquashContext::typeName ( ) const

inlineprivate

Definition at line 202 of file CodeSquashContext.h.

Member Data Documentation

◆ _code

std::string RooFit::Detail::CodeSquashContext::_code

private

Stores the squashed code body.

Definition at line 181 of file CodeSquashContext.h.

◆ _globalScope

std::string RooFit::Detail::CodeSquashContext::_globalScope

private

Block of code that is placed before the rest of the function body.

Definition at line 175 of file CodeSquashContext.h.

◆ _loopLevel

int RooFit::Detail::CodeSquashContext::_loopLevel = 0

private

The current number of for loops the started.

Definition at line 183 of file CodeSquashContext.h.

◆ _nodeNames

std::unordered_map<const TNamed *, std::string> RooFit::Detail::CodeSquashContext::_nodeNames

private

Map of node names to their result strings.

Definition at line 173 of file CodeSquashContext.h.

◆ _nodeOutputSizes

std::map<RooFit::Detail::DataKey, std::size_t> RooFit::Detail::CodeSquashContext::_nodeOutputSizes

private

Map of node output sizes.

Definition at line 179 of file CodeSquashContext.h.

◆ _scopePtr

int RooFit::Detail::CodeSquashContext::_scopePtr = -1

private

Keeps track of the position to go back and insert code to.

Definition at line 187 of file CodeSquashContext.h.

◆ _tempScope

std::string RooFit::Detail::CodeSquashContext::_tempScope

private

Stores code that eventually gets injected into main code body.

Mainly used for placing decls outside of loops.

Definition at line 190 of file CodeSquashContext.h.

◆ _tmpVarIdx

int RooFit::Detail::CodeSquashContext::_tmpVarIdx = 0

mutableprivate

Index to get unique names for temporary variables.

Definition at line 185 of file CodeSquashContext.h.

◆ _vecObsIndices

std::unordered_map<const TNamed *, int> RooFit::Detail::CodeSquashContext::_vecObsIndices

private

A map to keep track of the observable indices if they are non scalar.

Definition at line 177 of file CodeSquashContext.h.

◆ _wrapper

Experimental::RooFuncWrapper* RooFit::Detail::CodeSquashContext::_wrapper = nullptr

Definition at line 118 of file CodeSquashContext.h.

◆ _xlArr

std::vector<double>& RooFit::Detail::CodeSquashContext::_xlArr

private

Definition at line 193 of file CodeSquashContext.h.

◆ listNames

std::unordered_map<RooFit::UniqueId<RooAbsCollection>::Value_t, std::string> RooFit::Detail::CodeSquashContext::listNames

private

A map to keep track of list names as assigned by addResult.

Definition at line 192 of file CodeSquashContext.h.

Libraries for RooFit::Detail::CodeSquashContext:

[legend]

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

roofit/roofitcore/inc/RooFit/Detail/CodeSquashContext.h
roofit/roofitcore/src/RooFit/Detail/CodeSquashContext.cxx

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ CodeSquashContext()

Member Function Documentation

◆ addResult() [1/3]

◆ addResult() [2/3]

◆ addResult() [3/3]

◆ addToCodeBody() [1/2]

◆ addToCodeBody() [2/2]

◆ addToGlobalScope()

◆ addVecObs()

◆ assembleCode()

◆ beginLoop()

◆ buildArg() [1/9]

◆ buildArg() [2/9]

◆ buildArg() [3/9]

◆ buildArg() [4/9]

◆ buildArg() [5/9]

◆ buildArg() [6/9]

◆ buildArg() [7/9]

◆ buildArg() [8/9]

◆ buildArg() [9/9]

◆ buildArgs() [1/3]

◆ buildArgs() [2/3]

◆ buildArgs() [3/3]

◆ buildArgSpanImpl()

◆ buildCall()

◆ collectFunction()

◆ endLoop()

◆ getResult() [1/2]

◆ getResult() [2/2]

◆ getTmpVarName()

◆ isScopeIndependent()

◆ outputSize()

◆ typeName() [1/3]

◆ typeName() [2/3]

◆ typeName() [3/3]

Member Data Documentation

◆ _code

◆ _globalScope

◆ _loopLevel

◆ _nodeNames

◆ _nodeOutputSizes

◆ _scopePtr

◆ _tempScope

◆ _tmpVarIdx

◆ _vecObsIndices

◆ _wrapper

◆ _xlArr

◆ listNames