IG::Num::RandGeneratorThreadSafe Class Reference

Generator of uniformly distributed random numbers. Based on the default random generator. Instance members are thread safe! More...

Inheritance diagram for IG::Num::RandGeneratorThreadSafe:

Collaboration diagram for IG::Num::RandGeneratorThreadSafe:

List of all members.

Public Member Functions
	RandGeneratorThreadSafe ()
	Initializes a new instance of random generator, using a time-dependent default seed value.
	RandGeneratorThreadSafe (int seed)
	Initializes a new instance of random generator, using the specified seed value.
override double	NextDouble ()
	A double-precision floating point number greater than or equal to 0.0, and LESS THAN 1.0.
override double	NextDouble (double maxValue)
	A double-precision floating point number greater than or equal to 0.0, and LESS than the specified maximum.
override double	NextDouble (double minValue, double maxValue)
	A double-precision floating point number greater than or equal to the specified minimum, and LESS THAN the specified maximum.
override double	NextDoubleInclusive ()
	A double-precision floating point number greater than or equal to 0.0, and LESS OR EQUAL than 1.0.
override double	NextDoubleInclusive (double maxValue)
	A double-precision floating point number greater than or equal to 0.0, and LESS OR EQUAL than the specified maximum.
override double	NextDoubleInclusive (double minValue, double maxValue)
	A double-precision floating point number greater than or equal to the specified minimum, and LESS OR EQUAL than the specified maximum.
override int	Next ()
	Returns a nonnegative random number.
override int	Next (int maxValue)
	Returns a nonnegative random number LESS THAN the specified maximum.
override int	Next (int minValue, int maxValue)
	Returns a random number within a specified range (lower bound inclusive, UPPER BOUND EXCLUSIVE).
override int	NextInclusive (int maxValue)
	Returns a nonnegative random number LESS OR EQUAL the specified maximum.
override int	NextInclusive (int minValue, int maxValue)
	Returns a random number within a specified range (lower bound inclusive, upper bound INCLUSIVE).
override void	NextBytes (byte[] buffer)
	Fills the elements of a specified array of bytes with random numbers.
Protected Attributes
object	_lock = new Object()
Properties
object	Lock [get]
	Gets an object used for locking of the current object.

---

Detailed Description

Generator of uniformly distributed random numbers. Based on the default random generator. Instance members are thread safe!

---

Constructor & Destructor Documentation

IG::Num::RandGeneratorThreadSafe::RandGeneratorThreadSafe

(

)

[inline]

Initializes a new instance of random generator, using a time-dependent default seed value.

IG::Num::RandGeneratorThreadSafe::RandGeneratorThreadSafe

(

int

seed

)

[inline]

Initializes a new instance of random generator, using the specified seed value.

Parameters:

seed	A number used to calculate a starting value for the pseudo-random number sequence. If a negative number is specified, the absolute value of the number is used.

---

Member Function Documentation

override double IG::Num::RandGeneratorThreadSafe::NextDouble

(

)

[inline]

A double-precision floating point number greater than or equal to 0.0, and LESS THAN 1.0.

Returns:

A double-precision floating point number greater than or equal to 0.0, and less than 1.0.

Implements IG::Num::IRandomGenerator.

override double IG::Num::RandGeneratorThreadSafe::NextDouble

(

double

maxValue

)

[inline]

A double-precision floating point number greater than or equal to 0.0, and LESS than the specified maximum.

Returns:

A double-precision floating point number greater than or equal to 0.0, and LESS THAN THE SPECIFIED MAXIMUM.

Implements IG::Num::IRandomGenerator.

override double IG::Num::RandGeneratorThreadSafe::NextDouble	(	double	minValue,
		double	maxValue
	)		[inline]

A double-precision floating point number greater than or equal to the specified minimum, and LESS THAN the specified maximum.

Returns:

A double-precision floating point number greater than or equal to the specified minimum, and LESS than the specified maximum.

Implements IG::Num::IRandomGenerator.

override double IG::Num::RandGeneratorThreadSafe::NextDoubleInclusive

(

)

[inline]

