MinimizerOptions Class Reference

Collection of internal minimizer settings. More...

Inheritance diagram for MinimizerOptions:

Collaboration diagram for MinimizerOptions:

Public Types
using	const_iterator = container_t::const_iterator
using	container_t = std::vector< option_t >
using	iterator = container_t::iterator
using	option_t = std::shared_ptr< MultiOption >

Public Member Functions
template<class T >
option_t	addOption (const std::string &optionName, T value, const std::string &description="")
iterator	begin ()
const_iterator	begin () const
bool	empty () const
iterator	end ()
const_iterator	end () const
option_t	option (const std::string &optionName)
const option_t	option (const std::string &optionName) const
template<class T >
T	optionValue (const std::string &optionName) const
void	setOptionString (const std::string &options)
	Set options from their string representation. More...
template<class T >
void	setOptionValue (const std::string &optionName, T value)
	Sets the value of option. Option should hold same value type already. More...
size_t	size () const
std::string	toOptionString () const
	Returns string with all options (i.e. "Strategy=1;Tolerance=0.01;") More...

Protected Member Functions
bool	exists (const std::string &name)
void	swapContent (OptionContainer &other)

Protected Attributes
container_t	m_options

Private Member Functions
void	processCommand (const std::string &command)
	Process single option string 'Tolerance=0.01' and sets the value to corresponding MultiOption. More...

Detailed Description

Collection of internal minimizer settings.

Definition at line 28 of file MinimizerOptions.h.

Member Typedef Documentation

const_iterator

using OptionContainer::const_iterator = container_t::const_iterator

inherited

Definition at line 37 of file OptionContainer.h.

container_t

using OptionContainer::container_t = std::vector<option_t>

inherited

Definition at line 35 of file OptionContainer.h.

iterator

using OptionContainer::iterator = container_t::iterator

inherited

Definition at line 36 of file OptionContainer.h.

option_t

using OptionContainer::option_t = std::shared_ptr<MultiOption>

inherited

Definition at line 34 of file OptionContainer.h.

Member Function Documentation

addOption()

template<class T >

OptionContainer::option_t OptionContainer::addOption ( const std::string &  optionName, T  value, const std::string &  description = ""  )

inherited

Definition at line 70 of file OptionContainer.h.

{
    if (exists(optionName))
        throw std::runtime_error("OptionContainer::addOption() -> Error. Option '" + optionName
                                 + "' exists.");
 
    option_t result(new MultiOption(optionName, value, description));
    m_options.push_back(result);
    return result;
}

References OptionContainer::exists(), and OptionContainer::m_options.

Referenced by MinimizerAdapter::addOption().

Here is the call graph for this function:

begin() [1/2]

iterator OptionContainer::begin ( )

inlineinherited

Definition at line 54 of file OptionContainer.h.

{ return m_options.begin(); }

References OptionContainer::m_options.

begin() [2/2]

const_iterator OptionContainer::begin ( ) const

inlineinherited

Definition at line 55 of file OptionContainer.h.

{ return m_options.begin(); }

References OptionContainer::m_options.

empty()

bool OptionContainer::empty ( ) const

inlineinherited

Definition at line 61 of file OptionContainer.h.

{ return size() == 0; }

References OptionContainer::size().

Here is the call graph for this function:

end() [1/2]

iterator OptionContainer::end ( )

inlineinherited

Definition at line 57 of file OptionContainer.h.

{ return m_options.end(); }

References OptionContainer::m_options.

end() [2/2]

const_iterator OptionContainer::end ( ) const

inlineinherited

Definition at line 58 of file OptionContainer.h.

{ return m_options.end(); }

References OptionContainer::m_options.

exists()

bool OptionContainer::exists ( const std::string &  name )

protectedinherited

Definition at line 56 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == name)
            return true;
    }
    return false;
}

References OptionContainer::m_options, RealSpace::Particles::name(), and OptionContainer::option().

Referenced by OptionContainer::addOption().

Here is the call graph for this function:

option() [1/2]

OptionContainer::option_t OptionContainer::option ( const std::string &  optionName )

inherited

Definition at line 34 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == optionName)
            return option;
    }
 
    throw std::runtime_error("Configurable::getOption() -> Error. No option with name '"
                             + optionName + "'.");
}

References OptionContainer::m_options.

Referenced by OptionContainer::OptionContainer(), OptionContainer::exists(), OptionContainer::option(), OptionContainer::optionValue(), processCommand(), OptionContainer::setOptionValue(), and toOptionString().

option() [2/2]

