IDistribution1DSampler.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Correlations/IDistribution1DSampler.h
//! @brief     Defines interface class IProfile1D, and children thereof
//!
//! @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)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_SAMPLE_CORRELATIONS_IDISTRIBUTION1DSAMPLER_H
#define BORNAGAIN_SAMPLE_CORRELATIONS_IDISTRIBUTION1DSAMPLER_H
 
class IDistribution1DSampler {
public:
    IDistribution1DSampler() = default;
    virtual ~IDistribution1DSampler();
 
    virtual double randomSample() const = 0;
};
 
class Distribution1DCauchySampler : public IDistribution1DSampler {
public:
    Distribution1DCauchySampler(double lambda)
        : m_lambda(lambda)
    {
    }
    double randomSample() const override;
 
private:
    double m_lambda;
};
 
class Distribution1DGaussSampler : public IDistribution1DSampler {
public:
    Distribution1DGaussSampler(double mean, double stddev)
        : m_mean(mean)
        , m_stddev(stddev)
    {
    }
    double randomSample() const override;
 
private:
    double m_mean, m_stddev;
};
 
class Distribution1DGateSampler : public IDistribution1DSampler {
public:
    Distribution1DGateSampler(double a, double b)
        : m_a(a)
        , m_b(b)
    {
    }
    double randomSample() const override;
 
private:
    double m_a, m_b; // the left and right limits of the Gate (Uniform) distribution
};
 
class Distribution1DTriangleSampler : public IDistribution1DSampler {
public:
    Distribution1DTriangleSampler(double omega)
        : m_omega(omega)
    {
    }
    double randomSample() const override;
 
private:
    double m_omega; // half the base of the symmetrical Triangle distribution
};
 
class Distribution1DCosineSampler : public IDistribution1DSampler {
public:
    Distribution1DCosineSampler(double omega)
        : m_omega(omega)
    {
    }
    double randomSample() const override;
 
private:
    double m_omega;
};
 
#endif // BORNAGAIN_SAMPLE_CORRELATIONS_IDISTRIBUTION1DSAMPLER_H
#endif // USER_API