1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Sim/Residual/VarianceFunctions.h
//! @brief Defines class IVarianceFunctiones.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
// ************************************************************************************************
#ifndef BORNAGAIN_SIM_RESIDUAL_VARIANCEFUNCTIONS_H
#define BORNAGAIN_SIM_RESIDUAL_VARIANCEFUNCTIONS_H
//! Variance function interface.
class IVarianceFunction {
public:
IVarianceFunction() = default;
virtual ~IVarianceFunction() = default;
IVarianceFunction(const IVarianceFunction&) = delete;
IVarianceFunction& operator=(const IVarianceFunction&) = delete;
#ifndef SWIG
virtual IVarianceFunction* clone() const = 0;
#endif // SWIG
virtual double variance(double real_value, double simulated_value) const = 0;
};
//! Returns 1.0 as variance value
class VarianceConstantFunction : public IVarianceFunction {
public:
#ifndef SWIG
VarianceConstantFunction* clone() const override;
#endif // SWIG
double variance(double, double) const override;
};
//! Returns max(sim, epsilon)
class VarianceSimFunction : public IVarianceFunction {
public:
explicit VarianceSimFunction(double epsilon = 1.0);
double variance(double exp, double sim) const override;
#ifndef SWIG
VarianceSimFunction* clone() const override;
#endif // SWIG
private:
double m_epsilon;
};
#endif // BORNAGAIN_SIM_RESIDUAL_VARIANCEFUNCTIONS_H
|