Partager via


cauchy_distribution, classe

Génère une distribution suivant une loi de Cauchy.

Syntaxe

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

   // constructor and reset functions
   explicit cauchy_distribution(result_type a = 0.0, result_type b = 1.0);
   explicit cauchy_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 a() const;
   result_type b() const;
   param_type param() const;
   void param(const param_type& parm);
   result_type min() const;
   result_type max() const;
   };

Paramètres

RealType
Le type des résultats à virgule flottante est double par défaut. Pour les types possibles, consultez <aléatoire>.

URNG
Moteur de générateur de nombres aléatoires uniforme. Pour les types possibles, consultez <aléatoire>.

Notes

Le modèle de classe décrit une distribution qui produit des valeurs d’un type à virgule flottante spécifié par l’utilisateur, ou un type double si aucun n’est fourni, distribué en fonction de la distribution Cauchy. Le tableau suivant contient des liens vers des articles sur différents membres.

cauchy_distribution
param_type

Les fonctions de propriété a() et b() retournent leurs valeurs respectives pour les paramètres de distribution stockés a et b.

Le membre de propriété param() définit ou retourne le package de paramètres de distribution stocké param_type.

Les fonctions membres min() et max() retournent respectivement le plus petit et le plus grand résultat possible.

La fonction membre reset() ignore toutes les valeurs mises en cache. Ainsi, le résultat de l’appel suivant à operator() ne dépend d’aucune valeur obtenue à partir du moteur avant l’appel.

Les fonctions membres operator() retournent la valeur générée suivante d’après le moteur URNG, à partir du package de paramètres actuel ou spécifié.

Pour plus d’informations sur les classes de distribution et leurs membres, consultez <aléatoire>.

Pour plus d’informations sur la loi de Cauchy, consultez l’article de Wolfram MathWorld Cauchy Distribution.

Exemple

// 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::cauchy_distribution<> distr(a, b);

    std::cout << std::endl;
    std::cout << "min() == " << distr.min() << std::endl;
    std::cout << "max() == " << distr.max() << std::endl;
    std::cout << "a() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.a() << std::endl;
    std::cout << "b() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.b() << 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 'a' distribution parameter: ";
    std::cin >> a_dist;
    std::cout << "Enter a floating point value for the 'b' 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);
}

Première exécution :

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

min() == -1.79769e+308
max() == 1.79769e+308
a() == 0.0000000000
b() == 1.0000000000
Distribution for 10 samples:
    1: -3.4650392984
    2: -2.6369564174
    3: -0.0786978867
    4: -0.0609632093
    5: 0.0589387400
    6: 0.0589539764
    7: 0.1004592006
    8: 1.0965724260
    9: 1.4389408122
    10: 2.5253154706

Deuxième exécution :

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

min() == -1.79769e+308
max() == 1.79769e+308
a() == 0.0000000000
b() == 10.0000000000
Distribution for 10 samples:
    1: -34.6503929840
    2: -26.3695641736
    3: -0.7869788674
    4: -0.6096320926
    5: 0.5893873999
    6: 0.5895397637
    7: 1.0045920062
    8: 10.9657242597
    9: 14.3894081218
    10: 25.2531547063

Troisième exécution :

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

min() == -1.79769e+308
max() == 1.79769e+308
a() == 10.0000000000
b() == 10.0000000000
Distribution for 10 samples:
    1: -24.6503929840
    2: -16.3695641736
    3: 9.2130211326
    4: 9.3903679074
    5: 10.5893873999
    6: 10.5895397637
    7: 11.0045920062
    8: 20.9657242597
    9: 24.3894081218
    10: 35.2531547063

Spécifications

Header :<random>

Espace de noms : std

cauchy_distribution::cauchy_distribution

Construit la distribution.

explicit cauchy_distribution(result_type a = 0.0, result_type b = 1.0);
explicit cauchy_distribution(const param_type& parm);

Paramètres

a
Paramètre de distribution a.

b
Paramètre de distribution b.

parm
Structure param_type utilisée pour construire la distribution.

Notes

Condition préalable : 0.0 < b

Le premier constructeur construit un objet dont la valeur a stockée contient la valeur a et dont la valeur b stockée contient la valeur b.

Le deuxième constructeur construit un objet dont les paramètres stockés sont initialisés à partir de parm. Vous pouvez obtenir et définir les paramètres actuels d'une distribution existante en appelant la fonction membre param().

cauchy_distribution::param_type

Stocke tous les paramètres de la distribution.

struct param_type {
   typedef cauchy_distribution<result_type> distribution_type;
   param_type(result_type a = 0.0, result_type b = 1.0);
   result_type a() const;
   result_type b() const;

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

Paramètres

a
Paramètre de distribution a.

b
Paramètre de distribution b.

right
Objet param_type à comparer à this.

Notes

Condition préalable : 0.0 < b

Cette structure peut être passée au constructeur de classe de la distribution au moment de l'instanciation, à la fonction membre param() pour définir les paramètres stockés d'une distribution existante et à operator() pour une utilisation à la place des paramètres stockés.

Voir aussi

<random>