ROOT::Math::GSLRngWrapper Class Reference

GSLRngWrapper class to wrap gsl_rng structure.

Definition at line 25 of file GSLRngWrapper.h.

Public Member Functions
	GSLRngWrapper ()
	Default constructor. More...
	GSLRngWrapper (const gsl_rng_type *type)
	Constructor with type. More...
	GSLRngWrapper (const gsl_rng *r)
	construct from an existing gsl_rng it is managed externally - so will not be deleted at the end More...
	GSLRngWrapper (GSLRngWrapper &r)
	Copy constructor - clone the GSL object and manage it. More...
GSLRngWrapper &	operator= (const GSLRngWrapper &rhs)
	Assignment operator. More...
	~GSLRngWrapper ()
	Destructor (free the rng if not done before) More...
void	Allocate ()
void	Free ()
void	SetType (const gsl_rng_type *type)
void	SetDefaultType ()
void	PrintState () const
gsl_rng *	Rng ()
const gsl_rng *	Rng () const

Private Attributes
bool	fOwn
gsl_rng *	fRng
const gsl_rng_type *	fRngType

#include </mnt/vdb/lsf/workspace/root-makedoc-v606/rootspi/rdoc/src/v6-06-00-patches/math/mathmore/src/GSLRngWrapper.h>

Constructor & Destructor Documentation

ROOT::Math::GSLRngWrapper::GSLRngWrapper ( )

inline

Default constructor.

Definition at line 33 of file GSLRngWrapper.h.

ROOT::Math::GSLRngWrapper::GSLRngWrapper ( const gsl_rng_type *  type )

inline

Constructor with type.

Definition at line 43 of file GSLRngWrapper.h.

ROOT::Math::GSLRngWrapper::GSLRngWrapper ( const gsl_rng *  r )

inline

construct from an existing gsl_rng it is managed externally - so will not be deleted at the end

Definition at line 54 of file GSLRngWrapper.h.

ROOT::Math::GSLRngWrapper::GSLRngWrapper ( GSLRngWrapper &  r )

inline

Copy constructor - clone the GSL object and manage it.

Definition at line 64 of file GSLRngWrapper.h.

ROOT::Math::GSLRngWrapper::~GSLRngWrapper ( )

inline

Destructor (free the rng if not done before)

Definition at line 92 of file GSLRngWrapper.h.

Member Function Documentation

void ROOT::Math::GSLRngWrapper::Allocate ( )

inline

Definition at line 96 of file GSLRngWrapper.h.

Referenced by ROOT::Math::GSLMCIntegrator::GSLMCIntegrator(), and ROOT::Math::GSLRandomEngine::Initialize().

void ROOT::Math::GSLRngWrapper::Free ( )

inline

Definition at line 103 of file GSLRngWrapper.h.

Referenced by Allocate(), operator=(), ROOT::Math::GSLRandomEngine::Terminate(), and ~GSLRngWrapper().

GSLRngWrapper& ROOT::Math::GSLRngWrapper::operator= ( const GSLRngWrapper &  rhs )

inline

Assignment operator.

Definition at line 74 of file GSLRngWrapper.h.

void ROOT::Math::GSLRngWrapper::PrintState ( ) const

inline

Definition at line 121 of file GSLRngWrapper.h.

gsl_rng* ROOT::Math::GSLRngWrapper::Rng ( )

inline

Definition at line 125 of file GSLRngWrapper.h.

Referenced by ROOT::Math::GSLRandomEngine::Binomial(), ROOT::Math::GSLRandomEngine::Cauchy(), ROOT::Math::GSLRandomEngine::ChiSquare(), ROOT::Math::GSLRandomEngine::Dir2D(), ROOT::Math::GSLRandomEngine::Dir3D(), ROOT::Math::GSLRandomEngine::Exponential(), ROOT::Math::GSLRandomEngine::FDist(), ROOT::Math::GSLRandomEngine::Gamma(), ROOT::Math::GSLRandomEngine::Gaussian(), ROOT::Math::GSLRandomEngine::Gaussian2D(), ROOT::Math::GSLRandomEngine::GaussianRatio(), ROOT::Math::GSLRandomEngine::GaussianTail(), ROOT::Math::GSLRandomEngine::GaussianZig(), ROOT::Math::GSLMCIntegrator::Integral(), ROOT::Math::GSLRandomEngine::Landau(), ROOT::Math::GSLRandomEngine::LogNormal(), ROOT::Math::GSLRandomEngine::Multinomial(), ROOT::Math::GSLRandomEngine::Name(), ROOT::Math::GSLRandomEngine::NegativeBinomial(), ROOT::Math::GSLRandomEngine::operator()(), ROOT::Math::GSLRandomEngine::Poisson(), ROOT::Math::GSLRandomEngine::RandomArray(), ROOT::Math::GSLRandomEngine::RndmInt(), ROOT::Math::GSLRandomEngine::SetSeed(), ROOT::Math::GSLRandomEngine::Size(), and ROOT::Math::GSLRandomEngine::tDist().

const gsl_rng* ROOT::Math::GSLRngWrapper::Rng ( ) const

inline

Definition at line 127 of file GSLRngWrapper.h.

void ROOT::Math::GSLRngWrapper::SetDefaultType ( )

inline

Definition at line 115 of file GSLRngWrapper.h.

Referenced by Allocate().

void ROOT::Math::GSLRngWrapper::SetType ( const gsl_rng_type *  type )

inline

Definition at line 111 of file GSLRngWrapper.h.

Member Data Documentation

bool ROOT::Math::GSLRngWrapper::fOwn

private

Definition at line 133 of file GSLRngWrapper.h.

Referenced by Allocate(), Free(), operator=(), and ~GSLRngWrapper().

gsl_rng* ROOT::Math::GSLRngWrapper::fRng

private

Definition at line 134 of file GSLRngWrapper.h.

Referenced by Allocate(), Free(), GSLRngWrapper(), operator=(), PrintState(), and Rng().

const gsl_rng_type* ROOT::Math::GSLRngWrapper::fRngType

private

Definition at line 135 of file GSLRngWrapper.h.

Referenced by Allocate(), operator=(), SetDefaultType(), and SetType().

---

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

• math/mathmore/src/GSLRngWrapper.h