Definition at line 28 of file LikelihoodJob.h.

Classes
struct	task_result_t

struct	update_state_t

Public Types
enum class	update_state_mode : int { parameters , offsetting }

Public Member Functions
	LikelihoodJob (std::shared_ptr< RooAbsL > _likelihood, std::shared_ptr< WrapperCalculationCleanFlags > calculation_is_clean)

LikelihoodJob *	clone () const override

void	enableOffsetting (bool flag) override

void	evaluate () override
	Triggers (possibly asynchronous) evaluation of the likelihood.

void	evaluate_task (std::size_t task) override

ROOT::Math::KahanSum< double >	getResult () const override
	Return the latest result of a likelihood evaluation.

void	init_vars ()

bool	receive_task_result_on_master (const zmq::message_t &message) override

void	send_back_task_result_from_worker (std::size_t task) override

void	update_state () override
	Virtual function to update any necessary state on workers.

void	updateWorkersOffsetting ()

void	updateWorkersParameters ()

Public Member Functions inherited from RooFit::MultiProcess::Job
	Job ()

	Job (const Job &other)

	~Job ()

void	gather_worker_results ()
	Wait for all tasks to be retrieved for the current Job.

std::size_t	get_state_id ()
	Get the current state identifier.

Public Member Functions inherited from RooFit::TestStatistics::LikelihoodWrapper
	LikelihoodWrapper (std::shared_ptr< RooAbsL > likelihood, std::shared_ptr< WrapperCalculationCleanFlags > calculation_is_clean)

virtual	~LikelihoodWrapper ()=default

void	constOptimizeTestStatistic (RooAbsArg::ConstOpCode opcode, bool doAlsoTrackingOpt)

double	defaultErrorLevel () const

virtual std::string	GetName () const

virtual std::string	GetTitle () const

virtual bool	isOffsetting () const

ROOT::Math::KahanSum< double >	offset () const

void	setApplyWeightSquared (bool flag)

void	setOffsettingMode (OffsettingMode mode)

virtual void	synchronizeParameterSettings (const std::vector< ROOT::Fit::ParameterSettings > &parameter_settings)

virtual void	synchronizeWithMinimizer (const ROOT::Math::MinimizerOptions &options)
	Synchronize minimizer settings with calculators in child classes.

virtual void	updateMinuitExternalParameterValues (const std::vector< double > &minuit_external_x)

virtual void	updateMinuitInternalParameterValues (const std::vector< double > &minuit_internal_x)
	Minuit passes in parameter values that may not conform to RooFit internal standards (like applying range clipping), but that the specific calculator does need.

Private Member Functions
std::size_t	getNComponentTasks ()

std::size_t	getNEventTasks ()

Private Attributes
LikelihoodType	likelihood_type_

std::size_t	n_component_tasks_

std::size_t	n_event_tasks_

std::size_t	n_tasks_at_workers_ = 0

ROOT::Math::KahanSum< double >	result_

std::vector< ROOT::Math::KahanSum< double > >	results_

RooArgList	save_vars_

RooArgList	vars_

Additional Inherited Members
Static Public Member Functions inherited from RooFit::TestStatistics::LikelihoodWrapper
static std::unique_ptr< LikelihoodWrapper >	create (LikelihoodMode likelihoodMode, std::shared_ptr< RooAbsL > likelihood, std::shared_ptr< WrapperCalculationCleanFlags > calculationIsClean)
	Factory method.

Protected Member Functions inherited from RooFit::MultiProcess::Job
JobManager *	get_manager ()
	Get JobManager instance; create and activate if necessary.

Protected Member Functions inherited from RooFit::TestStatistics::LikelihoodWrapper
ROOT::Math::KahanSum< double >	applyOffsetting (ROOT::Math::KahanSum< double > current_value)

void	swapOffsets ()
	When calculating an unbinned likelihood with square weights applied, a different offset is necessary.

Protected Attributes inherited from RooFit::MultiProcess::Job
std::size_t	id_

std::size_t	state_id_ = 0

Protected Attributes inherited from RooFit::TestStatistics::LikelihoodWrapper
std::shared_ptr< WrapperCalculationCleanFlags >	calculation_is_clean_

bool	do_offset_ = false

std::shared_ptr< RooAbsL >	likelihood_

ROOT::Math::KahanSum< double >	offset_

ROOT::Math::KahanSum< double >	offset_save_ {0.}
	!

OffsettingMode	offsetting_mode_ = OffsettingMode::legacy

#include </home/sftnight/build/workspace/root-makedoc-v628/rootspi/rdoc/src/v6-28-00-patches/roofit/roofitcore/src/TestStatistics/LikelihoodJob.h>

Inheritance diagram for RooFit::TestStatistics::LikelihoodJob:

[legend]

Member Enumeration Documentation

◆ update_state_mode

enum class RooFit::TestStatistics::LikelihoodJob::update_state_mode : int

strong

Enumerator
parameters
offsetting

Definition at line 51 of file LikelihoodJob.h.

Constructor & Destructor Documentation

◆ LikelihoodJob()

RooFit::TestStatistics::LikelihoodJob::LikelihoodJob	(	std::shared_ptr< RooAbsL >	_likelihood,
		std::shared_ptr< WrapperCalculationCleanFlags >	calculation_is_clean
	)

Definition at line 31 of file LikelihoodJob.cxx.

Member Function Documentation

◆ clone()

LikelihoodJob * RooFit::TestStatistics::LikelihoodJob::clone ( ) const

overridevirtual

Implements RooFit::TestStatistics::LikelihoodWrapper.

Definition at line 56 of file LikelihoodJob.cxx.

◆ enableOffsetting()

void RooFit::TestStatistics::LikelihoodJob::enableOffsetting ( bool flag )

overridevirtual

