SourceXtractorPlusPlus
0.11
Please provide a description of the project.
|
ResidualBlockProvider implementation for adding a prior to a parameter world value. More...
#include <WorldValueResidual.h>
Public Member Functions | |
WorldValueResidual (std::shared_ptr< BasicParameter > parameter, double expected_value, double weight=1.) | |
Constructs a new instance of WorldValueResidual. More... | |
virtual | ~WorldValueResidual () |
Destructor. More... | |
std::size_t | numberOfResiduals () const override |
Always returns 1, as this class creates a single residual. More... | |
void | populateResidualBlock (IterType output_iter) override |
![]() | |
virtual | ~ResidualBlockProvider ()=default |
Destructor. More... | |
Private Attributes | |
std::shared_ptr< BasicParameter > | m_parameter |
std::size_t | m_observer_id |
double | m_residual |
Additional Inherited Members | |
![]() | |
using | IterType = double * |
ResidualBlockProvider implementation for adding a prior to a parameter world value.
The residual is calculated as:
\[ r = w*(P_c-P_p) \]
where:
Definition at line 46 of file WorldValueResidual.h.
ModelFitting::WorldValueResidual::WorldValueResidual | ( | std::shared_ptr< BasicParameter > | parameter, |
double | expected_value, | ||
double | weight = 1. |
||
) |
Constructs a new instance of WorldValueResidual.
Note that this class will add an observer to the parameter which requires that the WorldValueResidual instance is still alive when it is called. For this reason, any updates of a parameter value after a related WorldValueResidual is deleted, leeds to undefined behavior.
parameter | A reference to the parameter the residual is calculated for |
expected_value | The prior expected world value |
weight | The weight or the residual |
Definition at line 35 of file WorldValueResidual.cpp.
References ModelFitting::computeResidual(), m_observer_id, and m_residual.
|
virtual |
Destructor.
Definition at line 27 of file WorldValueResidual.cpp.
References m_observer_id, and m_parameter.
|
overridevirtual |
Always returns 1, as this class creates a single residual.
Implements ModelFitting::ResidualBlockProvider.
Definition at line 45 of file WorldValueResidual.cpp.
|
overridevirtual |
Updates the value where the iterator points with the value of the residual for the current value of the parameter
Implements ModelFitting::ResidualBlockProvider.
Definition at line 49 of file WorldValueResidual.cpp.
References m_residual.
|
private |
Definition at line 81 of file WorldValueResidual.h.
Referenced by WorldValueResidual(), and ~WorldValueResidual().
|
private |
Definition at line 80 of file WorldValueResidual.h.
Referenced by ~WorldValueResidual().
|
private |
Definition at line 83 of file WorldValueResidual.h.
Referenced by populateResidualBlock(), and WorldValueResidual().