const OptionContainer::option_t OptionContainer::option ( const std::string &  optionName ) const

inherited

Definition at line 45 of file OptionContainer.cpp.

{
    for (const auto& option : m_options) {
        if (option->name() == optionName)
            return option;
    }
 
    throw std::runtime_error("Configurable::getOption() -> Error. No option with name '"
                             + optionName + "'.");
}

References OptionContainer::m_options, and OptionContainer::option().

Here is the call graph for this function:

optionValue()

template<class T >

T OptionContainer::optionValue ( const std::string &  optionName ) const

inherited

Definition at line 82 of file OptionContainer.h.

{
    return option(optionName)->get<T>();
}

References OptionContainer::option().

Referenced by MinimizerAdapter::optionValue().

Here is the call graph for this function:

processCommand()

void MinimizerOptions::processCommand ( const std::string &  command )

private

Process single option string 'Tolerance=0.01' and sets the value to corresponding MultiOption.

Definition at line 53 of file MinimizerOptions.cpp.

{
    std::vector<std::string> tokens = mumufit::stringUtils::split(command, "=");
    if (tokens.size() != 2)
        throw std::runtime_error("MinimizerOptions::processOption() -> Can't parse option '"
                                 + command + "'");
 
    std::string name = tokens[0];
    std::string value = tokens[1];
 
    OptionContainer::option_t opt = option(name);
    opt->setFromString(value);
}

References RealSpace::Particles::name(), OptionContainer::option(), and mumufit::stringUtils::split().

Referenced by setOptionString().

Here is the call graph for this function:

setOptionString()

void MinimizerOptions::setOptionString

(

const std::string &

options

)

Set options from their string representation.

Definition at line 34 of file MinimizerOptions.cpp.

{
    // splits multiple option string "Strategy=1;Tolerance=0.01;"
    std::vector<std::string> tokens = mumufit::stringUtils::split(options, delimeter);
    try {
        for (std::string opt : tokens)
            if (!opt.empty())
                processCommand(opt);
    } catch (std::exception& ex) {
        std::ostringstream ostr;
        ostr << "MinimizerOptions::setOptions() -> Error. Can't parse option string '" << options
             << "'.\n, error message '" << ex.what() << "'";
        throw std::runtime_error(ostr.str());
    }
}

References processCommand(), and mumufit::stringUtils::split().

Referenced by MinimizerAdapter::setOptions().

Here is the call graph for this function:

setOptionValue()

template<class T >

void OptionContainer::setOptionValue ( const std::string &  optionName, T  value  )

inherited

Sets the value of option. Option should hold same value type already.

Definition at line 87 of file OptionContainer.h.

{
    option(optionName)->value() = value;
    if (option(optionName)->value().which() != option(optionName)->defaultValue().which())
        throw std::runtime_error(
            "OptionContainer::setOptionValue() -> Error. Attempt to set different"
            "type to option '"
            + optionName + "'");
}

References OptionContainer::option().

Referenced by MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

size()

size_t OptionContainer::size ( ) const

inlineinherited

Definition at line 60 of file OptionContainer.h.

{ return m_options.size(); }

References OptionContainer::m_options.

Referenced by OptionContainer::empty().

swapContent()

void OptionContainer::swapContent ( OptionContainer &  other )

protectedinherited

Definition at line 65 of file OptionContainer.cpp.

{
    std::swap(m_options, other.m_options);
}

References OptionContainer::m_options, and swap().

Referenced by OptionContainer::operator=().

Here is the call graph for this function:

toOptionString()

std::string MinimizerOptions::toOptionString

(

)

const

Returns string with all options (i.e. "Strategy=1;Tolerance=0.01;")

Definition at line 25 of file MinimizerOptions.cpp.

{
    std::ostringstream result;
    for (auto option : m_options) {
        result << option->name() << "=" << option->value() << delimeter;
    }
    return result.str();
}

References OptionContainer::m_options, and OptionContainer::option().

Here is the call graph for this function:

Member Data Documentation

m_options

container_t OptionContainer::m_options

protectedinherited

Definition at line 66 of file OptionContainer.h.

Referenced by OptionContainer::OptionContainer(), OptionContainer::addOption(), OptionContainer::begin(), OptionContainer::end(), OptionContainer::exists(), OptionContainer::option(), OptionContainer::size(), OptionContainer::swapContent(), and toOptionString().

---

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

• /home/www/ba/Fit/Minimizer/MinimizerOptions.h
• /home/www/ba/Fit/Minimizer/MinimizerOptions.cpp