PerturbationSet Class Reference

Aggregates perturbations whose effect on one or more Estimator objects is to be estimated. More...

#include <Perturbation.hpp>

Public Member Functions
	PerturbationSet (const pugi::xml_node &perturbations_node, const World &world) noexcept
	Constructs a PerturbationSet from a perturbations node of an XML document.
const Perturbation &	FindPerturbationByName (const std::string &name) const
	Returns the Perturbation with the given name. More...
std::map< const Perturbation *, Real >	GetIndirectEffects () const noexcept
	Returns a map of indirect effects for use by a Particle. More...

Detailed Description

Aggregates perturbations whose effect on one or more Estimator objects is to be estimated.

Member Function Documentation

FindPerturbationByName()

const Perturbation & PerturbationSet::FindPerturbationByName

(

const std::string &

name

)

const

Returns the Perturbation with the given name.

Exceptions

std::runtime_error

Perturbation with given name not found

Todo:

Template along with EstimatorSet::FindEstimatorByName

GetIndirectEffects()

std::map< const Perturbation *, Real > PerturbationSet::GetIndirectEffects ( ) const

noexcept

Returns a map of indirect effects for use by a Particle.

Note

Raw pointers are used since a PerturbationSet should outlive any Particle instance. Particles are frequently constructed and destructed so a std::shared_ptr would update the control block quite frequently.

---

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

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