InputParser Class Reference

A class for reading input parameters and output directives. More...

#include <InputParser.h>

Detailed Description

A class for reading input parameters and output directives.

Author

HEPfit Collaboration

Copyright

GNU General Public License

The InputParser parses the SomeModel.conf file for the name of the model, ModelParameters, Observables, * Observables2D, ModelParaVsObs and CorrelatedGaussianObservables. The observables (or set of observables) are parsed for their inclusion in the Monte Carlo run.

Definition at line 48 of file InputParser.h.

Public Member Functions
void	addCustomObservableType (const std::string name, boost::function< Observable *() > funct)
Observable *	CreateObservableType (const std::string &name) const
StandardModel *	getModel () const
	A get method to access the pointer to the object of the StandardModel class. More...
ModelFactory &	getModelFactory () const
const ThObsFactory &	getObsFactory () const
	InputParser (const InputParser &orig)
	The copy constructor. More...
	InputParser (ModelFactory &ModF, ThObsFactory &ObsF)
	Constructor. More...
std::string	ReadParameters (const std::string filename_i, const int rank, std::vector< ModelParameter > &ModelPars, boost::ptr_vector< Observable > &Observables, std::vector< Observable2D > &Observables2D, std::vector< CorrelatedGaussianObservables > &CGO, std::vector< CorrelatedGaussianParameters > &CGP)
	The member that parses the Observable2D directives from SomeModel.conf file. More...
void	setModel (StandardModel *myModel_i)
virtual	~InputParser ()
	The default destructor. More...

Private Attributes
std::map< std::string, boost::tuple< bool, std::string, int > >	checkDuplicateParameter
std::map< std::string, boost::function< Observable *()> >	customObservableTypeMap
std::string	filename
std::string	filepath
bool	IsEOF
std::string	line
int	lineNo
std::string	modeldefinedinfile
bool	modelset
std::string	modname
	A string to store the model name in. More...
StandardModel *	myModel
	Pointer to an object of type StandardModel. More...
ModelFactory &	myModelFactory
	Pointer to an object of type ModelFactory. More...
ThObsFactory &	myObsFactory
	Reference to an object of type ThObsFactory. More...
int	rank

Constructor & Destructor Documentation

InputParser() [1/2]

InputParser::InputParser	(	ModelFactory &	ModF,
		ThObsFactory &	ObsF
	)

Constructor.

Definition at line 16 of file InputParser.cpp.

                                                               : myModelFactory(ModF), myObsFactory(ObsF), filename(""), rank(0)
{
    modelset = 0;
    myModel = NULL;
}

InputParser() [2/2]

InputParser::InputParser

(

const InputParser &

orig

)

The copy constructor.

Parameters

[in]

orig

a reference to an object of type InputParser()

Definition at line 22 of file InputParser.cpp.

                                                : myModelFactory(orig.myModelFactory), myObsFactory(orig.myObsFactory), filename(""), rank(0)
{
    myModel = new StandardModel(*orig.myModel);
}

~InputParser()

InputParser::~InputParser ( )

virtual

The default destructor.

Definition at line 27 of file InputParser.cpp.

{
    if (myModel != NULL) {
        delete myModel;
        myModel = NULL;
    }
}

Member Function Documentation

addCustomObservableType()

void InputParser::addCustomObservableType	(	const std::string	name,
		boost::function< Observable *() >	funct
	)

Definition at line 250 of file InputParser.cpp.

{
    customObservableTypeMap[name] = funct;
}

CreateObservableType()

Observable * InputParser::CreateObservableType

(

const std::string &

name

)

const

Definition at line 255 of file InputParser.cpp.

{
    if (customObservableTypeMap.find(name) == customObservableTypeMap.end()) {
        if (rank ==0) throw std::runtime_error("ERROR: No observable defined for " + name + " so it cannot be created");
        else sleep(0);
    }
    return (customObservableTypeMap.at(name)());
}

getModel()

StandardModel* InputParser::getModel ( ) const

inline

A get method to access the pointer to the object of the StandardModel class.

Returns

myModel a pointer to the object of the StandardModel class

Definition at line 109 of file InputParser.h.

    {
        return myModel;
    }

getModelFactory()

ModelFactory& InputParser::getModelFactory ( ) const

inline

Definition at line 119 of file InputParser.h.

                                          {
        return myModelFactory;
    }

getObsFactory()

const ThObsFactory& InputParser::getObsFactory ( ) const

inline

Definition at line 114 of file InputParser.h.

    {
        return myObsFactory;
    }

ReadParameters()

