SourceXtractorPlusPlus  0.12
Please provide a description of the project.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
ModelFitting::ResidualBlockProvider Class Referenceabstract

Interface of a class which can provide a block of residuals for least square minimization solving. More...

#include <ResidualBlockProvider.h>

Inheritance diagram for ModelFitting::ResidualBlockProvider:
[legend]

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...
 

Detailed Description

Interface of a class which can provide a block of residuals for least square minimization solving.

Definition at line 35 of file ResidualBlockProvider.h.

Member Typedef Documentation

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.

Constructor & Destructor Documentation

virtual ModelFitting::ResidualBlockProvider::~ResidualBlockProvider ( )
virtualdefault

Destructor.

Member Function Documentation

virtual std::size_t ModelFitting::ResidualBlockProvider::numberOfResiduals ( ) const
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.

Returns
The number of residuals

Implemented in ModelFitting::DataVsModelResiduals< DataType, ModelType, WeightType, Comparator >, ModelFitting::EngineValueResidual, and ModelFitting::WorldValueResidual.

virtual void ModelFitting::ResidualBlockProvider::populateResidualBlock ( IterType  output_iter)
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.

Parameters
output_iterThe iterator to use for returning the residual values

Implemented in ModelFitting::DataVsModelResiduals< DataType, ModelType, WeightType, Comparator >, ModelFitting::EngineValueResidual, and ModelFitting::WorldValueResidual.


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