BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
IChiSquaredModule Class Referenceabstract

Description

Interface residual calculations.

Inheritance diagram for IChiSquaredModule:

Public Member Functions

 IChiSquaredModule ()
 
 ~IChiSquaredModule () override
 
IChiSquaredModuleclone () const override=0
 clone method More...
 
virtual const IIntensityFunctiongetIntensityFunction () const
 Returns data rescaler. More...
 
virtual double residual (double a, double b, double weight)=0
 
virtual void setIntensityFunction (const IIntensityFunction &intensity_function)
 Sets data rescaler. More...
 
void setVarianceFunction (const IVarianceFunction &variance_function)
 Sets squared function. More...
 
const IVarianceFunction * varianceFunction () const
 Returns squared function. More...
 

Protected Member Functions

 IChiSquaredModule (const IChiSquaredModule &other)
 

Protected Attributes

std::unique_ptr< IIntensityFunctionm_intensity_function
 
std::unique_ptr< IVarianceFunction > m_variance_function
 

Constructor & Destructor Documentation

◆ IChiSquaredModule() [1/2]

IChiSquaredModule::IChiSquaredModule ( )

◆ ~IChiSquaredModule()

IChiSquaredModule::~IChiSquaredModule ( )
override

◆ IChiSquaredModule() [2/2]

IChiSquaredModule::IChiSquaredModule ( const IChiSquaredModule other)
protected

Member Function Documentation

◆ clone()

IChiSquaredModule* IChiSquaredModule::clone ( ) const
overridepure virtual

clone method

Implemented in ChiSquaredModule.

◆ getIntensityFunction()

virtual const IIntensityFunction* IChiSquaredModule::getIntensityFunction ( ) const
virtual

Returns data rescaler.

◆ residual()

virtual double IChiSquaredModule::residual ( double  a,
double  b,
double  weight 
)
pure virtual

Implemented in ChiSquaredModule.

◆ setIntensityFunction()

virtual void IChiSquaredModule::setIntensityFunction ( const IIntensityFunction intensity_function)
virtual

Sets data rescaler.

◆ setVarianceFunction()

void IChiSquaredModule::setVarianceFunction ( const IVarianceFunction &  variance_function)

Sets squared function.

◆ varianceFunction()

const IVarianceFunction* IChiSquaredModule::varianceFunction ( ) const

Returns squared function.

Member Data Documentation

◆ m_intensity_function

std::unique_ptr<IIntensityFunction> IChiSquaredModule::m_intensity_function
protected

◆ m_variance_function

std::unique_ptr<IVarianceFunction> IChiSquaredModule::m_variance_function
protected