ParameterPool Class Reference

Inheritance diagram for ParameterPool:

Collaboration diagram for ParameterPool:

Public Member Functions
	ParameterPool ()
virtual	~ParameterPool ()
ParameterPool *	clone () const
void	copyToExternalPool (const std::string &prefix, ParameterPool *other_pool) const
void	clear ()
size_t	size () const
bool	empty () const
RealParameter &	addParameter (RealParameter *newPar)
RealParameter *	parameter (const std::string &name)
const RealParameter *	parameter (const std::string &name) const
const std::vector< RealParameter * >	parameters () const
std::vector< RealParameter * >	getMatchedParameters (const std::string &pattern) const
RealParameter *	getUniqueMatch (const std::string &pattern) const
void	setParameterValue (const std::string &name, double value)
int	setMatchedParametersValue (const std::string &wildcards, double value)
void	setUniqueMatchValue (const std::string &pattern, double value)
std::vector< std::string >	parameterNames () const
void	removeParameter (const std::string &name)
const RealParameter *	operator[] (size_t index) const
RealParameter *	operator[] (size_t index)
virtual void	transferToCPP ()

Private Member Functions
virtual void	print (std::ostream &ostr) const
void	report_find_matched_parameters_error (const std::string &pattern) const
void	report_set_value_error (const std::string &parname, double value, std::string message={}) const
size_t	check_index (size_t index) const

Private Attributes
std::vector< RealParameter * >	m_params

Friends
std::ostream &	operator<< (std::ostream &ostr, const ParameterPool &obj)

Detailed Description

Container with parameters for IParameterized object.

Definition at line 29 of file ParameterPool.h.

Constructor & Destructor Documentation

ParameterPool()

ParameterPool::ParameterPool ( )

default

Constructs an empty parameter pool.

Referenced by clone().

~ParameterPool()

ParameterPool::~ParameterPool ( )

virtual

Definition at line 29 of file ParameterPool.cpp.

{
    clear();
}

References clear().

Here is the call graph for this function:

Member Function Documentation

clone()

ParameterPool * ParameterPool::clone ( ) const

virtual

Returns a literal clone.

Implements ICloneable.

Definition at line 36 of file ParameterPool.cpp.

{
    auto result = new ParameterPool();
    for (auto par : m_params)
        result->addParameter(par->clone());
    return result;
}

References m_params, and ParameterPool().

Here is the call graph for this function:

copyToExternalPool()

void ParameterPool::copyToExternalPool	(	const std::string &	prefix,
		ParameterPool *	other_pool
	)		const

Copies parameters of given pool to other pool, prepeding prefix to the parameter names.

Definition at line 72 of file ParameterPool.cpp.

{
    for (const auto* par : m_params) {
        RealParameter* new_par = par->clone(prefix + par->getName());
        other_pool->addParameter(new_par);
    }
}

References addParameter(), RealParameter::clone(), and m_params.

Referenced by INode::createParameterTree().

Here is the call graph for this function:

clear()

void ParameterPool::clear

(

)

Clears the parameter map.

Definition at line 46 of file ParameterPool.cpp.

{
    for (auto* par : m_params)
        delete par;
    m_params.clear();
}

References m_params.

Referenced by SampleBuilderNode::borrow_builder_parameters(), INode::INode(), SampleBuilderNode::reset(), and ~ParameterPool().

size()

size_t ParameterPool::size ( ) const

inline

Returns number of parameters in the pool.

Definition at line 42 of file ParameterPool.h.

{ return m_params.size(); }

References m_params.

Referenced by empty().

empty()

bool ParameterPool::empty ( ) const

inline

Definition at line 43 of file ParameterPool.h.

{ return size() == 0; }

References size().

Referenced by IParameterized::IParameterized().

Here is the call graph for this function:

addParameter()

RealParameter & ParameterPool::addParameter

(

RealParameter *

newPar

)

Adds parameter to the pool, and returns reference to the input pointer.

Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit("nm")

Definition at line 58 of file ParameterPool.cpp.

{
    for (const auto* par : m_params)
        if (par->getName() == newPar->getName())
            throw Exceptions::RuntimeErrorException("ParameterPool::addParameter() -> Error. "
                                                    "Parameter '"
                                                    + newPar->getName()
                                                    + "' is already registered");
    m_params.push_back(newPar);
    return *newPar;
}

References IParameter< T >::getName(), and m_params.

Referenced by copyToExternalPool().

