Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
IStatParameterProxy Class Referenceabstract

Abstract read-only interface to parameters and observables for the statistics layer. More...

#include <IStatParameterProxy.h>

Inheritance diagram for IStatParameterProxy:

Public Member Functions

virtual ~IStatParameterProxy ()=default
 Virtual destructor.
 
virtual std::shared_ptr< Parameterget_param (const ParamId &) const =0
 Returns the underlying parameter object identified by a typed ParamId.
 
virtual std::shared_ptr< Parameterget_param (const std::string &block, const LhaID &id) const =0
 Returns the underlying parameter object identified by block and LHA id.
 
virtual scalar_t operator() (const ParamId &, DataType d_type=DataType::VALUE) const =0
 Returns a scalar quantity for a typed parameter.
 
virtual std::map< ExperimentObs, double > operator() (const ObservableId &, DataType d_type=DataType::VALUE) const =0
 Returns a vector of scalar quantities (for each experiments) for an observable identified by ObservableId.
 
virtual std::map< ExperimentObs, double > operator() (const BinnedObservableId &id, DataType d_type=DataType::VALUE) const =0
 Returns a vector of scalar quantities (for each experiments) for a binned observable entry.
 
virtual scalar_t operator() (const std::string &block, const LhaID &id, DataType d_type=DataType::VALUE) const =0
 Returns a scalar quantity for a parameter identified by block and LHA id.
 
virtual std::map< ExperimentObs, std::shared_ptr< Parameter > > get_obs_param (const BinnedObservableId &) const =0
 Returns a vector of the underlying parameter objects for a binned observable entry.
 

Detailed Description

Abstract read-only interface to parameters and observables for the statistics layer.

This interface provides two families of access:

The object-returning methods are useful when the caller needs more than the scalar value itself (uncertainties, binning, metadata, ownership, etc.).

Definition at line 51 of file IStatParameterProxy.h.

Constructor & Destructor Documentation

◆ ~IStatParameterProxy()

virtual IStatParameterProxy::~IStatParameterProxy ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ get_obs_param()

virtual std::map< ExperimentObs, std::shared_ptr< Parameter > > IStatParameterProxy::get_obs_param ( const BinnedObservableId ) const
pure virtual

Returns a vector of the underlying parameter objects for a binned observable entry.

This is useful when the caller needs access to the full parameter metadata associated with a binned observable, such as uncertainties or binning info.

Parameters
idBinned observable identifier.
Returns
Map of shared pointer to the corresponding Parameter.

Implemented in StatParameterProxy.

◆ get_param() [1/2]

virtual std::shared_ptr< Parameter > IStatParameterProxy::get_param ( const ParamId ) const
pure virtual

Returns the underlying parameter object identified by a typed ParamId.

Parameters
pidFully typed parameter identifier.
Returns
Shared pointer to the corresponding Parameter.

Implemented in StatParameterProxy.

◆ get_param() [2/2]

virtual std::shared_ptr< Parameter > IStatParameterProxy::get_param ( const std::string &  block,
const LhaID id 
) const
pure virtual

Returns the underlying parameter object identified by block and LHA id.

This overload is intended for proxies already bound to a specific ParameterType.

Parameters
blockBlock name.
idLHA-like identifier inside the block.
Returns
Shared pointer to the corresponding Parameter.

Implemented in StatParameterProxy.

◆ operator()() [1/4]

virtual std::map< ExperimentObs, double > IStatParameterProxy::operator() ( const BinnedObservableId id,
DataType  d_type = DataType::VALUE 
) const
pure virtual

Returns a vector of scalar quantities (for each experiments) for a binned observable entry.

This overload is used when the observable is identified not only by its base observable id but also by a bin definition encoded in BinnedObservableId.

Parameters
idBinned observable identifier.
d_typeRequested quantity type.
Returns
Requested map of scalar quantities.

Implemented in StatParameterProxy.

◆ operator()() [2/4]

virtual std::map< ExperimentObs, double > IStatParameterProxy::operator() ( const ObservableId ,
DataType  d_type = DataType::VALUE 
) const
pure virtual

Returns a vector of scalar quantities (for each experiments) for an observable identified by ObservableId.

This is typically used for experimental observable entries stored in the observable parameter blocks.

Parameters
idObservable identifier.
d_typeRequested quantity type.
Returns
Requested map of scalar quantities.

Implemented in StatParameterProxy.

◆ operator()() [3/4]

virtual scalar_t IStatParameterProxy::operator() ( const ParamId ,
DataType  d_type = DataType::VALUE 
) const
pure virtual

Returns a scalar quantity for a typed parameter.

Depending on d_type, returns the central value or one of its uncertainties.

Parameters
pidFully typed parameter identifier.
d_typeRequested quantity type.
Returns
Requested scalar quantity.

Implemented in StatParameterProxy.

◆ operator()() [4/4]

virtual scalar_t IStatParameterProxy::operator() ( const std::string &  block,
const LhaID id,
DataType  d_type = DataType::VALUE 
) const
pure virtual

Returns a scalar quantity for a parameter identified by block and LHA id.

This overload is intended for proxies already bound to a specific ParameterType.

Parameters
blockBlock name.
idLHA-like identifier inside the block.
d_typeRequested quantity type.
Returns
Requested scalar quantity.

Implemented in StatParameterProxy.


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