Utopia::Models::Environment::ParameterFunctionCollection Namespace Reference

Typedefs
using	Config = DataIO::Config
	Configuration node type alias.

Functions
template<typename EnvModel , class DistType , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	build_rng_env_param_func (const EnvModel &model, DistType &&dist, const std::string &param_name, const ValMode &mode)
	Create a rule function that uses a random number distribution.
template<typename EnvModel , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	epf_increment (const EnvModel &model, const std::string param_name, const Config &cfg)
	Creates a rule function for incrementing parameter values.
template<typename EnvModel , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	epf_random (const EnvModel &model, const std::string &param_name, const Config &cfg)
	Creates a rule function for random parameter values.
template<typename EnvModel , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	epf_rectangular (const EnvModel &model, const Config &cfg)
	Creates a rule function for rectangular function like parameter values.
template<typename EnvModel , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	epf_set (const EnvModel &, const Config &cfg)
	Creates a rule function for setting a parameter value.
template<typename EnvModel , class EnvParamFunc = typename EnvModel::EnvParamFunc>
EnvParamFunc	epf_sinusoidal (const EnvModel &model, const Config &cfg)
	Creates a rule function for sinusoidal parameter values.

Typedef Documentation

Config

using Utopia::Models::Environment::ParameterFunctionCollection::Config = typedef DataIO::Config

Configuration node type alias.

Function Documentation

build_rng_env_param_func()

template<typename EnvModel , class DistType , class EnvParamFunc = typename EnvModel::EnvParamFunc>

EnvParamFunc Utopia::Models::Environment::ParameterFunctionCollection::build_rng_env_param_func	(	const EnvModel &	model,
		DistType &&	dist,
		const std::string &	param_name,
		const ValMode &	mode
	)

Create a rule function that uses a random number distribution.

This constructs a mutable EnvParamFunc lambda, moving the dist into the capture.

{
    // NOTE It is VITAL to move-construct the perfectly-forwarded dist into
    //      the lambda; otherwise it has to be stored outside, which is a
    //      real pita. Also, the lambda has to be declared mutable such
    //      that the captured object are allowed to be changed; again, this
    //      is only relevant for the distribution's internal state ...
    return
        [&model, param_name, mode, dist{std::move(dist)}] () mutable {
            double current_value = 0.;
            if (mode == ValMode::Add) {
                current_value = model.get_parameter(param_name);
            }
            const double rn = dist(*model.get_rng());
 
            return current_value + rn;
        };
}