org.jenetics.util.LCG64ShiftRandom Maven / Gradle / Ivy
/*
* Java Genetic Algorithm Library (jenetics-3.2.0).
* Copyright (c) 2007-2015 Franz Wilhelmstötter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Author:
* Franz Wilhelmstötter ([email protected])
*/
package org.jenetics.util;
import static java.lang.String.format;
import static java.util.Objects.requireNonNull;
import static org.jenetics.internal.util.Equality.eq;
import java.io.Serializable;
import org.jenetics.internal.math.arithmetic;
import org.jenetics.internal.math.random;
import org.jenetics.internal.util.Equality;
import org.jenetics.internal.util.Hash;
/**
* This class implements a linear congruential PRNG with additional bit-shift
* transition. The base recursion
*
* 
*
* is followed by a non-linear transformation
*
* 
*
* which destroys the lattice structure introduced by the recursion. The period
* of this PRNG is 264, {@code iff} b is odd and a
* {@code mod} 4 = 1.
*
*
*
* This is an re-implementation of the
*
* trng::lcg64_shift PRNG class of the
* TRNG library created by Heiko
* Bauke.
*
*
* Not that the base implementation of the {@code LCG64ShiftRandom}
* class is not thread-safe. If multiple threads requests random
* numbers from this class, it must be synchronized externally.
* Alternatively you can use the thread-safe implementations
* {@link LCG64ShiftRandom.ThreadSafe} or {@link LCG64ShiftRandom.ThreadLocal}.
*
* @see TRNG
* @see RandomRegistry
*
* @author Franz Wilhelmstötter
* @since 1.1
* @version 2.0
*/
public class LCG64ShiftRandom extends Random64 {
private static final long serialVersionUID = 1L;
/**
* This class represents a thread local implementation of the
* {@code LCG64ShiftRandom} PRNG.
*
* It's recommended to initialize the {@code RandomRegistry} the following
* way:
*
*
{@code
* // Register the PRNG with the default parameters.
* RandomRegistry.setRandom(new LCG64ShiftRandom.ThreadLocal());
*
* // Register the PRNG with the {@code LECUYER3} parameters.
* RandomRegistry.setRandom(new LCG64ShiftRandom.ThreadLocal(
* LCG64ShiftRandom.LECUYER3
* ));
* }
*
* Be aware, that calls of the {@code setSeed(long)} method will throw an
* {@code UnsupportedOperationException} for thread local instances.
* {@code
* RandomRegistry.setRandom(new LCG64ShiftRandom.ThreadLocal());
*
* // Will throw 'UnsupportedOperationException'.
* RandomRegistry.getRandom().setSeed(1234);
* }
*
* @author Franz Wilhelmstötter
* @since 1.1
* @version 3.0
*/
public static final class ThreadLocal
extends java.lang.ThreadLocal
{
private static final long STEP_BASE = 1L << 56;
private int _block = 0;
private long _seed = random.seed();
private final Param _param;
/**
* Create a new thread local instance of the
* {@code LCG64ShiftRandom} PRNG with the {@code DEFAULT} parameters.
*/
public ThreadLocal() {
this(Param.DEFAULT);
}
/**
* Create a new thread local instance of the
* {@code LCG64ShiftRandom} PRNG with the given parameters.
*
* @param param the LC parameters.
* @throws NullPointerException if the given parameters are null.
*/
public ThreadLocal(final Param param) {
_param = requireNonNull(param, "PRNG param must not be null.");
}
/**
* Create a new PRNG using block splitting for guaranteeing well
* distributed PRN for every thread.
*
*
* Tina’s Random Number Generator Library
*
* Chapter 2. Pseudo-random numbers for parallel Monte Carlo
* simulations, Page 7
*
* Heiko Bauke
*
* [
* http://numbercrunch.de/trng/trng.pdf
* ].
*/
@Override
protected synchronized LCG64ShiftRandom initialValue() {
if (_block > 127) {
_block = 0;
_seed = random.seed();
}
final LCG64ShiftRandom random = new TLLCG64ShiftRandom(_seed, _param);
random.jump((_block++)*STEP_BASE);
return random;
}
}
private static final class TLLCG64ShiftRandom extends LCG64ShiftRandom {
private static final long serialVersionUID = 1L;
private final Boolean _sentry = Boolean.TRUE;
private TLLCG64ShiftRandom(final long seed, final Param param) {
super(param, seed);
}
@Override
public void setSeed(final long seed) {
if (_sentry != null) {
throw new UnsupportedOperationException(
"The 'setSeed(long)' method is not supported " +
"for thread local instances."
);
}
}
}
/**
* This is a thread safe variation of the this PRNG—by
* synchronizing the random number generation.
*
* @author Franz Wilhelmstötter
* @since 1.1
* @version 3.0
*/
public static final class ThreadSafe extends LCG64ShiftRandom {
private static final long serialVersionUID = 1L;
/**
* Create a new PRNG instance with the given parameter and seed.
*
* @param seed the seed of the PRNG.
* @param param the parameter of the PRNG.
* @throws NullPointerException if the given {@code param} is null.
*
* @deprecated Use {@code LCG64ShiftRandom.ThreadSafe(Param, long)}
* instead.
*/
@Deprecated
public ThreadSafe(final long seed, final Param param) {
super(param, seed);
}
/**
* Create a new PRNG instance with the given parameter and seed.
*
* @param seed the seed of the PRNG.
* @param param the parameter of the PRNG.
* @throws NullPointerException if the given {@code param} is null.
*/
public ThreadSafe(final Param param, final long seed) {
super(param, seed);
}
/**
* Create a new PRNG instance with {@link Param#DEFAULT} parameter and
* the given seed.
*
* @param seed the seed of the PRNG
*/
public ThreadSafe(final long seed) {
this(Param.DEFAULT, seed);
}
/**
* Create a new PRNG instance with the given parameter and a safe
* default seed.
*
* @param param the PRNG parameter.
* @throws NullPointerException if the given {@code param} is null.
*/
public ThreadSafe(final Param param) {
this(param, random.seed());
}
/**
* Create a new PRNG instance with {@link Param#DEFAULT} parameter and
* a safe seed.
*/
public ThreadSafe() {
this(Param.DEFAULT, random.seed());
}
@Override
public synchronized void setSeed(final long seed) {
super.setSeed(seed);
}
@Override
public synchronized long nextLong() {
return super.nextLong();
}
@Override
public synchronized void split(final int p, final int s) {
super.split(p, s);
}
@Override
public synchronized void jump2(final int s) {
super.jump2(s);
}
@Override
public synchronized void jump(final long step) {
super.jump(step);
}
}
/**
* Parameter class for the {@code LCG64ShiftRandom} generator, for the
* parameters a and b of the LC recursion
* ri+1 = a · ri + b mod 264.
*
* @author Franz Wilhelmstötter
* @since 1.1
* @version 2.0
*/
public static final class Param implements Serializable {
private static final long serialVersionUID = 1L;
/**
* The default PRNG parameters: a = 0xFBD19FBBC5C07FF5L; b = 1
*/
public static final Param DEFAULT = Param.of(0xFBD19FBBC5C07FF5L, 1L);
/**
* LEcuyer 1 parameters: a = 0x27BB2EE687B0B0FDL; b = 1
*/
public static final Param LECUYER1 = Param.of(0x27BB2EE687B0B0FDL, 1L);
/**
* LEcuyer 2 parameters: a = 0x2C6FE96EE78B6955L; b = 1
*/
public static final Param LECUYER2 = Param.of(0x2C6FE96EE78B6955L, 1L);
/**
* LEcuyer 3 parameters: a = 0x369DEA0F31A53F85L; b = 1
*/
public static final Param LECUYER3 = Param.of(0x369DEA0F31A53F85L, 1L);
/**
* The parameter a of the LC recursion.
*/
public final long a;
/**
* The parameter b of the LC recursion.
*/
public final long b;
/**
* Create a new parameter object.
*
* @param a the parameter a of the LC recursion.
* @param b the parameter b of the LC recursion.
*/
private Param(final long a, final long b) {
this.a = a;
this.b = b;
}
public static Param of(final long a, final long b) {
return new Param(a, b);
}
@Override
public int hashCode() {
return 31*(int)(a^(a >>> 32)) + 31*(int)(b^(b >>> 32));
}
@Override
public boolean equals(final Object obj) {
return Equality.of(this, obj).test(p -> a == p.a && b == p.b);
}
@Override
public String toString() {
return format("%s[a=%d, b=%d]", getClass().getName(), a, b);
}
}
/**
* Represents the state of this random engine
*/
private final static class State implements Serializable {
private static final long serialVersionUID = 1L;
long _r;
State(final long seed) {
setSeed(seed);
}
void setSeed(final long seed) {
_r = seed;
}
@Override
public int hashCode() {
return Hash.of(getClass()).and(_r).value();
}
@Override
public boolean equals(final Object obj) {
return Equality.of(this, obj).test(state -> state._r == _r);
}
@Override
public String toString() {
return format("State[%d]", _r);
}
}
private Param _param;
private final State _state;
/**
* Create a new PRNG instance with the given parameter and seed.
*
* @param param the parameter of the PRNG.
* @param seed the seed of the PRNG.
* @throws NullPointerException if the given {@code param} is null.
*/
public LCG64ShiftRandom(final Param param, final long seed) {
_param = requireNonNull(param, "PRNG param must not be null.");
_state = new State(seed);
}
/**
* Create a new PRNG instance with the given parameter and a safe seed
*
* @param param the PRNG parameter.
* @throws NullPointerException if the given {@code param} is null.
*/
public LCG64ShiftRandom(final Param param) {
this(param, random.seed());
}
/**
* Create a new PRNG instance with {@link Param#DEFAULT} parameter and the
* given seed.
*
* @param seed the seed of the PRNG
*/
public LCG64ShiftRandom(final long seed) {
this(Param.DEFAULT, seed);
}
/**
* Create a new PRNG instance with {@link Param#DEFAULT} parameter and safe
* seed.
*/
public LCG64ShiftRandom() {
this(Param.DEFAULT, random.seed());
}
@Override
public long nextLong() {
step();
long t = _state._r;
t ^= t >>> 17;
t ^= t << 31;
t ^= t >>> 8;
return t;
}
private void step() {
_state._r = _param.a*_state._r + _param.b;
}
@Override
public void setSeed(final long seed) {
if (_state != null) _state.setSeed(seed);
}
/**
* Changes the internal state of the PRNG in a way that future calls to
* {@link #nextLong()} will generated the sth sub-stream of
* pth sub-streams. s must be within the range of
* {@code [0, p-1)}. This method is mainly used for parallelization
* via leap-frogging.
*
* @param p the overall number of sub-streams
* @param s the sth sub-stream
* @throws IllegalArgumentException if {@code p < 1 || s >= p}.
*/
public void split(final int p, final int s) {
if (p < 1) {
throw new IllegalArgumentException(format(
"p must be >= 1 but was %d.", p
));
}
if (s >= p) {
throw new IllegalArgumentException(format(
"s must be < %d but was %d.", p, s
));
}
if (p > 1) {
jump(s + 1);
final long b = _param.b*f(p, _param.a);
final long a = arithmetic.pow(_param.a, p);
_param = Param.of(a, b);
backward();
}
}
/**
* Changes the internal state of the PRNG in such a way that the engine
* jumps 2s steps ahead.
*
* @param s the 2s steps to jump ahead.
* @throws IllegalArgumentException if {@code s < 0}.
*/
public void jump2(final int s) {
if (s < 0) {
throw new IllegalArgumentException(format(
"s must be positive but was %d.", s
));
}
if (s >= Long.SIZE) {
throw new IllegalArgumentException(format(
"The 'jump2' size must be smaller than %d but was %d.",
Long.SIZE, s
));
}
_state._r = _state._r*arithmetic.pow(_param.a, 1L << s) +
f(1L << s, _param.a)*_param.b;
}
/**
* Changes the internal state of the PRNG in such a way that the engine
* jumps s steps ahead.
*
* @param step the steps to jump ahead.
* @throws IllegalArgumentException if {@code s < 0}.
*/
public void jump(final long step) {
if (step < 0) {
throw new IllegalArgumentException(format(
"step must be positive but was %d", step
));
}
if (step < 16) {
for (int i = 0; i < step; ++i) {
step();
}
} else {
long s = step;
int i = 0;
while (s > 0) {
if (s%2 == 1) {
jump2(i);
}
++i;
s >>= 1;
}
}
}
private void backward() {
for (int i = 0; i < Long.SIZE; ++i) {
jump2(i);
}
}
public Param getParam() {
return _param;
}
@Override
public int hashCode() {
return Hash.of(getClass())
.and(_param)
.and(_state).value();
}
@Override
public boolean equals(final Object obj) {
return Equality.of(this, obj).test(random ->
eq(_param, random._param) &&
eq(_state, random._state)
);
}
@Override
public String toString() {
return format("%s[%s, %s]", getClass().getSimpleName(), _param, _state);
}
/* *************************************************************************
* Some static helper methods
***************************************************************************/
/**
* Compute prod(1+a^(2^i), i=0..l-1).
*/
private static long g(final int l, final long a) {
long p = a;
long res = 1;
for (int i = 0; i < l; ++i) {
res *= 1 + p;
p *= p;
}
return res;
}
/**
* Compute sum(a^i, i=0..s-1).
*/
private static long f(final long s, final long a) {
long y = 0;
if (s != 0) {
long e = log2Floor(s);
long p = a;
for (int l = 0; l <= e; ++l) {
if (((1L << l) & s) != 0) {
y = g(l, a) + p*y;
}
p *= p;
}
}
return y;
}
private static long log2Floor(final long s) {
long x = s;
long y = 0;
while (x != 0) {
x >>>= 1;
++y;
}
return y - 1;
}
}
/*
#=============================================================================#
# Testing: org.jenetics.util.LCG64ShiftRandom (2015-07-12 01:22) #
#=============================================================================#
#=============================================================================#
# Linux 3.19.0-22-generic (amd64) #
# java version "1.8.0_45" #
# Java(TM) SE Runtime Environment (build 1.8.0_45-b14) #
# Java HotSpot(TM) 64-Bit Server VM (build 25.45-b02) #
#=============================================================================#
#=============================================================================#
# dieharder version 3.31.1 Copyright 2003 Robert G. Brown #
#=============================================================================#
rng_name |rands/second| Seed |
stdin_input_raw| 3.26e+07 |2198533946|
#=============================================================================#
test_name |ntup| tsamples |psamples| p-value |Assessment
#=============================================================================#
diehard_birthdays| 0| 100| 100|0.96061667| PASSED
diehard_operm5| 0| 1000000| 100|0.49388035| PASSED
diehard_rank_32x32| 0| 40000| 100|0.76944223| PASSED
diehard_rank_6x8| 0| 100000| 100|0.81999775| PASSED
diehard_bitstream| 0| 2097152| 100|0.66213596| PASSED
diehard_opso| 0| 2097152| 100|0.35244278| PASSED
diehard_oqso| 0| 2097152| 100|0.30642433| PASSED
diehard_dna| 0| 2097152| 100|0.31111322| PASSED
diehard_count_1s_str| 0| 256000| 100|0.29900596| PASSED
diehard_count_1s_byt| 0| 256000| 100|0.84049939| PASSED
diehard_parking_lot| 0| 12000| 100|0.25249632| PASSED
diehard_2dsphere| 2| 8000| 100|0.89898431| PASSED
diehard_3dsphere| 3| 4000| 100|0.87592069| PASSED
diehard_squeeze| 0| 100000| 100|0.46151457| PASSED
diehard_sums| 0| 100| 100|0.09988415| PASSED
diehard_runs| 0| 100000| 100|0.71496719| PASSED
diehard_runs| 0| 100000| 100|0.84035529| PASSED
diehard_craps| 0| 200000| 100|0.39228628| PASSED
diehard_craps| 0| 200000| 100|0.43227446| PASSED
marsaglia_tsang_gcd| 0| 10000000| 100|0.92226509| PASSED
marsaglia_tsang_gcd| 0| 10000000| 100|0.14768717| PASSED
sts_monobit| 1| 100000| 100|0.99459043| PASSED
sts_runs| 2| 100000| 100|0.14017900| PASSED
sts_serial| 1| 100000| 100|0.93191375| PASSED
sts_serial| 2| 100000| 100|0.78130569| PASSED
sts_serial| 3| 100000| 100|0.48954386| PASSED
sts_serial| 3| 100000| 100|0.20669186| PASSED
sts_serial| 4| 100000| 100|0.51752304| PASSED
sts_serial| 4| 100000| 100|0.81217070| PASSED
sts_serial| 5| 100000| 100|0.61151292| PASSED
sts_serial| 5| 100000| 100|0.43893995| PASSED
sts_serial| 6| 100000| 100|0.70098249| PASSED
sts_serial| 6| 100000| 100|0.88111033| PASSED
sts_serial| 7| 100000| 100|0.08860893| PASSED
sts_serial| 7| 100000| 100|0.10888449| PASSED
sts_serial| 8| 100000| 100|0.48682957| PASSED
sts_serial| 8| 100000| 100|0.79253724| PASSED
sts_serial| 9| 100000| 100|0.57005454| PASSED
sts_serial| 9| 100000| 100|0.57300065| PASSED
sts_serial| 10| 100000| 100|0.60555174| PASSED
sts_serial| 10| 100000| 100|0.26010863| PASSED
sts_serial| 11| 100000| 100|0.23181253| PASSED
sts_serial| 11| 100000| 100|0.55889710| PASSED
sts_serial| 12| 100000| 100|0.50349009| PASSED
sts_serial| 12| 100000| 100|0.67703032| PASSED
sts_serial| 13| 100000| 100|0.09716434| PASSED
sts_serial| 13| 100000| 100|0.01651733| PASSED
sts_serial| 14| 100000| 100|0.58227903| PASSED
sts_serial| 14| 100000| 100|0.49816453| PASSED
sts_serial| 15| 100000| 100|0.35547243| PASSED
sts_serial| 15| 100000| 100|0.77801465| PASSED
sts_serial| 16| 100000| 100|0.55611062| PASSED
sts_serial| 16| 100000| 100|0.45764285| PASSED
rgb_bitdist| 1| 100000| 100|0.74657121| PASSED
rgb_bitdist| 2| 100000| 100|0.95265707| PASSED
rgb_bitdist| 3| 100000| 100|0.71143353| PASSED
rgb_bitdist| 4| 100000| 100|0.99995544| WEAK
rgb_bitdist| 5| 100000| 100|0.99616318| WEAK
rgb_bitdist| 6| 100000| 100|0.66956720| PASSED
rgb_bitdist| 7| 100000| 100|0.95378286| PASSED
rgb_bitdist| 8| 100000| 100|0.46355875| PASSED
rgb_bitdist| 9| 100000| 100|0.21831657| PASSED
rgb_bitdist| 10| 100000| 100|0.97851877| PASSED
rgb_bitdist| 11| 100000| 100|0.35608637| PASSED
rgb_bitdist| 12| 100000| 100|0.11482554| PASSED
rgb_minimum_distance| 2| 10000| 1000|0.67569619| PASSED
rgb_minimum_distance| 3| 10000| 1000|0.40169012| PASSED
rgb_minimum_distance| 4| 10000| 1000|0.68466980| PASSED
rgb_minimum_distance| 5| 10000| 1000|0.85971777| PASSED
rgb_permutations| 2| 100000| 100|0.98547170| PASSED
rgb_permutations| 3| 100000| 100|0.13346308| PASSED
rgb_permutations| 4| 100000| 100|0.30098202| PASSED
rgb_permutations| 5| 100000| 100|0.49670259| PASSED
rgb_lagged_sum| 0| 1000000| 100|0.00376838| WEAK
rgb_lagged_sum| 1| 1000000| 100|0.84875325| PASSED
rgb_lagged_sum| 2| 1000000| 100|0.47618795| PASSED
rgb_lagged_sum| 3| 1000000| 100|0.74638546| PASSED
rgb_lagged_sum| 4| 1000000| 100|0.66367284| PASSED
rgb_lagged_sum| 5| 1000000| 100|0.38277246| PASSED
rgb_lagged_sum| 6| 1000000| 100|0.89022413| PASSED
rgb_lagged_sum| 7| 1000000| 100|0.20961380| PASSED
rgb_lagged_sum| 8| 1000000| 100|0.85608212| PASSED
rgb_lagged_sum| 9| 1000000| 100|0.98007494| PASSED
rgb_lagged_sum| 10| 1000000| 100|0.11658240| PASSED
rgb_lagged_sum| 11| 1000000| 100|0.59955707| PASSED
rgb_lagged_sum| 12| 1000000| 100|0.00017001| WEAK
rgb_lagged_sum| 13| 1000000| 100|0.90147191| PASSED
rgb_lagged_sum| 14| 1000000| 100|0.41636295| PASSED
rgb_lagged_sum| 15| 1000000| 100|0.37015147| PASSED
rgb_lagged_sum| 16| 1000000| 100|0.66453012| PASSED
rgb_lagged_sum| 17| 1000000| 100|0.18865006| PASSED
rgb_lagged_sum| 18| 1000000| 100|0.12419575| PASSED
rgb_lagged_sum| 19| 1000000| 100|0.39883314| PASSED
rgb_lagged_sum| 20| 1000000| 100|0.09942580| PASSED
rgb_lagged_sum| 21| 1000000| 100|0.53467964| PASSED
rgb_lagged_sum| 22| 1000000| 100|0.97551479| PASSED
rgb_lagged_sum| 23| 1000000| 100|0.53709182| PASSED
rgb_lagged_sum| 24| 1000000| 100|0.97407004| PASSED
rgb_lagged_sum| 25| 1000000| 100|0.19308485| PASSED
rgb_lagged_sum| 26| 1000000| 100|0.02836261| PASSED
rgb_lagged_sum| 27| 1000000| 100|0.09286364| PASSED
rgb_lagged_sum| 28| 1000000| 100|0.64833884| PASSED
rgb_lagged_sum| 29| 1000000| 100|0.50128799| PASSED
rgb_lagged_sum| 30| 1000000| 100|0.18237609| PASSED
rgb_lagged_sum| 31| 1000000| 100|0.92914172| PASSED
rgb_lagged_sum| 32| 1000000| 100|0.11809175| PASSED
rgb_kstest_test| 0| 10000| 1000|0.40816346| PASSED
dab_bytedistrib| 0| 51200000| 1|0.21337569| PASSED
dab_dct| 256| 50000| 1|0.25233302| PASSED
Preparing to run test 207. ntuple = 0
dab_filltree| 32| 15000000| 1|0.29102117| PASSED
dab_filltree| 32| 15000000| 1|0.48186931| PASSED
Preparing to run test 208. ntuple = 0
dab_filltree2| 0| 5000000| 1|0.48666498| PASSED
dab_filltree2| 1| 5000000| 1|0.90599317| PASSED
Preparing to run test 209. ntuple = 0
dab_monobit2| 12| 65000000| 1|0.98621807| PASSED
#=============================================================================#
# Summary: PASSED=110, WEAK=4, FAILED=0 #
# 235,031.406 MB of random data created with 99.045 MB/sec #
#=============================================================================#
#=============================================================================#
# Runtime: 0:39:32 #
#=============================================================================#
*/