Utopia::Models::Environment::StateFunctionCollection Namespace Reference

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

Functions
template<typename EnvModel , class DistType , class EnvStateFunc = typename EnvModel::EnvStateFunc>
EnvStateFunc	build_rng_env_state_func (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 EnvStateFunc = typename EnvModel::EnvStateFunc>
std::pair< EnvStateFunc, Update >	esf_noise (const EnvModel &model, const std::string &param_name, const Config &cfg)
	Creates a rule function for noisy parameter values.
template<typename EnvModel , typename Extent , class EnvStateFunc = typename EnvModel::EnvStateFunc>
std::pair< EnvStateFunc, Update >	esf_slope (const EnvModel &, const std::string &param_name, const Config &cfg, const Extent &extent)
	Creates a rule function for spatially linearly parameter values.
template<typename EnvModel , class EnvStateFunc = typename EnvModel::EnvStateFunc>
std::pair< EnvStateFunc, Update >	esf_steps (const EnvModel &, const std::string &param_name, const Config &cfg)
	Creates a rule function for spatial steps in the parameter values.
template<typename EnvModel , class EnvStateFunc = typename EnvModel::EnvStateFunc>
std::pair< EnvStateFunc, Update >	esf_uniform (const EnvModel &, const std::string &param_name, const Config &cfg)
	Creates a rule function for spatially uniform parameter values.

Typedef Documentation

Config

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

Configuration node type alias.

Function Documentation

build_rng_env_state_func()

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

EnvStateFunc Utopia::Models::Environment::StateFunctionCollection::build_rng_env_state_func	(	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 EnvStateFunc 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)}]
        (const auto& env_cell) mutable {
            auto& env_state = env_cell->state;
 
            double current_value = 0.;
            if (mode == ValMode::Add) {
                current_value = env_state.get_env(param_name);
            }
            const double rn = dist(*model.get_rng());
 
            env_state.set_env(param_name, current_value + rn);
            return env_state;
        };
}