/usr/include/root/Math/Random.h is in libroot-math-mathmore-dev 5.34.14-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | // @(#)root/mathmore:$Id$
// Author: L. Moneta, A. Zsenei 08/2005
/**********************************************************************
* *
* Copyright (c) 2004 ROOT Foundation, CERN/PH-SFT *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This library 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 *
* along with this library (see file COPYING); if not, write *
* to the Free Software Foundation, Inc., 59 Temple Place, Suite *
* 330, Boston, MA 02111-1307 USA, or contact the author. *
* *
**********************************************************************/
// Header file for class GSLRandom
//
// Created by: moneta at Sun Nov 21 16:26:03 2004
//
// Last update: Sun Nov 21 16:26:03 2004
//
#ifndef ROOT_Math_Random
#define ROOT_Math_Random
#include <string>
#include <vector>
/**
@defgroup Random Random number generators and distributions
*/
namespace ROOT {
namespace Math {
//_____________________________________________________________________________________
/**
User class for MathMore random numbers template on the Engine type.
The API of this class followed that of the class ROOT::TRandom.
It must be implemented using as Engine one of the derived classes of
ROOT::Math::GSLRandomEngine, like ROOT::Math::GSLRngMT
@ingroup Random
*/
template < class Engine>
class Random {
public:
/**
Create a Random generator. Use default engine constructor.
Engine will be initialized via Initialize() function in order to
allocate resources
*/
Random() {
fEngine.Initialize();
}
/**
Create a Random generator based using teh default enfing constructor and
then setting the given seed.
Engine will be initialized via Initialize() function in order to
allocate resources
*/
explicit Random(unsigned int seed) {
fEngine.Initialize();
fEngine.SetSeed(seed);
}
/**
Create a Random generator based on a provided generic engine.
Engine will be initialized via Initialize() function in order to
allocate resources
*/
explicit Random(const Engine & e) : fEngine(e) {
fEngine.Initialize();
}
/**
Destructor: call Terminate() function of engine to free any
allocated resource
*/
~Random() {
fEngine.Terminate();
}
/**
Generate random numbers between ]0,1]
0 is excluded and 1 is included
*/
double Uniform(double x=1.0) {
return x*fEngine();
}
/**
Generate random numbers between ]0,1]
0 is excluded and 1 is included
Function to preserve ROOT Trandom compatibility
*/
double Rndm() {
return fEngine();
}
/**
Generate an array of random numbers between ]0,1]
0 is excluded and 1 is included
Function to preserve ROOT Trandom compatibility
*/
void RndmArray(int n, double * array) {
fEngine.RandomArray(array, array+n);
}
/**
Return the type (name) of the used generator
*/
std::string Type() const {
return fEngine.Name();
}
/**
Return the size of the generator state
*/
unsigned int EngineSize() const {
return fEngine.Size();
}
/**
set the random generator seed
*/
void SetSeed(unsigned int seed) {
return fEngine.SetSeed(seed);
}
/** Random Distributions
Use naming and signatures compatible with ROOT TRandom
**/
/**
Gaussian distribution. Default method (use Ziggurat)
*/
double Gaus(double mean = 0, double sigma = 1) {
return mean + fEngine.GaussianZig(sigma);
}
/**
Gaussian distribution (Box-Muller method)
*/
double GausBM(double mean = 0, double sigma = 1) {
return mean + fEngine.Gaussian(sigma);
}
/**
Gaussian distribution (Ratio Method)
*/
double GausR(double mean = 0, double sigma = 1) {
return mean + fEngine.GaussianRatio(sigma);
}
/**
Gaussian Tail distribution
*/
double GaussianTail(double a, double sigma = 1) {
return fEngine.GaussianTail(a,sigma);
}
/**
Bivariate Gaussian distribution with correlation
*/
void Gaussian2D(double sigmaX, double sigmaY, double rho, double &x, double &y) {
fEngine.Gaussian2D(sigmaX, sigmaY, rho, x, y);
}
/**
Exponential distribution
*/
double Exp(double tau) {
return fEngine.Exponential(tau);
}
/**
Breit Wigner distribution
*/
double BreitWigner(double mean = 0., double gamma = 1) {
return mean + fEngine.Cauchy( gamma/2.0 );
}
/**
Landau distribution
*/
double Landau(double mean = 0, double sigma = 1) {
return mean + sigma*fEngine.Landau();
}
/**
Gamma distribution
*/
double Gamma(double a, double b) {
return fEngine.Gamma(a,b);
}
/**
Log Normal distribution
*/
double LogNormal(double zeta, double sigma) {
return fEngine.LogNormal(zeta,sigma);
}
/**
Chi square distribution
*/
double ChiSquare(double nu) {
return fEngine.ChiSquare(nu);
}
/**
F distrbution
*/
double FDist(double nu1, double nu2) {
return fEngine.FDist(nu1,nu2);
}
/**
t student distribution
*/
double tDist(double nu) {
return fEngine.tDist(nu);
}
/**
generate random numbers in a 2D circle of radious 1
*/
void Circle(double &x, double &y, double r = 1) {
fEngine.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) {
fEngine.Dir3D(x,y,z);
x *= r;
y *= r;
z *= r;
}
/**
Poisson distribution
*/
unsigned int Poisson(double mu) {
return fEngine.Poisson(mu);
}
/**
Binomial distribution
*/
unsigned int Binomial(unsigned int ntot, double prob) {
return fEngine.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 fEngine.NegativeBinomial(prob,n);
}
/**
Multinomial distribution
*/
std::vector<unsigned int> Multinomial( unsigned int ntot, const std::vector<double> & p ) {
return fEngine.Multinomial(ntot,p);
}
private:
Engine fEngine;
};
} // namespace Math
} // namespace ROOT
#ifndef ROOT_Math_GSLRndmEngines
#include "Math/GSLRndmEngines.h"
#endif
namespace ROOT {
namespace Math {
typedef Random<ROOT::Math::GSLRngMT> RandomMT;
typedef Random<ROOT::Math::GSLRngTaus> RandomTaus;
typedef Random<ROOT::Math::GSLRngRanLux> RandomRanLux;
typedef Random<ROOT::Math::GSLRngGFSR4> RandomGFSR4;
} // namespace Math
} // namespace ROOT
#endif /* ROOT_Math_Random */
|