Concrete implementation of IStatCorrelationProxy for the statistics module. More...

#include <StatCorrelationProxy.h>

Inheritance diagram for StatCorrelationProxy:

Collaboration diagram for StatCorrelationProxy:

Public Types
using	Type = CorrelationProvider::CorrelationType
	Alias for the correlation selector type.

Public Types inherited from IStatCorrelationProxy
using	Type = CorrelationProvider::CorrelationType
	Alias for the correlation selector type used by the backend provider.

Public Member Functions
double	operator() (const ParamId &lhs, const ParamId &rhs, Type type) override
	Returns the correlation coefficient between two parameters.

double	operator() (const ExperimentObs &lhs, const ExperimentObs &rhs, Type type) override
	Returns the correlation coefficient between two fully explicit experiment-scoped observables.

double	operator() (const std::string &experiment, const Observables &lhs, const Observables &rhs, Type type) override
	Returns the correlation coefficient between two observables identified by enum in the same experiment.

double	operator() (const std::string &experiment, const ObservableId &lhs, const ObservableId &rhs, Type type) override
	Returns the correlation coefficient between two observables identified by ObservableId in the same experiment.

double	operator() (const std::string &experiment, const BinnedObservableId &lhs, const BinnedObservableId &rhs, Type type) override
	Returns the correlation coefficient between two binned observables in the same experiment.

double	operator() (const std::string &exp_lhs, const BinnedObservableId &lhs, const std::string &exp_rhs, const BinnedObservableId &rhs, Type type) override
	Returns the correlation coefficient between two binned observables coming from possibly different experiments.

Public Member Functions inherited from IStatCorrelationProxy
virtual	~IStatCorrelationProxy ()=default
	Virtual destructor.

Detailed Description

Concrete implementation of IStatCorrelationProxy for the statistics module.

This proxy centralizes correlation access behind a small stable interface, allowing the statistics layer to remain decoupled from the underlying correlation storage / provider implementation.

Observable correlations are experiment-scoped: the experiment name is part of the lookup key unless a fully explicit ExperimentObs object is used.

Definition at line 56 of file StatCorrelationProxy.h.

Member Typedef Documentation

◆ Type

using StatCorrelationProxy::Type = CorrelationProvider::CorrelationType

Alias for the correlation selector type.

Definition at line 59 of file StatCorrelationProxy.h.

Member Function Documentation

◆ operator()() [1/6]

double StatCorrelationProxy::operator()	(	const ExperimentObs &	oid_1,
		const ExperimentObs &	oid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two fully explicit experiment-scoped observables.

Delegates directly to the internal CorrelationProvider.

Parameters

lhs	First experiment-scoped observable.
rhs	Second experiment-scoped observable.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

This overload is the most explicit observable interface. Each observable is identified by an ExperimentObs, i.e. by the pair (experiment, BinnedObservableId).

Parameters

lhs	First experiment-scoped observable.
rhs	Second experiment-scoped observable.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 15 of file StatCorrelationProxy.cpp.

◆ operator()() [2/6]

double StatCorrelationProxy::operator()	(	const ParamId &	pid_1,
		const ParamId &	pid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two parameters.

Delegates directly to the internal CorrelationProvider.

Parameters

lhs	First parameter identifier.
rhs	Second parameter identifier.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

Both parameters are identified by fully typed ParamId objects.

Parameters

lhs	First parameter identifier.
rhs	Second parameter identifier.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 6 of file StatCorrelationProxy.cpp.

◆ operator()() [3/6]

double StatCorrelationProxy::operator()	(	const std::string &	exp_1,
		const BinnedObservableId &	oid_1,
		const std::string &	exp_2,
		const BinnedObservableId &	oid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two binned observables coming from possibly different experiments.

Delegates directly to the internal CorrelationProvider.

Parameters

exp_lhs	Experiment associated with the first observable.
lhs	First binned observable identifier.
exp_rhs	Experiment associated with the second observable.
rhs	Second binned observable identifier.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

Parameters

exp_lhs	Experiment associated with the first observable.
lhs	First binned observable identifier.
exp_rhs	Experiment associated with the second observable.
rhs	Second binned observable identifier.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 54 of file StatCorrelationProxy.cpp.

◆ operator()() [4/6]

double StatCorrelationProxy::operator()	(	const std::string &	experiment,
		const BinnedObservableId &	oid_1,
		const BinnedObservableId &	oid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two binned observables in the same experiment.

Delegates directly to the internal CorrelationProvider.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First binned observable identifier.
rhs	Second binned observable identifier.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

This overload is intended for observable entries carrying an explicit bin definition through BinnedObservableId.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First binned observable identifier.
rhs	Second binned observable identifier.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 44 of file StatCorrelationProxy.cpp.

◆ operator()() [5/6]

double StatCorrelationProxy::operator()	(	const std::string &	experiment,
		const ObservableId &	oid_1,
		const ObservableId &	oid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two observables identified by ObservableId in the same experiment.

Delegates directly to the internal CorrelationProvider.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First observable identifier.
rhs	Second observable identifier.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First observable identifier.
rhs	Second observable identifier.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 34 of file StatCorrelationProxy.cpp.

◆ operator()() [6/6]

double StatCorrelationProxy::operator()	(	const std::string &	experiment,
		const Observables &	oid_1,
		const Observables &	oid_2,
		Type	type
	)

overridevirtual

Returns the correlation coefficient between two observables identified by enum in the same experiment.

Delegates directly to the internal CorrelationProvider.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First observable.
rhs	Second observable.
type	Kind of correlation requested.

Returns: Requested correlation coefficient.

Parameters

experiment	Experiment name used to scope both observables.
lhs	First observable.
rhs	Second observable.
type	Kind of correlation requested (statistical, systematic, combined).

Returns: Requested correlation coefficient.

Implements IStatCorrelationProxy.

Definition at line 24 of file StatCorrelationProxy.cpp.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/adapters/StatCorrelationProxy.h
/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/adapters/StatCorrelationProxy.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Type

Member Function Documentation

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]