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

Abstract source of InterpretedParam mappings. More...

#include <IParamMappingSource.h>

Inheritance diagram for IParamMappingSource:

Public Member Functions

virtual ~IParamMappingSource ()=default
 
virtual std::unordered_map< std::string, InterpretedParamloadFromFile (const std::string &filePath) const =0
 Loads all parameter mappings from a given file.
 

Detailed Description

Abstract source of InterpretedParam mappings.

A mapping source is responsible for:

  • locating and reading an input file (or other medium),
  • interpreting its structure,
  • returning a mapping from string names to InterpretedParam objects.

Example implementations:

Definition at line 33 of file IParamMappingSource.h.

Constructor & Destructor Documentation

◆ ~IParamMappingSource()

virtual IParamMappingSource::~IParamMappingSource ( )
virtualdefault

Member Function Documentation

◆ loadFromFile()

virtual std::unordered_map< std::string, InterpretedParam > IParamMappingSource::loadFromFile ( const std::string &  filePath) const
pure virtual

Loads all parameter mappings from a given file.

The exact file format (JSON, YAML, etc.) is implementation-specific.

Parameters
filePathPath to the mapping file to load.
Returns
Map from parameter name (string) to InterpretedParam.
Exceptions
std::runtime_erroror derived exceptions if the file cannot be read or parsed correctly.

Implemented in JsonParamMappingAdapter.


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