yarp::math::RandnScalar Class Reference

A random number generator, normal distribution. More...

#include <yarp/math/RandnScalar.h>

Public Member Functions
	RandnScalar ()
	Constructor.
	~RandnScalar ()
	RandnScalar (int seed)
	Constructor, initialize the generator.
void	init ()
	Initialize the generator.
void	init (int seed)
	Initialize the generator.
long	getSeed ()
double	get (double u=0.0, double sigma=1.0)
	Generate a randomly generated number, drawn from a normal distribution.

Detailed Description

A random number generator, normal distribution.

Uses the RandScalar class and the Box-Muller algorithm.

Definition at line 21 of file RandnScalar.h.

Constructor & Destructor Documentation

RandnScalar() [1/2]

RandnScalar::RandnScalar

(

)

Constructor.

Definition at line 22 of file RandnScalar.cpp.

~RandnScalar()

RandnScalar::~RandnScalar

(

)

Definition at line 34 of file RandnScalar.cpp.

RandnScalar() [2/2]

RandnScalar::RandnScalar

(

int

seed

)

Constructor, initialize the generator.

Parameters

seed,seed

for the rnd generator.

Definition at line 28 of file RandnScalar.cpp.

Member Function Documentation

get()

double RandnScalar::get	(	double	u = 0.0,
		double	sigma = 1.0
	)

Generate a randomly generated number, drawn from a normal distribution.

Parameters

u	mean of the distribution, default 0.0
sigma	sigma of the distribution, default 1.0

Returns

the random number.

Definition at line 55 of file RandnScalar.cpp.

getSeed()

long yarp::math::RandnScalar::getSeed ( )

inline

Definition at line 63 of file RandnScalar.h.

init() [1/2]

void RandnScalar::init

(

)

Initialize the generator.

Uses current time for the seed.

Definition at line 40 of file RandnScalar.cpp.

init() [2/2]

void RandnScalar::init

(

int

seed

)

Initialize the generator.

Provide a seed.

Parameters

seed

the seed

Definition at line 47 of file RandnScalar.cpp.

---

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

• src/libYARP_math/src/yarp/math/RandnScalar.h
• src/libYARP_math/src/yarp/math/RandnScalar.cpp