IChiSquaredModule Class Reference

Description

Interface residual calculations.

Definition at line 26 of file IChiSquaredModule.h.

Inheritance diagram for IChiSquaredModule:

Collaboration diagram for IChiSquaredModule:

Public Member Functions
	IChiSquaredModule ()
	~IChiSquaredModule () override
IChiSquaredModule *	clone () const override=0
	clone method More...
virtual const IIntensityFunction *	getIntensityFunction () 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...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
const IVarianceFunction *	varianceFunction () const
	Returns squared function. More...

Protected Member Functions
	IChiSquaredModule (const IChiSquaredModule &other)

Protected Attributes
std::unique_ptr< IIntensityFunction >	m_intensity_function
std::unique_ptr< IVarianceFunction >	m_variance_function

Constructor & Destructor Documentation

IChiSquaredModule() [1/2]

IChiSquaredModule::IChiSquaredModule

(

)

Definition at line 19 of file IChiSquaredModule.cpp.

    : m_variance_function(new VarianceSimFunction)
{
}

~IChiSquaredModule()

IChiSquaredModule::~IChiSquaredModule ( )

overridedefault

IChiSquaredModule() [2/2]

IChiSquaredModule::IChiSquaredModule ( const IChiSquaredModule &  other )

protected

Definition at line 29 of file IChiSquaredModule.cpp.

{
    if (other.m_variance_function)
        m_variance_function.reset(other.m_variance_function->clone());
 
    if (other.m_intensity_function)
        m_intensity_function.reset(other.m_intensity_function->clone());
}

References m_intensity_function, and m_variance_function.

Member Function Documentation

clone()

IChiSquaredModule* IChiSquaredModule::clone ( ) const

overridepure virtual

clone method

Implements ICloneable.

Implemented in ChiSquaredModule.

Referenced by FitObjective::setChiSquaredModule().

getIntensityFunction()

const IIntensityFunction * IChiSquaredModule::getIntensityFunction ( ) const

virtual

Returns data rescaler.

Definition at line 45 of file IChiSquaredModule.cpp.

{
    return m_intensity_function.get();
}

References m_intensity_function.

residual()

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

pure virtual

Implemented in ChiSquaredModule.

setIntensityFunction()

void IChiSquaredModule::setIntensityFunction ( const IIntensityFunction &  intensity_function )

virtual

Sets data rescaler.

Definition at line 50 of file IChiSquaredModule.cpp.

{
    m_intensity_function.reset(intensity_function.clone());
}

References IIntensityFunction::clone(), and m_intensity_function.

Here is the call graph for this function:

setVarianceFunction()

void IChiSquaredModule::setVarianceFunction

(

const IVarianceFunction &

variance_function

)

Sets squared function.

Definition at line 40 of file IChiSquaredModule.cpp.

{
    m_variance_function.reset(variance_function.clone());
}

References IVarianceFunction::clone(), and m_variance_function.

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

varianceFunction()

const IVarianceFunction * IChiSquaredModule::varianceFunction

(

)

const

Returns squared function.

Definition at line 24 of file IChiSquaredModule.cpp.

{
    return m_variance_function.get();
}

References m_variance_function.

Member Data Documentation

m_intensity_function

std::unique_ptr<IIntensityFunction> IChiSquaredModule::m_intensity_function

protected

Definition at line 52 of file IChiSquaredModule.h.

Referenced by IChiSquaredModule(), getIntensityFunction(), ChiSquaredModule::residual(), and setIntensityFunction().

m_variance_function

std::unique_ptr<IVarianceFunction> IChiSquaredModule::m_variance_function

protected

Definition at line 51 of file IChiSquaredModule.h.

Referenced by IChiSquaredModule(), ChiSquaredModule::residual(), setVarianceFunction(), and varianceFunction().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Residual/IChiSquaredModule.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Residual/IChiSquaredModule.cpp