BasicRandomStreamFactory Class Reference

Represents a basic random stream factory that can constructs new instances of a given RandomStream implementation via the newInstance method. More...

Inheritance diagram for BasicRandomStreamFactory:

Collaboration diagram for BasicRandomStreamFactory:

Public Member Functions
	BasicRandomStreamFactory (Class rsClass)
	Constructs a new basic random stream factory with random stream class rsClass. More...
Class	getRandomStreamClass ()
	Returns the random stream class associated with this object. More...
void	setRandomStreamClass (Class rsClass)
	Sets the associated random stream class to rsClass. More...
RandomStream	newInstance ()
	Constructs and returns a new random stream. More...
String	toString ()

Detailed Description

Represents a basic random stream factory that can constructs new instances of a given RandomStream implementation via the newInstance method.

The class name of the implementation to be used must be passed to the constructor as a String, which must be the name of a nullary constructor of a RandomStream object (i.e., a constructor that has no parameters). The streams are constructed by the factory by reflection from this String.

Constructor & Destructor Documentation

BasicRandomStreamFactory()

BasicRandomStreamFactory

(

Class

rsClass

)

Constructs a new basic random stream factory with random stream class rsClass.

The supplied class object must represent an implementation of RandomStream and must provide a nullary constructor. For example, to construct a factory producing MRG32k3a random streams, this constructor must be called with MRG33k3a.class.

Parameters

rsClass

the random stream class being used.

Exceptions

NullPointerException	if rsClass is null.
IllegalArgumentException	if rsClass does not represent an implementation of RandomStream, or does not provide a nullary constructor.

Member Function Documentation

getRandomStreamClass()

Class getRandomStreamClass

(

)

Returns the random stream class associated with this object.

Returns

the associated random stream class.

newInstance()

RandomStream newInstance

(

)

Constructs and returns a new random stream.

If the instantiation of the random stream fails, this method throws a RandomStreamInstantiationException.

Returns

the newly-constructed random stream.

Exceptions

RandomStreamInstantiationException

if the new random stream cannot be instantiated.

Implements RandomStreamFactory.

setRandomStreamClass()

void setRandomStreamClass

(

Class

rsClass

)

Sets the associated random stream class to rsClass.

The supplied class object must represent an implementation of RandomStream and must provide a nullary constructor.

Parameters

rsClass

the random stream class being used.

Exceptions

NullPointerException	if rsClass is null.
IllegalArgumentException	if rsClass does not represent an implementation of RandomStream, or does not provide a nullary constructor.

---

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

• BasicRandomStreamFactory.java