Logo ROOT   6.19/01
Reference Guide
ROOT::Math::GSLRngROOTWrapper< Engine > Struct Template Reference

template<class Engine>
struct ROOT::Math::GSLRngROOTWrapper< Engine >

class for wrapping ROOT Engines in gsl_rng types which can be used as extra GSL random number generators For this we need to implment functions which will be called by gsl_rng.

The functions (Seed, Rndm, IntRndm) are passed in the gsl_rng_type and used to build a gsl_rng object. When gsl_rng is alloacated, only the memory state is allocated using calloc(1,size), which gives a memory block of the given bytes and it initializes to zero. Therefore no constructor of GSLRngROOTWrapper can be called and also we cannot call non-static member funciton of the class. The underlined ROOT engine is then built and deleted using the functions CreateEngine() and FreeEngine(), called by the specific GSLRandomEngine class that instantiates for the the generator (e.g. GSLRngMixMax)

Definition at line 38 of file GSLRngROOTWrapper.h.

Static Public Member Functions

static void CreateEngine (gsl_rng *r)
 
static void FreeEngine (gsl_rng *r)
 
static unsigned long IntRndm (void *p)
 
static unsigned long Max ()
 
static unsigned long Min ()
 
static std::string Name ()
 
static double Rndm (void *p)
 
static void Seed (void *p, unsigned long seed)
 
static size_t Size ()
 

Public Attributes

Engine * fEngine = nullptr
 

#include </mnt/build/workspace/root-makedoc/rootspi/rdoc/src/master/math/mathmore/src/GSLRngROOTWrapper.h>

Member Function Documentation

◆ CreateEngine()

template<class Engine >
static void ROOT::Math::GSLRngROOTWrapper< Engine >::CreateEngine ( gsl_rng *  r)
inlinestatic

Definition at line 45 of file GSLRngROOTWrapper.h.

◆ FreeEngine()

template<class Engine >
static void ROOT::Math::GSLRngROOTWrapper< Engine >::FreeEngine ( gsl_rng *  r)
inlinestatic

Definition at line 70 of file GSLRngROOTWrapper.h.

◆ IntRndm()

template<class Engine >
static unsigned long ROOT::Math::GSLRngROOTWrapper< Engine >::IntRndm ( void p)
inlinestatic

Definition at line 56 of file GSLRngROOTWrapper.h.

◆ Max()

template<class Engine >
static unsigned long ROOT::Math::GSLRngROOTWrapper< Engine >::Max ( )
inlinestatic

Definition at line 78 of file GSLRngROOTWrapper.h.

◆ Min()

template<class Engine >
static unsigned long ROOT::Math::GSLRngROOTWrapper< Engine >::Min ( )
inlinestatic

Definition at line 79 of file GSLRngROOTWrapper.h.

◆ Name()

template<class Engine >
static std::string ROOT::Math::GSLRngROOTWrapper< Engine >::Name ( )
inlinestatic

Definition at line 81 of file GSLRngROOTWrapper.h.

◆ Rndm()

template<class Engine >
static double ROOT::Math::GSLRngROOTWrapper< Engine >::Rndm ( void p)
inlinestatic

Definition at line 55 of file GSLRngROOTWrapper.h.

◆ Seed()

template<class Engine >
static void ROOT::Math::GSLRngROOTWrapper< Engine >::Seed ( void p,
unsigned long  seed 
)
inlinestatic

Definition at line 58 of file GSLRngROOTWrapper.h.

◆ Size()

template<class Engine >
static size_t ROOT::Math::GSLRngROOTWrapper< Engine >::Size ( )
inlinestatic

Definition at line 80 of file GSLRngROOTWrapper.h.

Member Data Documentation

◆ fEngine

template<class Engine >
Engine* ROOT::Math::GSLRngROOTWrapper< Engine >::fEngine = nullptr

Definition at line 40 of file GSLRngROOTWrapper.h.


The documentation for this struct was generated from the following file: