Loading...
Searching...
No Matches
CurrentEstimator Class Reference
Scores when a Particle crosses a given CSGSurface. More...
#include <Estimator.hpp>
Inheritance diagram for CurrentEstimator:
Collaboration diagram for CurrentEstimator:
Public Member Functions | |
| CurrentEstimator (const pugi::xml_node ¤t_estimator_node, const World &world, const PerturbationSet &perturbations) | |
Constructs a CurrentEstimator from a current node. | |
| CurrentEstimator (const CurrentEstimator &other) noexcept | |
| Copy constructor; deep copies each sensitivity Estimator in other. | |
| std::unique_ptr< Estimator > | Clone () const noexcept override |
| Returns a pointer to a new instance of CurrentEstimator. More... | |
| Real | GetScore (const Particle &p) const noexcept override |
| Implements Scorable method. More... | |
 Public Member Functions inherited from Estimator | |
| Estimator (const Estimator &other) noexcept | |
| Copy constructor. Deep copies Scores and each Sensitivity object. | |
| virtual | ~Estimator () noexcept |
| Virtual destructor (C++ Core Guidelines C.127) | |
| virtual std::unique_ptr< Estimator > | Clone () const noexcept=0 |
| Virtual constructor, used for deep copying an Estimator. More... | |
| std::string | to_string (const Real total_weight) const noexcept override |
| Returns a string suitable for printing. More... | |
| Estimator & | operator+= (const Estimator &other) noexcept |
| Add scores of other to this including any Sensitivity objects. | |
| Public Member Functions inherited from Scorable | |
| Scorable (const std::string &name, const pugi::xml_node &bins_node) noexcept | |
Constructs a Scorable from a bins node of an XML document. More... | |
| Scorable (const Scorable &estimator, const Perturbation &perturbation) noexcept | |
| Constructs an Scorable from an existing estimator and perturbation. More... | |
| virtual | ~Scorable () noexcept |
| Virtual destructor (C++ Core Guidelines C.127) | |
| virtual Real | GetScore (const Particle &p) const noexcept=0 |
| Returns what a Particle would score. More... | |
| virtual std::string | to_string (const Real total_weight) const noexcept=0 |
| Returns a string suitable for printing. More... | |
| Real | GetScore (const size_t index, const Real total_weight) const noexcept |
| Returns all scores; primarily for unit testing. | |
| Scorable & | operator+= (const Scorable &other) noexcept |
| Add scores of other to this. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Estimator | |
| static std::unique_ptr< Estimator > | Create (const pugi::xml_node &estimator_node, const World &world, const PerturbationSet &perturbations) |
| Factory method to create new Estimator from an estimator node of an XML document. | |
| Public Attributes inherited from Scorable | |
| const std::string | name |
| Unique, user-defined identifier (C++ Core Guidelines C.131) | |
| Protected Member Functions inherited from Estimator | |
| Estimator (const pugi::xml_node &estimator_node, const PerturbationSet &perturbations) noexcept | |
| Constructs an Estimator from an XML node. | |
| Protected Member Functions inherited from Scorable | |
| std::string | GetScoreAsString (const Real total_weight) const noexcept |
| Returns a string suitable for printing. More... | |
| Protected Attributes inherited from Scorable | |
| const std::shared_ptr< const ParticleBins > | bins |
| Used to map a Particle to a unique index. | |
| std::vector< Real > | scores |
| Flattened array of scores. | |
| std::vector< Real > | square_scores |
| Flattened array of square of scores. | |
Detailed Description
Scores when a Particle crosses a given CSGSurface.
Member Function Documentation
◆ Clone()
|
overridevirtualnoexcept |
Returns a pointer to a new instance of CurrentEstimator.
Implements Estimator.
◆ GetScore()
The documentation for this class was generated from the following file:
- /Users/atumulak/Developer/minimc/src/Estimator.hpp
