SourceXtractorPlusPlus
0.15
Please provide a description of the project.
|
Interface of a class which can provide a block of residuals for least square minimization solving. More...
#include <ResidualBlockProvider.h>
Public Types | |
using | IterType = double * |
Public Member Functions | |
virtual std::size_t | numberOfResiduals () const =0 |
Returns the number of residuals provided by this provider. More... | |
virtual void | populateResidualBlock (IterType output_iter)=0 |
Provides the residual values. More... | |
virtual | ~ResidualBlockProvider ()=default |
Destructor. More... | |
Interface of a class which can provide a block of residuals for least square minimization solving.
Definition at line 35 of file ResidualBlockProvider.h.
using ModelFitting::ResidualBlockProvider::IterType = double* |
The type of the iterator the populateResiduals() method receives. Note that even though this type is part of the public API, the only guarantee is that is is an output iterator type. It is not a template parameter because of the limitation of C++ having virtual template methods.
Definition at line 45 of file ResidualBlockProvider.h.
|
virtualdefault |
Destructor.
|
pure virtual |
Returns the number of residuals provided by this provider.
Implementations must guarantee that this number will be constant for the lifetime of an instance. Failure of this restriction might result to undefined behavior.
Implemented in ModelFitting::DataVsModelResiduals< DataType, ModelType, WeightType, Comparator >, ModelFitting::EngineValueResidual, and ModelFitting::WorldValueResidual.
|
pure virtual |
Provides the residual values.
Implementations of this method should use the given iterator for populating their residual values. The iterator should not be increased more times than the number of residuals reported by the numberOfResiduals() method. Such an action might result to undefined behavior.
output_iter | The iterator to use for returning the residual values |
Implemented in ModelFitting::DataVsModelResiduals< DataType, ModelType, WeightType, Comparator >, ModelFitting::EngineValueResidual, and ModelFitting::WorldValueResidual.