Loading...
Searching...
No Matches
CurrentTotalCrossSectionSensitivity Class Reference
Estimates the sensitivity of a CurrentEstimator with respect to a TotalCrossSectionPerturbation. More...
#include <Sensitivity.hpp>
Inheritance diagram for CurrentTotalCrossSectionSensitivity:
Collaboration diagram for CurrentTotalCrossSectionSensitivity:
Public Member Functions | |
| CurrentTotalCrossSectionSensitivity (const Estimator &estimator, const Perturbation &perturbation) noexcept | |
| Constructs a CurrentTotalCrossSectionSensitivity from an Estimator and Perturbation. | |
| std::unique_ptr< Sensitivity > | Clone () const noexcept override |
| Returns a pointer to a new instance of CurrentTotalCrossSectionSensitivity. More... | |
| Real | GetScore (const Particle &p) const noexcept override |
| Implements Scorable method. More... | |
 Public Member Functions inherited from Sensitivity | |
| virtual | ~Sensitivity () noexcept |
| Virtual destructor (C++ Core Guidelines C.127) | |
| virtual std::unique_ptr< Sensitivity > | Clone () const noexcept=0 |
| Virtual constructor, used for deep copying a Sensitivity. More... | |
| std::string | to_string (const Real total_weight) const noexcept |
| Returns a string suitable for printing. Does not return bins since the parent Estimator will print it. More... | |
| Sensitivity & | operator+= (const Sensitivity &other) noexcept |
| Add scores of other to this. | |
| 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 Sensitivity | |
| static std::unique_ptr< Sensitivity > | Create (const pugi::xml_node &sensitivity_perturbation_node, const PerturbationSet &perturbations, const Estimator &estimator) |
Factory method to create a new Sensitivity from a perturbation child of a sensitivities node of an XML document. More... | |
| Public Attributes inherited from Scorable | |
| const std::string | name |
| Unique, user-defined identifier (C++ Core Guidelines C.131) | |
| Protected Member Functions inherited from Sensitivity | |
| Sensitivity (const Estimator &estimator, const Perturbation &perturbation) noexcept | |
| Constructs a Sensitivity with given parent Estimator and Perturbation. | |
| 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 Sensitivity | |
| const Estimator & | estimator |
| Estimator whose sensitivity to a Perturbation is being estimated. | |
| const Perturbation & | perturbation |
| Perturbation whose effect on an Estimator is being estimated. | |
| 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
Estimates the sensitivity of a CurrentEstimator with respect to a TotalCrossSectionPerturbation.
Member Function Documentation
◆ Clone()
|
overridevirtualnoexcept |
Returns a pointer to a new instance of CurrentTotalCrossSectionSensitivity.
Implements Sensitivity.
◆ GetScore()
The documentation for this class was generated from the following file:
- /Users/atumulak/Developer/minimc/src/Sensitivity.hpp
