File: GSLRandomFunctions.h

package info (click to toggle)
bornagain 23.0-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,956 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 356; ruby: 173; xml: 130; makefile: 45; ansic: 24
file content (239 lines) | stat: -rw-r--r-- 5,931 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// @(#)root/mathmore:$Id$
// Authors: L. Moneta    8/2015

/**********************************************************************
 *                                                                    *
 * Copyright (c) 2015 , ROOT MathLib Team                             *
 *                                                                    *
 *                                                                    *
 **********************************************************************/

// Header file for random class
//
//
// Created by: Lorenzo Moneta  : Tue 4 Aug 2015
//
//
#ifndef ROOT_Math_GSLRandomFunctions
#define ROOT_Math_GSLRandomFunctions


//#include <type_traits>

#include "Math/RandomFunctions.h"

#include "Math/GSLRndmEngines.h"

namespace ROOT {
namespace Math {


//___________________________________________________________________________________
   /**
       Specialized implementation of the Random functions based on the GSL library. 
       These will work onlmy with a GSLRandomEngine type 

       @ingroup  Random
   */


   template <class EngineType >
   class RandomFunctions<EngineType, ROOT::Math::GSLRandomEngine> : public RandomFunctions<EngineType, DefaultEngineType> {
      //class RandomFunctions<Engine, ROOT::Math::GSLRandomEngine>  {

      //typdef TRandomEngine DefaulEngineType;
      
   public:

      RandomFunctions() {} 

      RandomFunctions(EngineType & rng) : RandomFunctions<EngineType, DefaultEngineType>(rng) {}


      inline EngineType & Engine() { return  RandomFunctions<EngineType,DefaultEngineType>::Rng(); }
      
      double GausZig(double mean, double sigma) {
         return Engine().GaussianZig(sigma) + mean;
      }
      // double GausRatio(double mean, double sigma) {
      //    auto & r =  RandomFunctions<Engine,DefaultEngineType>::Rng();
      //    return r.GaussianRatio(sigma) + mean; 
      // }
      
      /**
         Gaussian distribution. Default method (use Ziggurat)
      */
      double Gaus(double mean = 0, double sigma = 1) {
         return mean + Engine().GaussianZig(sigma);
      }

      /**
         Gaussian distribution (Box-Muller method)
      */
      double GausBM(double mean = 0, double sigma = 1) {
         return mean + Engine().Gaussian(sigma);
      }
      
      /**
         Gaussian distribution (Ratio Method)
      */
      double GausR(double mean = 0, double sigma = 1) {
         return mean + Engine().GaussianRatio(sigma);
      }
      
      /**
         Gaussian Tail distribution
      */
      double GaussianTail(double a, double sigma = 1) {
         return Engine().GaussianTail(a,sigma);
      }
      
      /**
         Bivariate Gaussian distribution with correlation
      */
      void Gaussian2D(double sigmaX, double sigmaY, double rho, double &x, double &y) {
         Engine().Gaussian2D(sigmaX, sigmaY, rho, x, y);
      }

      /**
         Exponential distribution
      */
      double Exp(double tau) {
         return Engine().Exponential(tau);
      }
      /**
         Breit Wigner distribution
      */
      double BreitWigner(double mean = 0., double gamma = 1) {
         return mean + Engine().Cauchy( gamma/2.0 );
      }
      
      /**
         Landau distribution
      */
      double Landau(double mean = 0, double sigma = 1) {
         return mean + sigma*Engine().Landau();
      }

      /**
         Gamma distribution
      */
      double Gamma(double a, double b) {
         return Engine().Gamma(a,b);
      }

      /**
         Beta distribution
      */
      double Beta(double a, double b) {
         return Engine().Beta(a,b);
      }

      /**
         Log Normal distribution
      */
      double LogNormal(double zeta, double sigma) {
         return Engine().LogNormal(zeta,sigma);
      }

      /**
         Chi square distribution
      */
      double ChiSquare(double nu) {
         return Engine().ChiSquare(nu);
      }

      /**
         F distrbution
      */
      double FDist(double nu1, double nu2) {
         return Engine().FDist(nu1,nu2);
      }

      /**
         t student distribution
      */
      double tDist(double nu) {
         return Engine().tDist(nu);
      }
      /**
         Rayleigh distribution
      */
      double Rayleigh(double sigma)  {
         return Engine().Rayleigh(sigma);
      }

      /**
         Logistic distribution
      */
      double Logistic(double a) {
         return Engine().Logistic(a);
      }

      /**
         Pareto distribution
      */
      double Pareto(double a, double b)  {
         return Engine().Pareto(a,b);
      }

      /**
         generate random numbers in a 2D circle of radious 1
      */
      void Circle(double &x, double &y, double r = 1) {
         Engine().Dir2D(x,y);
         x *= r;
         y *= r;
      }

      /**
         generate random numbers in a 3D sphere of radious 1
      */
      void Sphere(double &x, double &y, double &z,double r = 1) {
         Engine().Dir3D(x,y,z);
         x *= r;
         y *= r;
         z *= r;
      }

      /**
         Poisson distribution
      */
      unsigned int Poisson(double mu) {
         return Engine().Poisson(mu);
      }

      /**
         Binomial distribution
      */
      unsigned int Binomial(unsigned int ntot, double prob) {
         return Engine().Binomial(prob,ntot);
      }

      /**
         Negative Binomial distribution
         First parameter is n, second is probability
         To be consistent with Random::Binomial
      */
      unsigned int NegativeBinomial(double n, double prob) {
         return Engine().NegativeBinomial(prob,n);
      }

      /**
         Multinomial distribution
      */
      std::vector<unsigned int> Multinomial( unsigned int ntot, const std::vector<double> & p ) {
         return Engine().Multinomial(ntot,p);
      }



   };




} // namespace Math
} // namespace ROOT

#endif /* ROOT_Math_GSLRandomFunctions */