gamma_distribution-Klasse

  • Artikel

Generiert eine Gammaverteilung.

Syntax

template<class RealType = double>
class gamma_distribution {
public:
    // types
    typedef RealType result_type;
    struct param_type;

    // constructors and reset functions
    explicit gamma_distribution(result_type alpha = 1.0, result_type beta = 1.0);
    explicit gamma_distribution(const param_type& parm);
    void reset();

    // generating functions
    template <class URNG>
    result_type operator()(URNG& gen);
    template <class URNG>
    result_type operator()(URNG& gen, const param_type& parm);

    // property functions
    result_type alpha() const;
    result_type beta() const;
    param_type param() const;
    void param(const param_type& parm);
    result_type min() const;
    result_type max() const;
};

Parameter

RealType
Der Gleitkommaergebnistyp. Der Standardwert ist double. Mögliche Typen finden Sie unter <"zufällig>".

URNG
Die einheitliche Zufallszahlengenerator-Engine. Mögliche Typen finden Sie unter <"zufällig>".

Hinweise

Die Klassenvorlage beschreibt eine Verteilung, die Werte eines vom Benutzer angegebenen Gleitkommatyps erzeugt, oder typisiert double , wenn keine angegeben wird, verteilt gemäß der Gammaverteilung. Die folgende Tabelle ist mit Artikeln über einzelne Member verknüpft.

gamma_distribution
param_type

Die Eigenschaftsfunktionen alpha() und beta() geben ihre entsprechenden Werte für die gespeicherten Verteilungsparameter Alpha und Beta zurück.

Das Eigenschaftsmember param() gibt das aktuell gespeicherte Verteilungspaket param_type zurück oder legt es fest.

Die min()- und max()-Memberfunktion gibt das jeweils kleinst- und größtmögliche Ergebnis zurück.

Die reset()-Memberfunktion verwirft alle zwischengespeicherten Werte, damit das Ergebnis des folgenden Aufrufs von operator() nicht von Werten abhängig ist, die vor dem Aufruf aus der Engine bezogen wurden.

Die operator()-Memberfunktionen geben den nächsten generierten Wert von entweder dem aktuellen oder dem spezifizierten Parameterpaket zurück, das auf der URNG-Engine basiert.

Weitere Informationen zu Verteilungsklassen und ihren Mitgliedern finden Sie unter <"zufällig>".

Ausführliche Informationen über die Gammaverteilung finden Sie im Wolfram MathWorld-Artikel Gamma Distribution.

Beispiel

// compile with: /EHsc /W4
#include <random>
#include <iostream>
#include <iomanip>
#include <string>
#include <map>

void test(const double a, const double b, const int s) {

    // uncomment to use a non-deterministic generator
    //    std::random_device gen;

    std::mt19937 gen(1701);

    std::gamma_distribution<> distr(a, b);

    std::cout << std::endl;
    std::cout << "min() == " << distr.min() << std::endl;
    std::cout << "max() == " << distr.max() << std::endl;
    std::cout << "alpha() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.alpha() << std::endl;
    std::cout << "beta() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.beta() << std::endl;

    // generate the distribution as a histogram
    std::map<double, int> histogram;
    for (int i = 0; i < s; ++i) {
        ++histogram[distr(gen)];
    }

    // print results
    std::cout << "Distribution for " << s << " samples:" << std::endl;
    int counter = 0;
    for (const auto& elem : histogram) {
        std::cout << std::fixed << std::setw(11) << ++counter << ": "
            << std::setw(14) << std::setprecision(10) << elem.first << std::endl;
    }
    std::cout << std::endl;
}

int main()
{
    double a_dist = 0.0;
    double b_dist = 1;

    int samples = 10;

    std::cout << "Use CTRL-Z to bypass data entry and run using default values." << std::endl;
    std::cout << "Enter a floating point value for the 'alpha' distribution parameter (must be greater than zero): ";
    std::cin >> a_dist;
    std::cout << "Enter a floating point value for the 'beta' distribution parameter (must be greater than zero): ";
    std::cin >> b_dist;
    std::cout << "Enter an integer value for the sample count: ";
    std::cin >> samples;

    test(a_dist, b_dist, samples);
}

Use CTRL-Z to bypass data entry and run using default values.
Enter a floating point value for the 'alpha' distribution parameter (must be greater than zero): 1
Enter a floating point value for the 'beta' distribution parameter (must be greater than zero): 1
Enter an integer value for the sample count: 10

min() == 4.94066e-324
max() == 1.79769e+308
alpha() == 1.0000000000
beta() == 1.0000000000
Distribution for 10 samples:
    1: 0.0936880533
    2: 0.1225944894
    3: 0.6443593183
    4: 0.6551171649
    5: 0.7313457551
    6: 0.7313557977
    7: 0.7590097389
    8: 1.4466885214
    9: 1.6434088411
    10: 2.1201210996

Anforderungen

Header:<random>

Namespace: std

gamma_distribution::gamma_distribution

Erstellt die Verteilung.

explicit gamma_distribution(result_type alpha = 1.0, result_type beta = 1.0);
explicit gamma_distribution(const param_type& parm);

Parameter

alpha
Der alpha-Verteilungsparameter.

beta
Der beta-Verteilungsparameter.

parm
Die für die Erstellung der Verteilung verwendete Parameterstruktur.

Hinweise

Voraussetzung:0.0 < alpha und 0.0 < beta

Mit dem ersten Konstruktor wird ein Objekt erstellt, in dessen gespeichertem alpha-Wert der Wert alpha enthalten ist und dessen gespeicherter beta-Wert den Wert beta enthält.

Mit dem zweiten Konstruktor wird ein Objekt erstellt, dessen gespeicherte Parameter aus parm initialisiert werden. Sie können die aktuellen Parameter einer vorhandenen Verteilung abrufen und festlegen, indem Sie die Memberfunktion param() aufrufen.

gamma_distribution::param_type

Speichert die Parameter der Verteilung.

struct param_type {
   typedef gamma_distribution<result_type> distribution_type;
   param_type(result_type alpha = 1.0, result_type beta 1.0);
   result_type alpha() const;
   result_type beta() const;

   bool operator==(const param_type& right) const;
   bool operator!=(const param_type& right) const;
   };

Parameter

alpha
Der alpha-Verteilungsparameter.

beta
Der beta-Verteilungsparameter.

right
Die param_type-Instanz, mit der verglichen wird.

Hinweise

Voraussetzung:0.0 < alpha und 0.0 < beta

Diese Struktur kann bei der Instanziierung an den Klassenkonstruktor des Verteilers, an die Memberfunktion param() (zur Festlegung der gespeicherten Parameter einer vorhandenen Verteilung) und an operator() (zur Verwendung anstelle der gespeicherten Parameter) übergeben werden.

Siehe auch

<random>