XorShift1024StarPhi (Apache Commons RNG Core 1.7 API)

java.lang.Object
- org.apache.commons.rng.core.BaseProvider
- - org.apache.commons.rng.core.source64.LongProvider
  - - org.apache.commons.rng.core.source64.XorShift1024Star
    - - org.apache.commons.rng.core.source64.XorShift1024StarPhi

All Implemented Interfaces:

RandomLongSource, org.apache.commons.rng.JumpableUniformRandomProvider, org.apache.commons.rng.RestorableUniformRandomProvider, org.apache.commons.rng.UniformRandomProvider
```
public class XorShift1024StarPhi
extends XorShift1024Star
```
A fast RNG implementing the XorShift1024* algorithm.
Note: This supersedes XorShift1024Star. The sequences emitted by both generators are correlated.

This generator differs only in the final multiplier (a fixed-point representation of the golden ratio), which eliminates linear dependencies from one of the lowest bits.

Since:

1.3

See Also:

Original source code, Xorshift (Wikipedia)

Constructor Summary

Constructors
Modifier	Constructor	Description
	`XorShift1024StarPhi(long[] seed)`	Creates a new instance.
`protected`	`XorShift1024StarPhi(XorShift1024StarPhi source)`	Creates a copy instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

protected XorShift1024StarPhi copy()
Create a copy.
- Methods inherited from class org.apache.commons.rng.core.source64.XorShift1024Star
  getStateInternal, jump, next, setStateInternal
- Methods inherited from class org.apache.commons.rng.core.source64.LongProvider
  nextBoolean, nextInt, nextLong, resetCachedState
- Methods inherited from class org.apache.commons.rng.core.BaseProvider
  checkIndex, checkStateSize, composeStateInternal, extendSeed, extendSeed, fillState, fillState, restoreState, saveState, splitStateInternal, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
- Methods inherited from interface org.apache.commons.rng.JumpableUniformRandomProvider
  jumps, jumps
- Methods inherited from interface org.apache.commons.rng.UniformRandomProvider
  doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, nextBoolean, nextBytes, nextBytes, nextDouble, nextDouble, nextDouble, nextFloat, nextFloat, nextFloat, nextInt, nextInt, nextInt, nextLong, nextLong, nextLong

- Constructor Detail
  - XorShift1024StarPhi
```
public XorShift1024StarPhi(long[] seed)
```
    Creates a new instance.
    
    Parameters:
    
    seed - Initial seed. If the length is larger than 16, only the first 16 elements will be used; if smaller, the remaining elements will be automatically set. A seed containing all zeros will create a non-functional generator.
  - XorShift1024StarPhi
```
protected XorShift1024StarPhi(XorShift1024StarPhi source)
```
    Creates a copy instance.
    
    Parameters:
    
    source - Source to copy.
- Method Detail
  - copy
```
protected XorShift1024StarPhi copy()
```
    Create a copy.
    
    Overrides:
    
    copy in class XorShift1024Star
    
    Returns:
    
    the copy