MultiplyWithCarry256 (nosqlbench)

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source32.IntProvider

org.apache.commons.rng.core.source32.MultiplyWithCarry256

All Implemented Interfaces:: RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider

public class MultiplyWithCarry256
extends IntProvider

Port from Marsaglia's "Multiply-With-Carry" algorithm.

Implementation is based on the (non-portable!) C code reproduced on that page.

Since:: 1.0
See Also:: Multiply with carry (Wikipedia)

Constructor Summary

Constructors

Constructor Description

MultiplyWithCarry256(int[] seed)
Creates a new instance.

Method Summary

Modifier and Type	Method	Description
`protected byte[]`	`getStateInternal()`	Creates a snapshot of the RNG state.
`int`	`next()`
`protected void`	`setStateInternal(byte[] s)`	Resets the RNG to the given `state`.

Methods inherited from class org.apache.commons.rng.core.source32.IntProvider

nextBoolean, nextBytes, nextBytes, nextDouble, nextFloat, nextInt, nextLong

Methods inherited from class org.apache.commons.rng.core.BaseProvider

checkIndex, checkStateSize, composeStateInternal, fillState, fillState, nextInt, nextLong, restoreState, saveState, splitStateInternal, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- MultiplyWithCarry256
  
  public MultiplyWithCarry256(int[] seed)
  
  Creates a new instance.
  
  Parameters:
  
  seed - Seed. If the length is larger than 257, only the first 257 elements will be used; if smaller, the remaining elements will be automatically set.
Method Details
- getStateInternal
  
  protected byte[] getStateInternal()
  
  Creates a snapshot of the RNG state.
  
  Overrides:
  
  getStateInternal in class IntProvider
  
  Returns:
  
  the internal state.
- setStateInternal
  
  protected void setStateInternal(byte[] s)
  
  Resets the RNG to the given state.
  
  Overrides:
  
  setStateInternal in class IntProvider
  
  Parameters:
  
  s - State (previously obtained by a call to BaseProvider.getStateInternal()).
  
  See Also:
  
  BaseProvider.checkStateSize(byte[],int)
- next
  
  public int next()
  
  Returns:
  
  the next random value.