1 %feature("docstring") gum::initRandom
2 "
3 Initialize random generator seed.
4 
5 Parameters
6 ----------
7 seed : int
8   the seed used to initialize the random generator
9 "
10 
11 %feature("docstring") gum::randomProba
12 "
13 Returns
14 -------
15 double
16     a random number between 0 and 1 included (i.e. a proba).
17 "
18 
19 %feature("docstring") gum::randomDistribution
20 "
21 Parameters
22 ----------
23 n : int
24   The number of modalities for the ditribution.
25 
26 Returns
27 -------
28 a random discrete distribution.
29 "
30 
31 %feature("docstring") gum::isOMP
32 "
33 Returns
34 -------
35 bool
36   True if OMP has been set at compilation, False otherwise
37 "
38 
39 %feature("docstring") gum::setNumberOfThreads
40 "
41 To avoid spare cycles (less then 100% CPU occupied), use more threads than logical processors (x2 is a good all-around value).
42 
43 Returns
44 -------
45 number : int
46   the number of threads to be used
47 "
48 
49 %feature("docstring") gum::getNumberOfLogicalProcessors
50 "
51 Returns
52 -------
53 int
54   the number of logical processors
55 "
56 
57 %feature("docstring") gum::getMaxNumberOfThreads
58 "
59 Returns
60 -------
61 int
62   the max number of threads
63 "
64 
65 %feature("docstring") gum::randomGeneratorSeed
66 "
67 Returns
68 -------
69 int
70   a randomly generated seed
71 "
72 
73 %feature("docstring") gum::getNumberOfRunningThreads
74 "
75 Returns
76 -------
77 int
78   the number of running threads
79 "
80 
81 %feature("docstring") gum::getNestedParallelism
82 "
83 Returns
84 -------
85 bool
86   True if nested parallelism is enabled
87 "
88 
89 %feature("docstring") gum::setNestedParallelism
90 "
91 Parameters
92 ----------
93 value : bool
94   True if nested parallelism should be activated
95 "
96 
97 %feature("docstring") gum::getDynamicThreadsNumber
98 "
99 Returns
100 -------
101 bool
102   True if dynamic threads number is enabled
103 "
104 
105 %feature("docstring") gum::setDynamicThreadsNumber
106 "
107 Parameters
108 ----------
109 value : bool
110   True if the number of threads should be dynamic
111 "
112 
113 %feature("docstring") gum::getRandomGenerator
114 "
115 Returns
116 -------
117 tbw
118   the random generator
119 "
120 
121 %feature("docstring") gum::getThreadNumber
122 "
123 Returns
124 -------
125 int
126   the number of thread
127 "
128 
129 %feature("docstring") gum::randomValue
130 "
131 Returns
132 -------
133 int
134   a value randomly drawn (0 or 1)
135 "