EstimatorSet Class Reference

Collects multiple Estimator objects. More...

#include <Estimator.hpp>

Public Member Functions
	EstimatorSet (const pugi::xml_node &estimators_node, const World &world, const PerturbationSet &perturbations, const Real total_weight)
	Constructs an EstimatorSet from an XML document. More...
	EstimatorSet (const EstimatorSet &other) noexcept
	Copy constructor; deep copies each Estimator in other.
EstimatorSetProxy	GetProxy () const noexcept
	Return an EstimatorSet::Proxy.
const Estimator &	FindEstimatorByName (const std::string &name) const
	Return a reference to Estimator by name. More...
std::string	to_string () const noexcept
	Returns a string suitable for printing.
EstimatorSet &	operator+= (const EstimatorSet &other)
	Add scores from each Estimator of other to this. More...

Detailed Description

Collects multiple Estimator objects.

Constructor & Destructor Documentation

EstimatorSet()

EstimatorSet::EstimatorSet	(	const pugi::xml_node &	estimators_node,
		const World &	world,
		const PerturbationSet &	perturbations,
		const Real	total_weight
	)

Constructs an EstimatorSet from an XML document.

Parameters

estimators_node	estimators node of an XML document
world	Used to reference CSGSurface or Cell objects for estimators
perturbations	Used to associate Estimator objects which have a sensitivities node with a Perturbation
total_weight	Used for normalizing Estimator scores

Member Function Documentation

FindEstimatorByName()

const Estimator & EstimatorSet::FindEstimatorByName

(

const std::string &

name

)

const

Return a reference to Estimator by name.

Todo:

Template along with PerturbationSet::FindPerturbationByName

operator+=()

EstimatorSet & EstimatorSet::operator+=

(

const EstimatorSet &

other

)

Add scores from each Estimator of other to this.

Exceptions

An	Estimator in this EstimatorSet was not found in the other EstimatorSet

---

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

• /Users/atumulak/Developer/minimc/src/Estimator.hpp