aGrUM  0.14.2
utils_random.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES *
3  * {prenom.nom}_at_lip6.fr *
4  * *
5  * This program is free software; you can redistribute it and/or modify *
6  * it udnder the terms of the GNU General Public License as published by *
7  * the Free Software Foundation; either version 2 of the License, or *
8  * (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License *
16  * along with this program; if not, write to the *
17  * Free Software Foundation, Inc., *
18  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19  ***************************************************************************/
27 #ifndef GUM_UTILS_RANDOM_H
28 #define GUM_UTILS_RANDOM_H
29 
30 #include <chrono>
31 #include <cstdlib>
32 #include <ctime>
33 #include <iostream>
34 #include <numeric>
35 #include <random>
36 #include <utility>
37 #include <vector>
38 
39 #include <agrum/agrum.h>
40 
41 namespace gum {
42 
45 
51  Idx randomValue(const Size max = 2);
52 
57  double randomProba();
58 
65  template < typename GUM_SCALAR >
66  std::vector< GUM_SCALAR > randomDistribution(Size n);
67 
72  unsigned int randomGeneratorSeed();
73 
77  void initRandom(unsigned int seed = 0);
78 
82  std::default_random_engine getRandomGenerator(unsigned int seed = 0);
83 
85 } /* namespace gum */
86 
87 #ifndef GUM_NO_INLINE
89 #endif // GUM_NO_INLINE
90 
91 // always include the template implementations
93 
94 #endif /* GUM_UTILS_RANDOM_H */
std::vector< GUM_SCALAR > randomDistribution(Size n)
Return a random discrete distribution.
Idx randomValue(const Size max=2)
Returns a random Idx between 0 and max-1 included.
double randomProba()
Returns a random double between 0 and 1 included (i.e.
gum is the global namespace for all aGrUM entities
Definition: agrum.h:25
unsigned int randomGeneratorSeed()
Returns the aGrUM&#39;s seed used by the std::generators.
void initRandom(unsigned int seed=0)
Initialize random generator seed.
Contains usefull methods for random stuff.
std::default_random_engine getRandomGenerator(unsigned int seed)
define a random_engine with correct seed
Contains useful methods for random stuff.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:45