std::string InputParser::ReadParameters	(	const std::string	filename_i,
		const int	rank,
		std::vector< ModelParameter > &	ModelPars,
		boost::ptr_vector< Observable > &	Observables,
		std::vector< Observable2D > &	Observables2D,
		std::vector< CorrelatedGaussianObservables > &	CGO,
		std::vector< CorrelatedGaussianParameters > &	CGP
	)

The member that parses the Observable2D directives from SomeModel.conf file.

Parameters

[in]	Observables	a vector of Observables
[in]	ifile	the file being read
[in]	beg	an iterator over words in a line separated by a specific separator character

Responsible for parsing the SomeModel.conf file.

This method parses the SomeModel.conf file for all input instructions. The algorithm is as follows:

• Search for the predefined names of the available models, initialize the necessary model class and build a ThFactory for that model to define the observables.
• Search and read the ModelParameter list.
• Search and read the CorrelatedGaussianParameters.
• Search and read the Observable list using the ParseObservable() method.
• Search and read the Observable2D list using the ParseObservable() method.
• Search and read the CorrelatedGaussianObservables.
• Return the name of the model initialized.

  Parameters

  [in]	filename	name of the SomeModel.conf file passed as an argument to the executable
  [in]	rank	the rank of the process in an MPI run (set to 0 for a serial run)
  [out]	ModelPars	the vector of model parameters
  [out]	Observables	the vector of observables
  [out]	Observables2D	the vector of observable pairs
  [out]	CGO	the vector of correlated Gaussian observables
  [out]	CGP	the vector of correlated Gaussian parameters

  Returns

  modname the name of the model initialized

Definition at line 35 of file InputParser.cpp.

