NeutrinoFluxReweight::ParameterTable Class Reference

A list/table of parameter names and values. More...

#include <ParameterTable.h>

Public Member Functions
	ParameterTable ()
void	setParameter (Parameter p)
	add a parameter to the table or, if already there, reset its value More...
Parameter	getParameter (const std::string &name) const
	get a parameter by name. throw an exception of a well defined type if we don't have it More...
double	getParameterValue (const std::string &name) const
	get the value of a parameter. throw an exception of a well defined type if we don't have it More...
bool	hasParameter (const std::string &name) const
	is the named parameter in the table? More...
const boost::interprocess::flat_map< std::string, double > &	getMap () const

Protected Member Functions
void	mapify () const
	Move the parameters from the vector to the map. More...

Protected Attributes
boost::interprocess::flat_map< std::string, double >	table
std::vector< std::pair< std::string, double > >	m_vector
bool	m_vectorMode

Detailed Description

A list/table of parameter names and values.

The memory overhead of std::map turns out to be large for our case, so we use a boost::flat_map instead. This uses an ordered vector, so memory overhead is small. Insertion is slow, though, so we start out by putting all our parameters in a vector. At the first request for parameter or the entire map, we sort the vector, copy it into the map and free the vector. This is efficient when there is a "filling" phase when no reads are done, and a "reading" phase, when no more fills are done.

Definition at line 30 of file ParameterTable.h.

Constructor & Destructor Documentation

NeutrinoFluxReweight::ParameterTable::ParameterTable ( )

inline

Definition at line 32 of file ParameterTable.h.

      : m_vectorMode(true)
      {}

Member Function Documentation

const boost::interprocess::flat_map<std::string, double>& NeutrinoFluxReweight::ParameterTable::getMap ( ) const

inline

Definition at line 45 of file ParameterTable.h.

{ mapify(); return table; }

Parameter NeutrinoFluxReweight::ParameterTable::getParameter

(

const std::string &

name

)

const

get a parameter by name. throw an exception of a well defined type if we don't have it

Definition at line 17 of file ParameterTable.cpp.

                                                                    {
    mapify();
    Parameter pOut;
    boost::interprocess::flat_map<std::string, double>::const_iterator it=table.find(name);
    
    if(it!=table.end()){
      pOut.first  = name;
      pOut.second = it->second;
    }
    else{
      throw NoParameterFound(name);
    }
    return pOut;
    
  }

double NeutrinoFluxReweight::ParameterTable::getParameterValue

(

const std::string &

name

)

const

get the value of a parameter. throw an exception of a well defined type if we don't have it

Definition at line 33 of file ParameterTable.cpp.

                                                                      {
    mapify();

    double val;
    boost::interprocess::flat_map<std::string, double>::const_iterator it=table.find(name);
    
    if(it!=table.end()){
      val = it->second;
    }
    else{
      throw NoParameterFound(name);
    }
    
    return val;
    
  }

bool NeutrinoFluxReweight::ParameterTable::hasParameter

(

const std::string &

name

)

const

is the named parameter in the table?

Definition at line 50 of file ParameterTable.cpp.

                                                               {
    mapify();
    return table.find(name)!=table.end();
  }  

void NeutrinoFluxReweight::ParameterTable::mapify ( ) const

protected

Move the parameters from the vector to the map.

Definition at line 55 of file ParameterTable.cpp.

  {
    // If we're already out of vector mode, there's nothing to do
    if(!m_vectorMode) return;

    // Sort the vector, populate the flat_map from it, and then clear
    // the vector
    std::sort(m_vector.begin(), m_vector.end());
    table=boost::interprocess::flat_map<std::string, double>(m_vector.begin(), m_vector.end());
    m_vector.clear();
    // Magic to force the memory to be released: clear() doesn't do that
    std::vector<std::pair<std::string, double> >().swap(m_vector);
    // We're no longer in vector mode, so we won't run this function
    // again
    m_vectorMode=false;
  }

void NeutrinoFluxReweight::ParameterTable::setParameter

(

Parameter

p

)

add a parameter to the table or, if already there, reset its value

Definition at line 8 of file ParameterTable.cpp.

                                              {
    if(m_vectorMode){
      m_vector.push_back(p);
    }
    else{
      table[p.first] = p.second;
    }
  }

Member Data Documentation

std::vector<std::pair<std::string, double> > NeutrinoFluxReweight::ParameterTable::m_vector

mutableprotected

Definition at line 51 of file ParameterTable.h.

bool NeutrinoFluxReweight::ParameterTable::m_vectorMode

mutableprotected

Definition at line 52 of file ParameterTable.h.

boost::interprocess::flat_map<std::string, double> NeutrinoFluxReweight::ParameterTable::table

mutableprotected

Definition at line 50 of file ParameterTable.h.

---

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

• ppfx/include/ParameterTable.h
• ppfx/src/ParameterTable.cpp