random.hh 3.96 KB
Newer Older
1
// -*- coding: utf-8 -*-
2
// Copyright (C) 2015 Laboratoire de Recherche et Développement
3
// de l'Epita (LRDE).
4
// Copyright (C) 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
5
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
6
7
8
9
10
11
// et Marie Curie.
//
// This file is part of Spot, a model checking library.
//
// Spot is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
12
// the Free Software Foundation; either version 3 of the License, or
13
14
15
16
17
18
19
20
// (at your option) any later version.
//
// Spot is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
// License for more details.
//
// You should have received a copy of the GNU General Public License
21
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
22

23
24
25
#ifndef SPOT_MISC_RANDOM_HH
# define SPOT_MISC_RANDOM_HH

26
# include "common.hh"
27
28
# include <cmath>
# include <vector>
29

30
31
namespace spot
{
32
33
34
35
  /// \addtogroup random Random functions
  /// \ingroup misc_tools
  /// @{

36
37
38
  /// \brief Reset the seed of the pseudo-random number generator.
  ///
  /// \see drand, mrand, rrand
39
  SPOT_API void srand(unsigned int seed);
40
41
42
43
44

  /// \brief Compute a pseudo-random integer value between \a min and
  /// \a max included.
  ///
  /// \see drand, mrand, srand
45
  SPOT_API int rrand(int min, int max);
46

47
  /// \brief Compute a pseudo-random integer value between 0 and
48
49
50
  /// \a max-1 included.
  ///
  /// \see drand, rrand, srand
51
  SPOT_API int mrand(int max);
52
53
54
55
56

  /// \brief Compute a pseudo-random double value
  /// between 0.0 and 1.0 (1.0 excluded).
  ///
  /// \see mrand, rrand, srand
57
  SPOT_API double drand();
58

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  /// \brief Compute a pseudo-random double value
  /// following a standard normal distribution.  (Odeh & Evans)
  ///
  /// This uses a polynomial approximation of the inverse cumulated
  /// density function from Odeh & Evans, Journal of Applied
  /// Statistics, 1974, vol 23, pp 96-97.
  SPOT_API double nrand();

  /// \brief Compute a pseudo-random double value
  /// following a standard normal distribution.  (Box-Muller)
  ///
  /// This uses the polar form of the Box-Muller transform
  /// to generate random values.
  SPOT_API double bmrand();

74
75
76
  /// \brief Compute pseudo-random integer value between 0
  /// and \a n included, following a binomial distribution
  /// for probability \a p.
77
78
79
80
81
82
83
84
85
86
  ///
  /// \a gen must be a random function computing a pseudo-random
  /// double value following a standard normal distribution.
  /// Use nrand() or bmrand().
  ///
  /// Usually approximating a binomial distribution using a normal
  /// distribution and is accurate only if <code>n*p</code> and
  /// <code>n*(1-p)</code> are greater than 5.
  template<double (*gen)()>
  class barand
87
88
  {
  public:
89
90
    barand(int n, double p)
      : n_(n), m_(n * p), s_(sqrt(n * p * (1 - p)))
91
92
93
    {
    }

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
    int
    rand() const
    {
      int res;

      for (;;)
	{
	  double x = gen() * s_ + m_;
	  if (x < 0.0)
	    continue;
	  res = static_cast<int> (x);
          if (res <= n_)
	    break;
        }
      return res;
    }
  protected:
    const int n_;
    const double m_;
    const double s_;
114
  };
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

  /// \brief Return a pseudo-random positive integer value
  /// following a Poisson distribution with parameter \a p.
  ///
  /// \pre <code>p > 0</code>
  SPOT_API int prand(double p);

  /// \brief Shuffle the container using mrand function above.
  /// This allows to get rid off shuffle or random_shuffle that use
  /// uniform_distribution and RandomIterator that are not portables.
  template<class iterator_type>
  SPOT_API void mrandom_shuffle(iterator_type&& first, iterator_type&& last)
  {
    auto d = std::distance(first, last);
    if (d > 1)
      {
	for (--last; first < last; ++first, --d)
	  {
	    auto i = mrand(d);
	    std::swap(*first, *(first + i));
	  }
      }
  }
  /// @}
139
}
140
141

#endif // SPOT_MISC_RANDOM_HH