Reimplemented from RooFit::TestStatistics::LikelihoodWrapper.

Definition at line 277 of file LikelihoodJob.cxx.

◆ evaluate()

void RooFit::TestStatistics::LikelihoodJob::evaluate ( )

overridevirtual

Triggers (possibly asynchronous) evaluation of the likelihood.

In parallel strategies, it may be advantageous to allow a calling process to continue on with other tasks while the calculation is offloaded to another process or device, like a GPU. For this reason, evaluate() does not return the result, this is done in getResult().

Implements RooFit::TestStatistics::LikelihoodWrapper.

Definition at line 181 of file LikelihoodJob.cxx.

◆ evaluate_task()

void RooFit::TestStatistics::LikelihoodJob::evaluate_task ( std::size_t task )

overridevirtual

Implements RooFit::MultiProcess::Job.

Definition at line 228 of file LikelihoodJob.cxx.

◆ getNComponentTasks()

std::size_t RooFit::TestStatistics::LikelihoodJob::getNComponentTasks ( )

private

Definition at line 126 of file LikelihoodJob.cxx.

◆ getNEventTasks()

std::size_t RooFit::TestStatistics::LikelihoodJob::getNEventTasks ( )

private

Warning: In automatic mode, this function can start MultiProcess (forks, starts workers, etc)!

Definition at line 113 of file LikelihoodJob.cxx.

◆ getResult()

ROOT::Math::KahanSum< double > RooFit::TestStatistics::LikelihoodJob::getResult ( ) const

inlineoverridevirtual

Return the latest result of a likelihood evaluation.

Returns the result that was stored after calling evaluate(). It is up to the implementer to make sure the stored value represents the most recent evaluation call, e.g. by using a mutex.

Implements RooFit::TestStatistics::LikelihoodWrapper.

Definition at line 37 of file LikelihoodJob.h.

◆ init_vars()

void RooFit::TestStatistics::LikelihoodJob::init_vars ( )

Definition at line 66 of file LikelihoodJob.cxx.

◆ receive_task_result_on_master()

bool RooFit::TestStatistics::LikelihoodJob::receive_task_result_on_master ( const zmq::message_t & message )

overridevirtual

Implements RooFit::MultiProcess::Job.

Definition at line 217 of file LikelihoodJob.cxx.

◆ send_back_task_result_from_worker()

void RooFit::TestStatistics::LikelihoodJob::send_back_task_result_from_worker ( std::size_t task )

overridevirtual

Implements RooFit::MultiProcess::Job.

Definition at line 209 of file LikelihoodJob.cxx.

◆ update_state()

void RooFit::TestStatistics::LikelihoodJob::update_state ( )

overridevirtual

Virtual function to update any necessary state on workers.

This function is called from the worker loop when something is received over the ZeroMQ "SUB" socket. The master process sends messages to workers on its "PUB" socket. Thus, we can update, for instance, parameter values on the worker that were updated since the last call on the master side.

Note: Implementers: make sure to also update the state_id_ member.

Reimplemented from RooFit::MultiProcess::Job.

Definition at line 84 of file LikelihoodJob.cxx.

◆ updateWorkersOffsetting()

void RooFit::TestStatistics::LikelihoodJob::updateWorkersOffsetting ( )

Definition at line 176 of file LikelihoodJob.cxx.

◆ updateWorkersParameters()

void RooFit::TestStatistics::LikelihoodJob::updateWorkersParameters ( )

Definition at line 138 of file LikelihoodJob.cxx.

Member Data Documentation

◆ likelihood_type_

LikelihoodType RooFit::TestStatistics::LikelihoodJob::likelihood_type_

private

Definition at line 72 of file LikelihoodJob.h.

◆ n_component_tasks_

std::size_t RooFit::TestStatistics::LikelihoodJob::n_component_tasks_

private

Definition at line 77 of file LikelihoodJob.h.

◆ n_event_tasks_

std::size_t RooFit::TestStatistics::LikelihoodJob::n_event_tasks_

private

Definition at line 76 of file LikelihoodJob.h.

◆ n_tasks_at_workers_

std::size_t RooFit::TestStatistics::LikelihoodJob::n_tasks_at_workers_ = 0

private

Definition at line 73 of file LikelihoodJob.h.

◆ result_

ROOT::Math::KahanSum<double> RooFit::TestStatistics::LikelihoodJob::result_

private

Definition at line 66 of file LikelihoodJob.h.

◆ results_

std::vector<ROOT::Math::KahanSum<double> > RooFit::TestStatistics::LikelihoodJob::results_

private

Definition at line 67 of file LikelihoodJob.h.

◆ save_vars_

RooArgList RooFit::TestStatistics::LikelihoodJob::save_vars_

private

Definition at line 70 of file LikelihoodJob.h.

◆ vars_

RooArgList RooFit::TestStatistics::LikelihoodJob::vars_

private

Definition at line 69 of file LikelihoodJob.h.

roofit/roofitcore/src/TestStatistics/LikelihoodJob.h

roofit/roofitcore/src/TestStatistics/LikelihoodJob.cxx

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ update_state_mode

Constructor & Destructor Documentation

◆ LikelihoodJob()

Member Function Documentation

◆ clone()

◆ enableOffsetting()

◆ evaluate()

◆ evaluate_task()

◆ getNComponentTasks()

◆ getNEventTasks()

◆ getResult()

◆ init_vars()

◆ receive_task_result_on_master()

◆ send_back_task_result_from_worker()

◆ update_state()

◆ updateWorkersOffsetting()

◆ updateWorkersParameters()

Member Data Documentation

◆ likelihood_type_

◆ n_component_tasks_

◆ n_event_tasks_

◆ n_tasks_at_workers_

◆ result_

◆ results_

◆ save_vars_

◆ vars_