{
    filename = filename_i;
    rank = rank_i;
    lineNo = 0;
    std::ifstream ifile(filename.c_str());
    if (!ifile.is_open()) {
        if(rank == 0) throw std::runtime_error("\nERROR: " + filename + " does not exist. Make sure to specify a valid model configuration file.\n");
        else sleep (2);
    }
 
    if (filename.find("\\/") == std::string::npos) filepath = filename.substr(0, filename.find_last_of("\\/") + 1);
    IsEOF = false;
    boost::char_separator<char> * sep = new boost::char_separator<char>(" \t");
    do {
        IsEOF = getline(ifile, line).eof();
        lineNo++;
        if (*line.rbegin() == '\r') line.erase(line.length() - 1); // for CR+LF
        if (line.empty() || line.find_first_not_of(' ') == std::string::npos || line.at(0) == '#')
            continue;
        boost::tokenizer<boost::char_separator<char> > *tok = new boost::tokenizer<boost::char_separator<char> >(line, *sep);
        boost::tokenizer<boost::char_separator<char> >::iterator beg = tok->begin();
 
        if (modelset == 0) {
            modname = *beg;
            myModel = myModelFactory.CreateModel(modname);
            myModel->setModelName(modname);
            myModel->InitializeModel();
            if (myModel->IsModelInitialized()) {
                if (rank == 0) std::cout << "\nModel Initialized: " << modname << "\n" << std::endl;
                modeldefinedinfile = filename;
            } else if (rank == 0)
                throw std::runtime_error("\nERROR: " + modname + " not initialized successfully.\n");
            modelset = 1;
            continue;
        } else if (modelset == 1 && beg->compare(myModel->getModelName()) == 0) {
            continue;
        }
 
        std::string type = *beg;
        ++beg;
        if (type.compare("ModelParameter") == 0) {
            
            if (std::distance(tok->begin(), tok->end()) < 5) {
                if (rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + filename + ".\n");
                else sleep(2);
            } else {
            ModelParameter tmpMP;
            beg = tmpMP.ParseModelParameter(beg);
            
            if (checkDuplicateParameter[tmpMP.getname()].get<0>()) {
                if(rank == 0) throw std::runtime_error("\nERROR: ModelParameter " + tmpMP.getname() + " appears more than once ...!! \n" +
                "1st Occurrence: Line No:" + boost::lexical_cast<std::string>(checkDuplicateParameter[tmpMP.getname()].get<2>()) +
                " in file " + checkDuplicateParameter[tmpMP.getname()].get<1>() + ".\n"
                "2nd Occurrence: Line No:" + boost::lexical_cast<std::string>(lineNo) + " in file " + filename + ".\n");
                else sleep (2);
            }
            
            if (beg != tok->end())
                if (rank == 0) std::cout << "WARNING: unread information in parameter " << tmpMP.getname() << std::endl;
            checkDuplicateParameter[tmpMP.getname()] = boost::make_tuple(true, filename, lineNo);
               
            ModelPars.push_back(tmpMP);
            }
 
        } else if (type.compare("CorrelatedGaussianParameters") == 0) {
            
            CorrelatedGaussianParameters tmpCGP;
            lineNo = tmpCGP.ParseCGP(ModelPars, filename, ifile, beg, lineNo, rank);
            IsEOF = tmpCGP.isEOF();
            CGP.push_back(tmpCGP);
 
        } else if (type.compare("Observable") == 0 || type.compare("BinnedObservable") == 0 || type.compare("FunctionObservable") == 0 || type.compare("AsyGausObservable") == 0) {
            
            Observable * tmpObs = new Observable();
            beg = tmpObs->ParseObservable(type, tok, beg, filepath, filename, rank);
            tmpObs->setTho(myObsFactory.CreateThMethod(tmpObs->getThname(), *myModel));
            Observables.push_back(tmpObs);
 
        } else if (type.compare("Observable2D") == 0) {
            
            Observable2D tmpObs2D;
            lineNo = tmpObs2D.ParseObservable2D(type, tok, beg, filename, ifile, lineNo, rank);
            tmpObs2D.setTho1Tho2(myObsFactory.CreateThMethod(tmpObs2D.getThname(), *myModel), myObsFactory.CreateThMethod(tmpObs2D.getThname2(), *myModel));
            if (!IsEOF) IsEOF = tmpObs2D.isEOF();
            Observables2D.push_back(tmpObs2D);
 
        } else if (type.compare("HiggsObservable") == 0) {
            
            Observable * tmphObs = new Observable();
            beg = tmphObs->ParseObservable(type, tok, beg, filepath, filename, rank);
            tmphObs->setTho(myObsFactory.CreateThMethod(tmphObs->getThname(), *myModel));
            HiggsObservable * tmpho = new HiggsObservable(*tmphObs);
            beg = tmpho->ParseHiggsObservable(beg, myObsFactory, myModel, rank);
            Observables.push_back(tmpho);
            ++beg;
            if (beg != tok->end() && rank == 0) std::cout << "WARNING: unread information in HiggsObservable " << tmpho->getName() << std::endl;
 
        } else if (type.compare("CorrelatedHiggsObservables") == 0) {
            
            Observable * tmphObs = new Observable();
            beg = tmphObs->ParseObservable(type, tok, beg, filepath, filename, rank);
            tmphObs->setTho(myObsFactory.CreateThMethod(tmphObs->getThname(), *myModel));
            HiggsObservable * tmpho = new HiggsObservable(*tmphObs);
            tmpho->setIsCorrelated(true);
            beg = tmpho->ParseHiggsObservable(beg, myObsFactory, myModel, rank);
            Observables.push_back(tmpho);
            ++beg;
            if (beg != tok->end() && rank == 0) std::cout << "WARNING: unread information in HiggsObservable " << tmpho->getName() << std::endl;
 
        } else if (type.compare("CorrelatedGaussianObservables") == 0) {
            
            CorrelatedGaussianObservables tmpCGO;
            lineNo = tmpCGO.ParseCGO(Observables, ifile, beg, filename, myObsFactory, myModel, lineNo, rank);
            IsEOF = tmpCGO.isEOF();
            if (tmpCGO.getObs().size() > 1) CGO.push_back(tmpCGO);
            
        } else if (type.compare("ObservablesWithCovarianceInverse") == 0) {
            
            CorrelatedGaussianObservables tmpCGO;
            tmpCGO.setCovarianceFromConfig(true);
            lineNo = tmpCGO.ParseCGO(Observables, ifile, beg, filename, myObsFactory, myModel, lineNo, rank);
            IsEOF = tmpCGO.isEOF();
            if (tmpCGO.getObs().size() > 1) CGO.push_back(tmpCGO);    
 
        } else if (type.compare("CorrelatedObservables") == 0) {
            
            CorrelatedGaussianObservables tmpCO;
            tmpCO.setIsPrediction(true);
            lineNo = tmpCO.ParseCGO(Observables, ifile, beg, filename, myObsFactory, myModel, lineNo, rank);
            IsEOF = tmpCO.isEOF();
            CGO.push_back(tmpCO);
 
        } else if (type.compare("CustomObservable") == 0) {
            
            if (std::distance(tok->begin(), tok->end()) < 2) {
                if (rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + filename + ".\n");
            else sleep(2);
            }
            std::string customObsName = *beg;
            beg++;
            if (customObservableTypeMap.find(customObsName) == customObservableTypeMap.end()) {
                if (rank == 0) throw std::runtime_error("\nERROR: No Observable Type defined for " + customObsName + "\n");
                else sleep(2);
            }
            Observable * tmpcustomObs = CreateObservableType(customObsName);
            tmpcustomObs->setObsType(customObsName);
            beg = tmpcustomObs->ParseObservable(type, tok, beg, filepath, filename, rank);
            tmpcustomObs->setTho(myObsFactory.CreateThMethod(tmpcustomObs->getThname(), *myModel));
            Observables.push_back(tmpcustomObs);
 
        } else if (type.compare("ModelFlag") == 0) {
            if (std::distance(tok->begin(), tok->end()) < 3) {
                if(rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + filename);
                else sleep (2);
            }
            std::string flagname = *beg;
            ++beg;
            if (boost::iequals(*beg, "true") || boost::iequals(*beg, "false")) {
                /* Boolean flags */
                bool value_bool;
                if (boost::iequals(*beg, "true"))
                    value_bool = 1;
                else
                    value_bool = 0;
                if (!myModel->setFlag(flagname, value_bool)) {
                    if(rank == 0) throw std::runtime_error("ERROR: setFlag error for " + flagname);
                    else sleep (2);
                }
                else if (rank == 0) std::cout << "set flag " << flagname << "=" << *beg << std::endl;
            } else {
                /* String flags */
                std::string value_str = *beg;
                if (!myModel->setFlagStr(flagname, value_str)) {
                    if(rank == 0) throw std::runtime_error("ERROR: setFlag error for " + flagname);
                    else sleep (2);
                } else if (rank == 0) std::cout << "set flag " << flagname << "=" << value_str << std::endl;
            }
            ++beg;
            if (beg != tok->end() && rank == 0) std::cout << "WARNING: unread information in Flag " << flagname << std::endl;
        } else if (type.compare("IncludeFile") == 0) {
            std::string oldfilepath = filepath;
            std::string oldfilename = filename;
            int oldlineNo = lineNo;
            std::string IncludeFileName = filepath + *beg;
            if (rank == 0) std::cout << "Including File: " + IncludeFileName << std::endl;
            ReadParameters(IncludeFileName, rank, ModelPars, Observables, Observables2D, CGO, CGP);
            filepath = oldfilepath;
            filename = oldfilename;
            lineNo = oldlineNo;
            IsEOF = false;
            ++beg;
        } else {
            if (rank == 0) throw std::runtime_error("\nERROR: wrong keyword " + type + " in file " + filename + " line no. " + boost::lexical_cast<std::string>(lineNo) + ". Make sure to specify a valid model configuration file.\n");
            else sleep(2);
        }
        delete tok;
        tok = NULL;
    } while (!IsEOF);
 
    if (modelset == 0 && rank == 0)
        throw std::runtime_error("ERROR: Incorrect or missing model name in the model configuration file.\n");
    if (!myModel->CheckFlags() && rank == 0)
        throw std::runtime_error("ERROR: incompatible flag(s)\n");
    delete sep;
    sep = NULL;
    return (modname);
}