Here is the call graph for this function:

parameter() [1/2]

RealParameter * ParameterPool::parameter

(

const std::string &

name

)

Returns parameter with given name.

Definition at line 93 of file ParameterPool.cpp.

{
    return const_cast<RealParameter*>(static_cast<const ParameterPool*>(this)->parameter(name));
}

Referenced by removeParameter(), report_set_value_error(), and setParameterValue().

parameter() [2/2]

const RealParameter * ParameterPool::parameter

(

const std::string &

name

)

const

Returns parameter with given name.

Definition at line 82 of file ParameterPool.cpp.

{
    for (const auto* par : m_params)
        if (par->getName() == name)
            return par;
 
    return nullptr;
}

References m_params.

parameters()

const std::vector<RealParameter*> ParameterPool::parameters ( ) const

inline

Returns full vector of parameters.

Definition at line 52 of file ParameterPool.h.

{ return m_params; }

References m_params.

Referenced by pyfmt2::argumentList(), and anonymous_namespace{NodeUtils.cpp}::poolToString().

getMatchedParameters()

std::vector< RealParameter * > ParameterPool::getMatchedParameters

(

const std::string &

pattern

)

const

Returns nonempty vector of parameters that match the pattern ('*' allowed), or throws.

Definition at line 100 of file ParameterPool.cpp.

{
    std::vector<RealParameter*> result;
    // loop over all parameters in the pool
    for (auto* par : m_params)
        if (StringUtils::matchesPattern(par->getName(), pattern))
            result.push_back(par);
    if (result.empty())
        report_find_matched_parameters_error(pattern);
    return result;
}

References m_params, StringUtils::matchesPattern(), and report_find_matched_parameters_error().

Referenced by getUniqueMatch(), and setMatchedParametersValue().

Here is the call graph for this function:

getUniqueMatch()

RealParameter * ParameterPool::getUniqueMatch

(

const std::string &

pattern

)

const

Returns the one parameter that matches the pattern (wildcards '*' allowed), or throws.

Definition at line 114 of file ParameterPool.cpp.

{
    std::vector<RealParameter*> matches = getMatchedParameters(pattern);
    if (matches.empty())
        throw Exceptions::RuntimeErrorException(
            "ParameterPool::getUniqueMatch: there is no match for '" + pattern + "'");
    if (matches.size() != 1)
        throw Exceptions::RuntimeErrorException("ParameterPool::getUniqueMatch: pattern '" + pattern
                                                + "' is not unique");
    return matches[0];
}

References getMatchedParameters().

Referenced by ParameterUtils::poolParameterUnits().

Here is the call graph for this function:

setParameterValue()

void ParameterPool::setParameterValue	(	const std::string &	name,
		double	value
	)

Sets parameter value.

Definition at line 128 of file ParameterPool.cpp.

{
    if (RealParameter* par = parameter(name)) {
        try {
            par->setValue(value);
        } catch (const std::runtime_error& e) {
            report_set_value_error(name, value, e.what());
        }
    } else {
        std::ostringstream message;
        message << "ParameterPool::getParameter() -> Warning. No parameter with name '" + name
                       + "'\n"
                << "Available parameters:" << *this;
        throw Exceptions::RuntimeErrorException(message.str());
    }
}

References parameter(), and report_set_value_error().

Here is the call graph for this function:

setMatchedParametersValue()

int ParameterPool::setMatchedParametersValue	(	const std::string &	wildcards,
		double	value
	)

Sets value of the nonzero parameters that match pattern ('*' allowed), or throws.

Definition at line 147 of file ParameterPool.cpp.

{
    int npars = 0;
    for (RealParameter* par : getMatchedParameters(pattern)) {
        try {
            par->setValue(value);
            npars++;
        } catch (const std::runtime_error& e) {
            report_set_value_error(par->getName(), value, e.what());
        }
    }
    if (npars == 0)
        report_find_matched_parameters_error(pattern);
    return npars;
}

References getMatchedParameters(), report_find_matched_parameters_error(), and report_set_value_error().

Referenced by DistributionHandler::setParameterToMeans(), IParameterized::setParameterValue(), DistributionHandler::setParameterValues(), and setUniqueMatchValue().

Here is the call graph for this function:

setUniqueMatchValue()

void ParameterPool::setUniqueMatchValue	(	const std::string &	pattern,
		double	value
	)

Sets value of the one parameter that matches pattern ('*' allowed), or throws.

