DistributionHandler Class Reference

Description

Provides the functionality to average over parameter distributions with weights.

Definition at line 29 of file DistributionHandler.h.

Collaboration diagram for DistributionHandler:

Public Member Functions
	DistributionHandler ()
virtual	~DistributionHandler ()
void	addParameterDistribution (const ParameterDistribution &par_distr)
void	addParameterDistribution (const std::string &param_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
	add a sampled parameter distribution More...
void	defineCallbackForDistribution (const ParameterDistribution *distribution, std::function< void(double)> fn)
const std::vector< ParameterDistribution > &	getDistributions () const
size_t	getTotalNumberOfSamples () const
	get the total number of parameter value combinations (product of the individual sizes of each parameter distribution More...
double	setParameterValues (size_t index)
	set the parameter values of the simulation object to a specific combination of values, determined by the index (which must be smaller than the total number of combinations) and returns the weight associated with this combination of parameter values. initParameterLinks() has to be called before this! More...

Private Attributes
std::vector< std::vector< ParameterSample > >	m_cached_samples
std::vector< ParameterDistribution >	m_distributions
size_t	m_nbr_combinations
std::map< const ParameterDistribution *, std::function< void(double)> >	m_setValueFunctions

Constructor & Destructor Documentation

DistributionHandler()

DistributionHandler::DistributionHandler

(

)

Definition at line 19 of file DistributionHandler.cpp.

    : m_nbr_combinations(1)
{
}

~DistributionHandler()

DistributionHandler::~DistributionHandler ( )

virtualdefault

Member Function Documentation

addParameterDistribution() [1/2]

void DistributionHandler::addParameterDistribution

(

const ParameterDistribution &

par_distr

)

Definition at line 26 of file DistributionHandler.cpp.

{
    if (par_distr.nDraws() > 0) {
        m_distributions.push_back(par_distr);
        m_nbr_combinations *= par_distr.nDraws();
        m_cached_samples.push_back(par_distr.generateSamples());
    }
}

References ParameterDistribution::generateSamples(), m_cached_samples, m_distributions, m_nbr_combinations, and ParameterDistribution::nDraws().

Here is the call graph for this function:

addParameterDistribution() [2/2]

void DistributionHandler::addParameterDistribution	(	const std::string &	param_name,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	sigma_factor = 0.0,
		const RealLimits &	limits = RealLimits()
	)

add a sampled parameter distribution

Referenced by ISimulation::addParameterDistribution().

defineCallbackForDistribution()

void DistributionHandler::defineCallbackForDistribution	(	const ParameterDistribution *	distribution,
		std::function< void(double)>	fn
	)

Definition at line 69 of file DistributionHandler.cpp.

{
    m_setValueFunctions[distribution] = fn;
}

References m_setValueFunctions.

Referenced by ISimulation2D::initDistributionHandler().

getDistributions()

const std::vector< ParameterDistribution > & DistributionHandler::getDistributions

(

)

const

Definition at line 64 of file DistributionHandler.cpp.

{
    return m_distributions;
}

References m_distributions.

Referenced by ISimulation::getDistributions(), and ISimulation2D::initDistributionHandler().

getTotalNumberOfSamples()

size_t DistributionHandler::getTotalNumberOfSamples

(

)

const

get the total number of parameter value combinations (product of the individual sizes of each parameter distribution

Definition at line 35 of file DistributionHandler.cpp.

{
    return m_nbr_combinations;
}

References m_nbr_combinations.

Referenced by ISimulation::simulate().

setParameterValues()

double DistributionHandler::setParameterValues

(

size_t

index

)

set the parameter values of the simulation object to a specific combination of values, determined by the index (which must be smaller than the total number of combinations) and returns the weight associated with this combination of parameter values. initParameterLinks() has to be called before this!

Definition at line 40 of file DistributionHandler.cpp.

{
    ASSERT(index < m_nbr_combinations);
 
    size_t n_distr = m_distributions.size();
    double weight = 1.0;
    if (n_distr == 0)
        return weight;
    for (size_t param_index = n_distr - 1;; --param_index) {
        const auto& distribution = m_distributions[param_index];
        size_t remainder = index % distribution.nDraws();
        index /= distribution.nDraws();
 
        // set the value in the ISimulation instance (via callback)
        ASSERT(m_setValueFunctions.count(&distribution) == 1);
        m_setValueFunctions[&distribution](m_cached_samples[param_index][remainder].value);
 
        weight *= m_cached_samples[param_index][remainder].weight;
        if (param_index == 0)
            break;
    }
    return weight;
}

References ASSERT, m_cached_samples, m_distributions, m_nbr_combinations, and m_setValueFunctions.

Referenced by ISimulation::simulate().

Member Data Documentation

m_cached_samples

std::vector<std::vector<ParameterSample> > DistributionHandler::m_cached_samples

private

Definition at line 62 of file DistributionHandler.h.

Referenced by addParameterDistribution(), and setParameterValues().

m_distributions

std::vector<ParameterDistribution> DistributionHandler::m_distributions

private

Definition at line 60 of file DistributionHandler.h.

Referenced by addParameterDistribution(), getDistributions(), and setParameterValues().

m_nbr_combinations

size_t DistributionHandler::m_nbr_combinations

private

Definition at line 59 of file DistributionHandler.h.

Referenced by addParameterDistribution(), getTotalNumberOfSamples(), and setParameterValues().

m_setValueFunctions

std::map<const ParameterDistribution*, std::function<void(double)> > DistributionHandler::m_setValueFunctions

private

Definition at line 61 of file DistributionHandler.h.

Referenced by defineCallbackForDistribution(), and setParameterValues().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Param/Distrib/DistributionHandler.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Param/Distrib/DistributionHandler.cpp