NanoMagMC  v0.2
Monte Carlo Simulation Software for Atomistic Models of Magnetic Materials
Public Member Functions | List of all members
stdrand::std_lognormrand Class Reference

Generator for random numbers on a lognormal distribution. More...

#include <stdrand.hpp>

Inheritance diagram for stdrand::std_lognormrand:
Inheritance graph
[legend]
Collaboration diagram for stdrand::std_lognormrand:
Collaboration graph
[legend]

Public Member Functions

 std_lognormrand (double m, double sdin, int seed)
 Constructor. More...
 
 std_lognormrand (double m, double sdin, int size, int seed)
 Constructor with dummy size. More...
 
 ~std_lognormrand ()
 Default destructor. More...
 
double gen ()
 Return a single random number. More...
 
- Public Member Functions inherited from stdrand::std_randbase
 std_randbase ()
 Default constructor. More...
 
 ~std_randbase ()
 Default destructor. More...
 
void change_seed (int seed)
 Change the current random seed. More...
 
void jump ()
 Jump forward 2^64 places. More...
 

Additional Inherited Members

- Protected Attributes inherited from stdrand::std_randbase
rng::rng128 generator
 

Detailed Description

Generator for random numbers on a lognormal distribution.

Constructor & Destructor Documentation

stdrand::std_lognormrand::std_lognormrand ( double  m,
double  sdin,
int  seed 
)

Constructor.

Parameters
mThe logarithmic mean of the lognormal distribution.
sdinThe logarithmic standard deviation of the lognormal distribution.
seedThe inital seed of the random number generator.
stdrand::std_lognormrand::std_lognormrand ( double  m,
double  sdin,
int  size,
int  seed 
)
inline

Constructor with dummy size.

Parameters
mThe logarithmic mean of the lognormal distribution.
sdinThe logarithmic standard deviation of the lognormal distribution.
seedThe inital seed of the random number generator.
sizeA dummy size input for compatibility with Intel RNG.
stdrand::std_lognormrand::~std_lognormrand ( )
inline

Default destructor.

Member Function Documentation

double stdrand::std_lognormrand::gen ( )
inlinevirtual

Return a single random number.

Reimplemented from stdrand::std_randbase.


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