setModel()

void InputParser::setModel ( StandardModel *  myModel_i )

inline

Definition at line 127 of file InputParser.h.

                                           {
        myModel = myModel_i;
    }

Member Data Documentation

checkDuplicateParameter

std::map<std::string, boost::tuple<bool, std::string, int> > InputParser::checkDuplicateParameter

private

Definition at line 137 of file InputParser.h.

customObservableTypeMap

std::map<std::string, boost::function<Observable* ()> > InputParser::customObservableTypeMap

private

Definition at line 140 of file InputParser.h.

filename

std::string InputParser::filename

private

Definition at line 143 of file InputParser.h.

filepath

std::string InputParser::filepath

private

Definition at line 145 of file InputParser.h.

IsEOF

bool InputParser::IsEOF

private

Definition at line 147 of file InputParser.h.

line

std::string InputParser::line

private

Definition at line 146 of file InputParser.h.

lineNo

int InputParser::lineNo

private

Definition at line 142 of file InputParser.h.

modeldefinedinfile

std::string InputParser::modeldefinedinfile

private

Definition at line 138 of file InputParser.h.

modelset

bool InputParser::modelset

private

Definition at line 136 of file InputParser.h.

modname

std::string InputParser::modname

private

A string to store the model name in.

Definition at line 135 of file InputParser.h.

myModel

StandardModel* InputParser::myModel

private

Pointer to an object of type StandardModel.

Definition at line 132 of file InputParser.h.

myModelFactory

ModelFactory& InputParser::myModelFactory

private

Pointer to an object of type ModelFactory.

Definition at line 133 of file InputParser.h.

myObsFactory

ThObsFactory& InputParser::myObsFactory

private

Reference to an object of type ThObsFactory.

Definition at line 134 of file InputParser.h.

rank

int InputParser::rank

private

Definition at line 144 of file InputParser.h.

---

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

• InputParser.h
• InputParser.cpp