Definition at line 165 of file ParameterPool.cpp.

{
    if (setMatchedParametersValue(pattern, value) != 1)
        throw Exceptions::RuntimeErrorException("ParameterPool::setUniqueMatchValue: pattern '"
                                                + pattern + "' is not unique");
}

References setMatchedParametersValue().

Referenced by ParticleDistribution::generateParticles().

Here is the call graph for this function:

parameterNames()

std::vector< std::string > ParameterPool::parameterNames

(

)

const

Definition at line 172 of file ParameterPool.cpp.

{
    std::vector<std::string> result;
    for (const auto* par : m_params)
        result.push_back(par->getName());
    return result;
}

References m_params.

removeParameter()

void ParameterPool::removeParameter

(

const std::string &

name

)

Removes parameter with given name from the pool.

Definition at line 182 of file ParameterPool.cpp.

{
    if (RealParameter* par = parameter(name)) {
        m_params.erase(std::remove(m_params.begin(), m_params.end(), par), m_params.end());
        delete par;
    }
}

References m_params, and parameter().

Here is the call graph for this function:

operator[]() [1/2]

const RealParameter * ParameterPool::operator[]

(

size_t

index

)

const

Definition at line 190 of file ParameterPool.cpp.

{
    return m_params[check_index(index)];
}

References check_index(), and m_params.

Here is the call graph for this function:

operator[]() [2/2]

RealParameter * ParameterPool::operator[]

(

size_t

index

)

Definition at line 195 of file ParameterPool.cpp.

{
    return const_cast<RealParameter*>(static_cast<const ParameterPool*>(this)->operator[](index));
}

print()

void ParameterPool::print ( std::ostream &  ostr ) const

privatevirtual

Definition at line 200 of file ParameterPool.cpp.

{
    for (const auto* par : m_params)
        ostr << "'" << par->getName() << "'"
             << ":" << par->value() << "\n";
}

References m_params.

report_find_matched_parameters_error()

void ParameterPool::report_find_matched_parameters_error ( const std::string &  pattern ) const

private

reports error while finding parameters matching given name.

Definition at line 208 of file ParameterPool.cpp.

{
    std::ostringstream ostr;
    ostr << "ParameterPool::find_matched_parameters_error() -> Error! ";
    ostr << "No parameters matching  pattern '" << pattern
         << "' have been found. Existing keys are:" << std::endl;
    for (const auto* par : m_params)
        ostr << "'" << par->getName() << "'\n";
    throw Exceptions::RuntimeErrorException(ostr.str());
}

References m_params.

Referenced by getMatchedParameters(), and setMatchedParametersValue().

report_set_value_error()

void ParameterPool::report_set_value_error ( const std::string &  parname, double  value, std::string  message = {}  ) const

private

Reports error while setting parname to given value.

Definition at line 220 of file ParameterPool.cpp.

{
    std::ostringstream ostr;
    ostr << "ParameterPool::set_value_error() -> Attempt to set value " << value;
    ostr << " for parameter '" << parname << "' failed.";
    ostr << " Parameter limits: '" << parameter(parname)->limits() << "'.\n";
    ostr << "Original exception message: " << message << std::endl;
    throw Exceptions::RuntimeErrorException(ostr.str());
}

References RealParameter::limits(), and parameter().

Referenced by setMatchedParametersValue(), and setParameterValue().

Here is the call graph for this function:

check_index()

size_t ParameterPool::check_index ( size_t  index ) const

private

Definition at line 231 of file ParameterPool.cpp.

{
    if (index >= m_params.size())
        throw std::runtime_error("ParameterPool::check_index() -> Error. Index out of bounds");
    return index;
}

References m_params.

Referenced by operator[]().

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  ostr, const ParameterPool &  obj  )

friend

Definition at line 64 of file ParameterPool.h.

    {
        obj.print(ostr);
        return ostr;
    }

Member Data Documentation

m_params

std::vector<RealParameter*> ParameterPool::m_params

private

Definition at line 84 of file ParameterPool.h.

Referenced by addParameter(), check_index(), clear(), clone(), copyToExternalPool(), getMatchedParameters(), operator[](), parameter(), parameterNames(), parameters(), print(), removeParameter(), report_find_matched_parameters_error(), and size().

---

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

• /home/www/ba/Param/Base/ParameterPool.h
• /home/www/ba/Param/Base/ParameterPool.cpp