SourceXtractorPlusPlus  0.10
Please provide a description of the project.
Public Member Functions | Private Attributes | List of all members
ExpResidualProvider Class Reference
Inheritance diagram for ExpResidualProvider:
[legend]
Collaboration diagram for ExpResidualProvider:
[legend]

Public Member Functions

 ExpResidualProvider (std::shared_ptr< BasicParameter > a, std::shared_ptr< BasicParameter > lambda, std::shared_ptr< BasicParameter > b, const std::vector< double > &y, const std::vector< double > &t)
 
virtual ~ExpResidualProvider ()=default
 
std::size_t numberOfResiduals () const override
 Returns the number of residuals provided by this provider. More...
 
void populateResidualBlock (IterType iter) override
 Provides the residual values. More...
 
- Public Member Functions inherited from ModelFitting::ResidualBlockProvider
virtual ~ResidualBlockProvider ()=default
 Destructor. More...
 

Private Attributes

std::shared_ptr< BasicParameterm_A
 
std::shared_ptr< BasicParameterm_lambda
 
std::shared_ptr< BasicParameterm_b
 
std::vector< double > m_y
 
std::vector< double > m_t
 

Additional Inherited Members

- Public Types inherited from ModelFitting::ResidualBlockProvider
using IterType = double *
 

Detailed Description

Definition at line 36 of file Example_SimpleFit.cpp.

Constructor & Destructor Documentation

◆ ExpResidualProvider()

ExpResidualProvider::ExpResidualProvider ( std::shared_ptr< BasicParameter a,
std::shared_ptr< BasicParameter lambda,
std::shared_ptr< BasicParameter b,
const std::vector< double > &  y,
const std::vector< double > &  t 
)
inline

Definition at line 42 of file Example_SimpleFit.cpp.

◆ ~ExpResidualProvider()

virtual ExpResidualProvider::~ExpResidualProvider ( )
virtualdefault

Member Function Documentation

◆ numberOfResiduals()

std::size_t ExpResidualProvider::numberOfResiduals ( ) const
inlineoverridevirtual

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

Implements ModelFitting::ResidualBlockProvider.

Definition at line 49 of file Example_SimpleFit.cpp.

References std::vector< T >::size().

Here is the call graph for this function:

◆ populateResidualBlock()

void ExpResidualProvider::populateResidualBlock ( IterType  output_iter)
inlineoverridevirtual

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

Implements ModelFitting::ResidualBlockProvider.

Definition at line 53 of file Example_SimpleFit.cpp.

References e, std::endl(), std::exp(), std::fixed(), ModelFitting::BasicParameter::getValue(), std::scientific(), std::setprecision(), and std::vector< T >::size().

Here is the call graph for this function:

Member Data Documentation

◆ m_A

std::shared_ptr<BasicParameter> ExpResidualProvider::m_A
private

Definition at line 38 of file Example_SimpleFit.cpp.

◆ m_b

std::shared_ptr<BasicParameter> ExpResidualProvider::m_b
private

Definition at line 38 of file Example_SimpleFit.cpp.

◆ m_lambda

std::shared_ptr<BasicParameter> ExpResidualProvider::m_lambda
private

Definition at line 38 of file Example_SimpleFit.cpp.

◆ m_t

std::vector<double> ExpResidualProvider::m_t
private

Definition at line 39 of file Example_SimpleFit.cpp.

◆ m_y

std::vector<double> ExpResidualProvider::m_y
private

Definition at line 39 of file Example_SimpleFit.cpp.


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