org.apache.commons.rng.simple.internal

Enum ProviderBuilder.RandomSourceInternal

java.lang.Object

java.lang.Enum<ProviderBuilder.RandomSourceInternal>

org.apache.commons.rng.simple.internal.ProviderBuilder.RandomSourceInternal

All Implemented Interfaces:

Serializable, Comparable<ProviderBuilder.RandomSourceInternal>

Enclosing class:

ProviderBuilder

public static enum ProviderBuilder.RandomSourceInternal
extends Enum<ProviderBuilder.RandomSourceInternal>

Identifiers of the generators.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ISAAC Source of randomness is ISAACRandom.
JDK Source of randomness is JDKRandom.
KISS Source of randomness is KISSRandom.
MT Source of randomness is MersenneTwister.
MT_64 Source of randomness is MersenneTwister64.
MWC_256 Source of randomness is MultiplyWithCarry256.
SPLIT_MIX_64 Source of randomness is SplitMix64.
TWO_CMRES Source of randomness is TwoCmres.
TWO_CMRES_SELECT Source of randomness is TwoCmres with explicit selection of the two subcycle generators.
WELL_1024_A Source of randomness is Well1024a.
WELL_19937_A Source of randomness is Well19937a.
WELL_19937_C Source of randomness is Well19937c.
WELL_44497_A Source of randomness is Well44497a.
WELL_44497_B Source of randomness is Well44497b.
WELL_512_A Source of randomness is Well512a.
XOR_SHIFT_1024_S Source of randomness is XorShift1024Star.

Method Summary

Modifier and Type	Method and Description
Class<?>	getRng()
<SEED> boolean	isNativeSeed(SEED seed) Checks whether the type of given seed is the native type of the implementation.
static ProviderBuilder.RandomSourceInternal	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProviderBuilder.RandomSourceInternal[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JDK

public static final ProviderBuilder.RandomSourceInternal JDK

Source of randomness is JDKRandom.

WELL_512_A

public static final ProviderBuilder.RandomSourceInternal WELL_512_A

Source of randomness is Well512a.

WELL_1024_A

public static final ProviderBuilder.RandomSourceInternal WELL_1024_A

Source of randomness is Well1024a.

WELL_19937_A

public static final ProviderBuilder.RandomSourceInternal WELL_19937_A

Source of randomness is Well19937a.

WELL_19937_C

public static final ProviderBuilder.RandomSourceInternal WELL_19937_C

Source of randomness is Well19937c.

WELL_44497_A

public static final ProviderBuilder.RandomSourceInternal WELL_44497_A

Source of randomness is Well44497a.

WELL_44497_B

public static final ProviderBuilder.RandomSourceInternal WELL_44497_B

Source of randomness is Well44497b.

MT

public static final ProviderBuilder.RandomSourceInternal MT

Source of randomness is MersenneTwister.

ISAAC

public static final ProviderBuilder.RandomSourceInternal ISAAC

Source of randomness is ISAACRandom.

SPLIT_MIX_64

public static final ProviderBuilder.RandomSourceInternal SPLIT_MIX_64

Source of randomness is SplitMix64.

XOR_SHIFT_1024_S

public static final ProviderBuilder.RandomSourceInternal XOR_SHIFT_1024_S

Source of randomness is XorShift1024Star.

TWO_CMRES

public static final ProviderBuilder.RandomSourceInternal TWO_CMRES

Source of randomness is TwoCmres.

TWO_CMRES_SELECT

public static final ProviderBuilder.RandomSourceInternal TWO_CMRES_SELECT

Source of randomness is TwoCmres with explicit selection of the two subcycle generators.

MT_64

public static final ProviderBuilder.RandomSourceInternal MT_64

Source of randomness is MersenneTwister64.

MWC_256

public static final ProviderBuilder.RandomSourceInternal MWC_256

Source of randomness is MultiplyWithCarry256.

KISS

public static final ProviderBuilder.RandomSourceInternal KISS

Source of randomness is KISSRandom.

Method Detail

values

public static ProviderBuilder.RandomSourceInternal[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProviderBuilder.RandomSourceInternal c : ProviderBuilder.RandomSourceInternal.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProviderBuilder.RandomSourceInternal valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRng

public Class<?> getRng()

Returns:

the source type.

isNativeSeed

public <SEED> boolean isNativeSeed(SEED seed)

Checks whether the type of given seed is the native type of the implementation.

Type Parameters:

SEED - Seed type.

Parameters:

seed - Seed value.

Returns:

true if the seed can be passed to the builder for this RNG type.