IStatCorrelationProxy Struct Reference

Abstract read-only interface for correlation queries in the statistics module. More...

#include <IStatCorrelationProxy.h>

Inheritance diagram for IStatCorrelationProxy:

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

Public Member Functions
virtual	~IStatCorrelationProxy ()=default
	Virtual destructor.
virtual double	operator() (const ParamId &lhs, const ParamId &rhs, Type type)=0
	Returns the correlation coefficient between two parameters.
virtual double	operator() (const ExperimentObs &lhs, const ExperimentObs &rhs, Type type)=0
	Returns the correlation coefficient between two fully explicit experiment-scoped observables.
virtual double	operator() (const std::string &experiment, const Observables &lhs, const Observables &rhs, Type type)=0
	Returns the correlation coefficient between two observables identified by enum in the same experiment.
virtual double	operator() (const std::string &experiment, const ObservableId &lhs, const ObservableId &rhs, Type type)=0
	Returns the correlation coefficient between two observables identified by ObservableId in the same experiment.
virtual double	operator() (const std::string &experiment, const BinnedObservableId &lhs, const BinnedObservableId &rhs, Type type)=0
	Returns the correlation coefficient between two binned observables in the same experiment.
virtual double	operator() (const std::string &exp_lhs, const BinnedObservableId &lhs, const std::string &exp_rhs, const BinnedObservableId &rhs, Type type)=0
	Returns the correlation coefficient between two binned observables coming from possibly different experiments.

Detailed Description

Abstract read-only interface for correlation queries in the statistics module.

This port provides a uniform callable API so higher-level statistical code can request correlation coefficients without depending directly on the storage/backend layer.

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 45 of file IStatCorrelationProxy.h.

Member Typedef Documentation

Type

using IStatCorrelationProxy::Type = CorrelationProvider::CorrelationType

Alias for the correlation selector type used by the backend provider.

Definition at line 47 of file IStatCorrelationProxy.h.

Constructor & Destructor Documentation

~IStatCorrelationProxy()

virtual IStatCorrelationProxy::~IStatCorrelationProxy ( )

virtualdefault

Virtual destructor.

Member Function Documentation

operator()() [1/6]

virtual double IStatCorrelationProxy::operator() ( const ExperimentObs &  lhs, const ExperimentObs &  rhs, Type  type  )

pure virtual

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

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.

Implemented in StatCorrelationProxy.

operator()() [2/6]

virtual double IStatCorrelationProxy::operator() ( const ParamId &  lhs, const ParamId &  rhs, Type  type  )

pure virtual

Returns the correlation coefficient between two parameters.

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.

Implemented in StatCorrelationProxy.

operator()() [3/6]

virtual double IStatCorrelationProxy::operator() ( const std::string &  exp_lhs, const BinnedObservableId &  lhs, const std::string &  exp_rhs, const BinnedObservableId &  rhs, Type  type  )

pure virtual

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

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.

Implemented in StatCorrelationProxy.

operator()() [4/6]

virtual double IStatCorrelationProxy::operator() ( const std::string &  experiment, const BinnedObservableId &  lhs, const BinnedObservableId &  rhs, Type  type  )

pure virtual

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

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.

Implemented in StatCorrelationProxy.

operator()() [5/6]

virtual double IStatCorrelationProxy::operator() ( const std::string &  experiment, const ObservableId &  lhs, const ObservableId &  rhs, Type  type  )

pure virtual

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

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.

Implemented in StatCorrelationProxy.

operator()() [6/6]

virtual double IStatCorrelationProxy::operator() ( const std::string &  experiment, const Observables &  lhs, const Observables &  rhs, Type  type  )

pure virtual

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

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.

Implemented in StatCorrelationProxy.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/ports/IStatCorrelationProxy.h