EGS_Sobol Class Reference

EGS_RandomGenerator wrapper for Sobol library. More...

#include <egs_sobol.h>

Inheritance diagram for EGS_Sobol:

Collaboration diagram for EGS_Sobol:

Public Member Functions
	EGS_Sobol (EGS_Input *inp)
	EGS_Sobol (int dimension=3, EGS_I64 iseed=-1)
	EGS_Sobol (const EGS_Sobol &r)
	~EGS_Sobol ()
void	fillArray (int n, EGS_Float *array)
	Fill the array pointed to by array with random numbers.
void	describeRNG () const
	Output information about this RNG using egsInformation()
EGS_RandomGenerator *	getCopy ()
void	setState (EGS_RandomGenerator *r)
void	saveState ()
void	resetState ()
int	rngSize () const

Protected Member Functions
bool	storePrivateState (ostream &data)
bool	setPrivateState (istream &data)

Private Member Functions
void	setState (int dimension, EGS_I64 init_seed)

Private Attributes
int	dim
EGS_I64	init_seed
EGS_I64	cur_seed
	initial seed for random number generator
EGS_Sobol *	copy
	current seed being used for random number generator (required to reinitialize

Detailed Description

EGS_RandomGenerator wrapper for Sobol library.

Definition at line 71 of file egs_sobol.h.

Constructor & Destructor Documentation

EGS_Sobol() [1/3]

EGS_Sobol::EGS_Sobol ( EGS_Input *  inp )

inline

Definition at line 75 of file egs_sobol.h.

EGS_Sobol() [2/3]

EGS_Sobol::EGS_Sobol ( int  dimension = 3, EGS_I64  iseed = -1  )

inline

Definition at line 94 of file egs_sobol.h.

EGS_Sobol() [3/3]

EGS_Sobol::EGS_Sobol ( const EGS_Sobol &  r )

inline

Definition at line 108 of file egs_sobol.h.

~EGS_Sobol()

EGS_Sobol::~EGS_Sobol ( )

inline

Definition at line 114 of file egs_sobol.h.

Member Function Documentation

describeRNG()

void EGS_Sobol::describeRNG

(

)

const

Output information about this RNG using egsInformation()

Definition at line 108 of file egs_sobol.cpp.

fillArray()

void EGS_Sobol::fillArray	(	int	n,
		EGS_Float *	array
	)

Fill the array pointed to by array with random numbers.

Definition at line 130 of file egs_sobol.cpp.

getCopy()

EGS_RandomGenerator * EGS_Sobol::getCopy

(

)

Definition at line 56 of file egs_sobol.cpp.

resetState()

void EGS_Sobol::resetState

(

)

Definition at line 50 of file egs_sobol.cpp.

rngSize()

int EGS_Sobol::rngSize ( ) const

inline

Definition at line 136 of file egs_sobol.h.

saveState()

void EGS_Sobol::saveState

(

)

Definition at line 40 of file egs_sobol.cpp.

setPrivateState()

bool EGS_Sobol::setPrivateState ( istream &  data )

protected

Reads the same data stored by storePrivateState()

Definition at line 89 of file egs_sobol.cpp.

setState() [1/2]

void EGS_Sobol::setState

(

EGS_RandomGenerator *

r

)

Definition at line 62 of file egs_sobol.cpp.

setState() [2/2]

void EGS_Sobol::setState ( int  dimension, EGS_I64  init_seed  )

private

Definition at line 118 of file egs_sobol.cpp.

storePrivateState()

bool EGS_Sobol::storePrivateState ( ostream &  data )

protected

Stores the pointers ix and jx, the carry c, the initial seeds that were used to initialize the generator and the 97 element array u.

Definition at line 74 of file egs_sobol.cpp.

Member Data Documentation

copy

EGS_Sobol* EGS_Sobol::copy

private

current seed being used for random number generator (required to reinitialize

Definition at line 159 of file egs_sobol.h.

cur_seed

EGS_I64 EGS_Sobol::cur_seed

private

initial seed for random number generator

Definition at line 157 of file egs_sobol.h.

dim

int EGS_Sobol::dim

private

Definition at line 155 of file egs_sobol.h.

init_seed

EGS_I64 EGS_Sobol::init_seed

private

Definition at line 156 of file egs_sobol.h.

---

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

• /Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/egs_sobol.h
• /Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/egs_sobol.cpp