A double-precision floating point number greater than or equal to 0.0, and LESS OR EQUAL than 1.0.

Returns:

A double-precision floating point number greater than or equal to 0.0, and less than 1.0.

Implements IG::Num::IRandomGenerator.

override double IG::Num::RandGeneratorThreadSafe::NextDoubleInclusive

(

double

maxValue

)

[inline]

A double-precision floating point number greater than or equal to 0.0, and LESS OR EQUAL than the specified maximum.

Returns:

A double-precision floating point number greater than or equal to 0.0, and LESS OR EQUAL THAN THE SPECIFIED MAXIMUM.

Implements IG::Num::IRandomGenerator.

override double IG::Num::RandGeneratorThreadSafe::NextDoubleInclusive	(	double	minValue,
		double	maxValue
	)		[inline]

A double-precision floating point number greater than or equal to the specified minimum, and LESS OR EQUAL than the specified maximum.

Returns:

A double-precision floating point number greater than or equal to the specified minimum, and LESS OR EQUAL than the specified maximum.

Implements IG::Num::IRandomGenerator.

override int IG::Num::RandGeneratorThreadSafe::Next

(

)

[inline]

Returns a nonnegative random number.

Returns:

A 32-bit signed integer greater than or equal to zero and less than MaxValue.

Implements IG::Num::IRandomGenerator.

override int IG::Num::RandGeneratorThreadSafe::Next

(

int

maxValue

)

[inline]

Returns a nonnegative random number LESS THAN the specified maximum.

Parameters:

maxValue

The EXCLUSIVE upper bound of the random number to be generated. Must be greater than or equal to zero.

Returns:

A 32-bit signed integer greater than or equal to zero, and LESS THAN maxValue. If maxValue equals zero, maxValue is returned.

Implements IG::Num::IRandomGenerator.

override int IG::Num::RandGeneratorThreadSafe::Next	(	int	minValue,
		int	maxValue
	)		[inline]

Returns a random number within a specified range (lower bound inclusive, UPPER BOUND EXCLUSIVE).

Parameters:

minValue	The inclusive lower bound of the random number returned.
maxValue	The EXCLUSIVE UPPER BOUND of the random number returned. Must be greater than or equal to minValue.

Returns:

A 32-bit signed integer greater than or equal to minValue and less than maxValue. If minValue equals maxValue, minValue is returned.

Implements IG::Num::IRandomGenerator.

override int IG::Num::RandGeneratorThreadSafe::NextInclusive

(

int

maxValue

)

[inline]

Returns a nonnegative random number LESS OR EQUAL the specified maximum.

Parameters:

maxValue

The INCLUSIVE upper bound of the random number to be generated. Must be greater than or equal to zero.

Returns:

A 32-bit signed integer greater than or equal to zero, and LESS OR EQUAL than maxValue. If maxValue equals zero, maxValue is returned.

Implements IG::Num::IRandomGenerator.

override int IG::Num::RandGeneratorThreadSafe::NextInclusive	(	int	minValue,
		int	maxValue
	)		[inline]

Returns a random number within a specified range (lower bound inclusive, upper bound INCLUSIVE).

Parameters:

minValue	he inclusive lower bound of the random number returned.
maxValue	The INCLUSIVE upper bound of the random number returned. Must be greater than or equal to minValue.

Returns:

A 32-bit signed integer greater than or equal to minValue and LESS OR EQUAL than maxValue. If minValue equals maxValue, minValue is returned.

Implements IG::Num::IRandomGenerator.

override void IG::Num::RandGeneratorThreadSafe::NextBytes

(

byte[]

buffer

)

[inline]

Fills the elements of a specified array of bytes with random numbers.

Parameters:

buffer

An array of bytes to contain random numbers.

Implements IG::Num::IRandomGenerator.

---

Member Data Documentation

object IG::Num::RandGeneratorThreadSafe::_lock = new Object() [protected]

---

Property Documentation

object IG::Num::RandGeneratorThreadSafe::Lock [get]

Gets an object used for locking of the current object.

Implements IG::Lib::ILockable.

---

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

• Random.cs