ROOT::Math::GSLRngWrapper Class Reference

Description

GSLRngWrapper class to wrap gsl_rng structure

Definition at line 25 of file GSLRngWrapper.h.

Public Member Functions
	GSLRngWrapper ()
	GSLRngWrapper (const gsl_rng *r)
	GSLRngWrapper (const gsl_rng_type *type)
	GSLRngWrapper (GSLRngWrapper &r)
	~GSLRngWrapper ()
void	Allocate ()
void	Free ()
GSLRngWrapper &	operator= (const GSLRngWrapper &rhs)
void	PrintState () const
gsl_rng *	Rng ()
const gsl_rng *	Rng () const
void	SetDefaultType ()
void	SetType (const gsl_rng_type *type)

Private Attributes
bool	fOwn
gsl_rng *	fRng
const gsl_rng_type *	fRngType

Constructor & Destructor Documentation

GSLRngWrapper() [1/4]

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

inline

Default constructor

Definition at line 33 of file GSLRngWrapper.h.

                    :
      fOwn(0),
      fRng(0),
      fRngType(0)
    {
    }

GSLRngWrapper() [2/4]

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

inline

Constructor with type

Definition at line 43 of file GSLRngWrapper.h.

                                            :
      fOwn(1),
      fRng(0),
      fRngType(type)
    {
    }

GSLRngWrapper() [3/4]

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.

                                     :
      fOwn(0),
      fRngType(0)
    {
       fRng = const_cast<gsl_rng *>(r);
    }

References fRng.

GSLRngWrapper() [4/4]

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

inline

Copy constructor - clone the GSL object and manage it

Definition at line 64 of file GSLRngWrapper.h.

                                    :
      fOwn(1),
      fRngType(r.fRngType)
   {
      fRng = gsl_rng_clone(r.fRng);
   }

References fRng.

~GSLRngWrapper()

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

inline

Destructor (free the rng if not done before)

Definition at line 92 of file GSLRngWrapper.h.

                     {
       if (fOwn) Free();
    }

References fOwn, and Free().

Here is the call graph for this function:

Member Function Documentation

Allocate()

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

inline

Definition at line 96 of file GSLRngWrapper.h.

                    {
      if (fRngType == 0) SetDefaultType();
      if (fRng != 0 && fOwn) Free();
      fRng = gsl_rng_alloc( fRngType );
      fOwn = true;
    }

References fOwn, Free(), fRng, fRngType, and SetDefaultType().

Here is the call graph for this function:

Free()

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

inline

Definition at line 103 of file GSLRngWrapper.h.

                {
       if (!fOwn) return; // no operation if pointer is not own
      //std::cout << "free gslrng " << fRngType <<  "  " << fRng <<  std::endl;
      if (fRng != 0) gsl_rng_free(fRng);
      fRng = 0;
    }

References fOwn, and fRng.

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

operator=()

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

inline

Assignment operator

Definition at line 74 of file GSLRngWrapper.h.

                                                           {
      if (this == &rhs) return *this;  // time saving self-test
      fRngType = rhs.fRngType;
      int iret = 0;
      if (fRngType == rhs.fRngType) {
         iret = gsl_rng_memcpy(fRng, rhs.fRng);
         if (!iret) return *this;
      }
      // otherwise create a new copy
      if (fOwn) Free();
      fRng = gsl_rng_clone(rhs.fRng);
      fOwn = true;
      return *this;
   }

References fOwn, Free(), fRng, and fRngType.

Here is the call graph for this function:

PrintState()

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

inline

Definition at line 121 of file GSLRngWrapper.h.

                           {
      gsl_rng_print_state(fRng);
   }

References fRng.

Rng() [1/2]

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

inline

Definition at line 125 of file GSLRngWrapper.h.

{ return fRng; }

References fRng.

Rng() [2/2]

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

inline

Definition at line 127 of file GSLRngWrapper.h.

{ return fRng; }

References fRng.

SetDefaultType()

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

inline

Definition at line 115 of file GSLRngWrapper.h.

                          {
      // construct default engine
      gsl_rng_env_setup();
      fRngType =  gsl_rng_default;
    }

References fRngType.

Referenced by Allocate().

SetType()

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

inline

Definition at line 111 of file GSLRngWrapper.h.

                                            {
      fRngType = type;
    }

References fRngType.

Member Data Documentation

fOwn

bool ROOT::Math::GSLRngWrapper::fOwn

private

Definition at line 133 of file GSLRngWrapper.h.

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

fRng

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

private

Definition at line 134 of file GSLRngWrapper.h.

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

fRngType

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:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/mathcore/Math/GSLRngWrapper.h