BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
VarianceSimFunction Class Reference

Returns max(sim, epsilon) More...

Inheritance diagram for VarianceSimFunction:
[legend]
Collaboration diagram for VarianceSimFunction:
[legend]

Public Member Functions

 VarianceSimFunction (double epsilon=1.0)
 
VarianceSimFunctionclone () const override
 
double variance (double exp, double sim) const override
 

Private Attributes

double m_epsilon
 

Detailed Description

Returns max(sim, epsilon)

Definition at line 47 of file VarianceFunctions.h.

Constructor & Destructor Documentation

◆ VarianceSimFunction()

VarianceSimFunction::VarianceSimFunction ( double  epsilon = 1.0)
explicit

Definition at line 36 of file VarianceFunctions.cpp.

36 : m_epsilon(epsilon) {}

Referenced by clone().

Member Function Documentation

◆ clone()

VarianceSimFunction * VarianceSimFunction::clone ( ) const
overridevirtual

Implements IVarianceFunction.

Definition at line 38 of file VarianceFunctions.cpp.

39 {
40  return new VarianceSimFunction(m_epsilon);
41 }
VarianceSimFunction(double epsilon=1.0)

References VarianceSimFunction(), and m_epsilon.

Here is the call graph for this function:

◆ variance()

double VarianceSimFunction::variance ( double  exp,
double  sim 
) const
overridevirtual

Implements IVarianceFunction.

Definition at line 43 of file VarianceFunctions.cpp.

44 {
45  return std::max(sim, m_epsilon);
46 }

References m_epsilon.

Member Data Documentation

◆ m_epsilon

double VarianceSimFunction::m_epsilon
private

Definition at line 54 of file VarianceFunctions.h.

Referenced by clone(), and variance().


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