RandomStreamManager Class Reference

Manages a list of random streams for more convenient synchronization. More...

Public Member Functions
RandomStream	add (RandomStream stream)
	Adds the given stream to the internal list of this random stream manager and returns the added stream. More...
boolean	remove (RandomStream stream)
	Removes the given stream from the internal list of this random stream manager. More...
void	clear ()
	Removes all the streams from the internal list of this random stream manager.
List	getStreams ()
	Returns an unmodifiable list containing all the random streams in this random stream manager. More...
void	resetStartStream ()
	Forwards to the umontreal.ssj.rng.RandomStream.resetStartStream methods of all streams in the list.
void	resetStartSubstream ()
	Forwards to the umontreal.ssj.rng.RandomStream.resetStartSubstream methods of all streams in the list.
void	resetNextSubstream ()
	Forwards to the umontreal.ssj.rng.RandomStream.resetNextSubstream methods of all streams in the list.
String	toString ()

Detailed Description

Manages a list of random streams for more convenient synchronization.

All streams in the list can be reset simultaneously by a single call to the appropriate method of this stream manager, instead of calling explicitly the reset method for each individual stream.

After a random stream manager is constructed, any existing RandomStream object can be registered to this stream manager (i.e., added to the list) and eventually unregistered (removed from the list).

Member Function Documentation

add()

RandomStream add

(

RandomStream

stream

)

Adds the given stream to the internal list of this random stream manager and returns the added stream.

Parameters

stream

the stream being added.

Returns

the added stream.

Exceptions

NullPointerException

if stream is null.

getStreams()

List getStreams

(

)

Returns an unmodifiable list containing all the random streams in this random stream manager.

The returned list, constructed by java.util.Collections.unmodifiableList, can be assumed to contain non-null RandomStream instances.

Returns

the list of managed random streams.

remove()

boolean remove

(

RandomStream

stream

)

Removes the given stream from the internal list of this random stream manager.

Returns true if the stream was properly removed, false otherwise.

Parameters

stream

the stream being removed.

Returns

the success indicator of the operation.

---

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

• RandomStreamManager.java