RMap

class RMap<K, V>(map: Map<K, V>, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider) : Map<K, V> , RElementIfc<V> , RElementInstanceIfc<V> (source)

Permits random sampling of the elements from the map. Elements are randomly sampled with equal probability based on the number of elements in the map. There must be at least one element to permit random sampling.

Constructors

RMap

constructor(map: Map<K, V>, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider)

Properties

advanceToNextSubStreamOption

open override var advanceToNextSubStreamOption: Boolean

If true, the stream will automatically participate in having its stream advanced to the next sub-stream via stream managers

antithetic

open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

randomElement

open override val randomElement: V

Selected a value equally likely from the map

resetStartStreamOption

open override var resetStartStreamOption: Boolean

If true, the stream will automatically participate in having its stream reset to its start stream via stream managers

streamNumber

open override val streamNumber: Int

Functions

advanceToNextSubStream

open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

instance

open override fun instance(streamNum: Int, rnStreamProvider: RNStreamProviderIfc): RElementIfc<V>

resetStartStream

open override fun resetStartStream()

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

resetStartSubStream

open override fun resetStartSubStream()

Resets the position of the RNG at the start of the current substream