ProviderBuilder.RandomSourceInternal (Apache Commons RNG Simple 1.3 API)

java.lang.Object
- java.lang.Enum<ProviderBuilder.RandomSourceInternal>
- - org.apache.commons.rng.simple.internal.ProviderBuilder.RandomSourceInternal

Enclosing class:: ProviderBuilder

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

Identifiers of the generators.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ISAAC`	Source of randomness is `ISAACRandom`.
`JDK`	Source of randomness is `JDKRandom`.
`JSF_32`	Source of randomness is `JenkinsSmallFast32`.
`JSF_64`	Source of randomness is `JenkinsSmallFast64`.
`KISS`	Source of randomness is `KISSRandom`.
`MSWS`	Source of randomness is `MiddleSquareWeylSequence`.
`MT`	Source of randomness is `MersenneTwister`.
`MT_64`	Source of randomness is `MersenneTwister64`.
`MWC_256`	Source of randomness is `MultiplyWithCarry256`.
`PCG_MCG_XSH_RR_32`	Source of randomness is `PcgMcgXshRr32`.
`PCG_MCG_XSH_RS_32`	Source of randomness is `PcgMcgXshRs32`.
`PCG_RXS_M_XS_64`	Source of randomness is `PcgRxsMXs64`.
`PCG_XSH_RR_32`	Source of randomness is `PcgXshRr32`.
`PCG_XSH_RS_32`	Source of randomness is `PcgXshRs32`.
`SFC_32`	Source of randomness is `DotyHumphreySmallFastCounting32`.
`SFC_64`	Source of randomness is `DotyHumphreySmallFastCounting64`.
`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`.
`XO_RO_SHI_RO_1024_PP`	Source of randomness is `XoRoShiRo1024PlusPlus`.
`XO_RO_SHI_RO_1024_S`	Source of randomness is `XoRoShiRo1024Star`.
`XO_RO_SHI_RO_1024_SS`	Source of randomness is `XoRoShiRo1024StarStar`.
`XO_RO_SHI_RO_128_PLUS`	Source of randomness is `XoRoShiRo128Plus`.
`XO_RO_SHI_RO_128_PP`	Source of randomness is `XoRoShiRo128PlusPlus`.
`XO_RO_SHI_RO_128_SS`	Source of randomness is `XoRoShiRo128StarStar`.
`XO_RO_SHI_RO_64_S`	Source of randomness is `XoRoShiRo64Star`.
`XO_RO_SHI_RO_64_SS`	Source of randomness is `XoRoShiRo64StarStar`.
`XO_SHI_RO_128_PLUS`	Source of randomness is `XoShiRo128Plus`.
`XO_SHI_RO_128_PP`	Source of randomness is `XoShiRo128PlusPlus`.
`XO_SHI_RO_128_SS`	Source of randomness is `XoShiRo128StarStar`.
`XO_SHI_RO_256_PLUS`	Source of randomness is `XoShiRo256Plus`.
`XO_SHI_RO_256_PP`	Source of randomness is `XoShiRo256PlusPlus`.
`XO_SHI_RO_256_SS`	Source of randomness is `XoShiRo256StarStar`.
`XO_SHI_RO_512_PLUS`	Source of randomness is `XoShiRo512Plus`.
`XO_SHI_RO_512_PP`	Source of randomness is `XoShiRo512PlusPlus`.
`XO_SHI_RO_512_SS`	Source of randomness is `XoShiRo512StarStar`.
`XOR_SHIFT_1024_S`	Source of randomness is `XorShift1024Star`.
`XOR_SHIFT_1024_S_PHI`	Source of randomness is `XorShift1024StarPhi`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.Object`	`convertSeed(java.lang.Object seed)`	Converts a seed from any of the supported seed types to a native seed.
`protected byte[]`	`createByteArraySeed(org.apache.commons.rng.UniformRandomProvider source)`	Creates a `byte[]` seed using the provided source of randomness.
`protected java.lang.Object`	`createSeed()`	Creates a native seed.
`byte[]`	`createSeedBytes()`	Creates a seed suitable for the implementing class represented by this random source.
`byte[]`	`createSeedBytes(org.apache.commons.rng.UniformRandomProvider source)`	Creates a seed suitable for the implementing class represented by this random source using the supplied source of randomness.
`java.lang.Class<?>`	`getRng()`	Gets the implementing class of the random source.
`<SEED> boolean`	`isNativeSeed(SEED seed)`	Checks whether the type of given `seed` is the native type of the implementation.
`static ProviderBuilder.RandomSourceInternal`	`valueOf(java.lang.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.
  - XOR_SHIFT_1024_S_PHI
```
public static final ProviderBuilder.RandomSourceInternal XOR_SHIFT_1024_S_PHI
```
    Source of randomness is XorShift1024StarPhi.
  - XO_RO_SHI_RO_64_S
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_64_S
```
    Source of randomness is XoRoShiRo64Star.
  - XO_RO_SHI_RO_64_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_64_SS
```
    Source of randomness is XoRoShiRo64StarStar.
  - XO_SHI_RO_128_PLUS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_128_PLUS
```
    Source of randomness is XoShiRo128Plus.
  - XO_SHI_RO_128_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_128_SS
```
    Source of randomness is XoShiRo128StarStar.
  - XO_RO_SHI_RO_128_PLUS
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_128_PLUS
```
    Source of randomness is XoRoShiRo128Plus.
  - XO_RO_SHI_RO_128_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_128_SS
```
    Source of randomness is XoRoShiRo128StarStar.
  - XO_SHI_RO_256_PLUS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_256_PLUS
```
    Source of randomness is XoShiRo256Plus.
  - XO_SHI_RO_256_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_256_SS
```
    Source of randomness is XoShiRo256StarStar.
  - XO_SHI_RO_512_PLUS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_512_PLUS
```
    Source of randomness is XoShiRo512Plus.
  - XO_SHI_RO_512_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_512_SS
```
    Source of randomness is XoShiRo512StarStar.
  - PCG_XSH_RR_32
```
public static final ProviderBuilder.RandomSourceInternal PCG_XSH_RR_32
```
    Source of randomness is PcgXshRr32.
  - PCG_XSH_RS_32
```
public static final ProviderBuilder.RandomSourceInternal PCG_XSH_RS_32
```
    Source of randomness is PcgXshRs32.
  - PCG_RXS_M_XS_64
```
public static final ProviderBuilder.RandomSourceInternal PCG_RXS_M_XS_64
```
    Source of randomness is PcgRxsMXs64.
  - PCG_MCG_XSH_RR_32
```
public static final ProviderBuilder.RandomSourceInternal PCG_MCG_XSH_RR_32
```
    Source of randomness is PcgMcgXshRr32.
  - PCG_MCG_XSH_RS_32
```
public static final ProviderBuilder.RandomSourceInternal PCG_MCG_XSH_RS_32
```
    Source of randomness is PcgMcgXshRs32.
  - MSWS
```
public static final ProviderBuilder.RandomSourceInternal MSWS
```
    Source of randomness is MiddleSquareWeylSequence.
  - SFC_32
```
public static final ProviderBuilder.RandomSourceInternal SFC_32
```
    Source of randomness is DotyHumphreySmallFastCounting32.
  - SFC_64
```
public static final ProviderBuilder.RandomSourceInternal SFC_64
```
    Source of randomness is DotyHumphreySmallFastCounting64.
  - JSF_32
```
public static final ProviderBuilder.RandomSourceInternal JSF_32
```
    Source of randomness is JenkinsSmallFast32.
  - JSF_64
```
public static final ProviderBuilder.RandomSourceInternal JSF_64
```
    Source of randomness is JenkinsSmallFast64.
  - XO_SHI_RO_128_PP
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_128_PP
```
    Source of randomness is XoShiRo128PlusPlus.
  - XO_RO_SHI_RO_128_PP
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_128_PP
```
    Source of randomness is XoRoShiRo128PlusPlus.
  - XO_SHI_RO_256_PP
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_256_PP
```
    Source of randomness is XoShiRo256PlusPlus.
  - XO_SHI_RO_512_PP
```
public static final ProviderBuilder.RandomSourceInternal XO_SHI_RO_512_PP
```
    Source of randomness is XoShiRo512PlusPlus.
  - XO_RO_SHI_RO_1024_PP
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_1024_PP
```
    Source of randomness is XoRoShiRo1024PlusPlus.
  - XO_RO_SHI_RO_1024_S
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_1024_S
```
    Source of randomness is XoRoShiRo1024Star.
  - XO_RO_SHI_RO_1024_SS
```
public static final ProviderBuilder.RandomSourceInternal XO_RO_SHI_RO_1024_SS
```
    Source of randomness is XoRoShiRo1024StarStar.
- 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(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getRng
```
public java.lang.Class<?> getRng()
```
    Gets the implementing class of the random source.
    
    Returns:
    
    the random source class.
  - 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.
  - createSeed
```
protected java.lang.Object createSeed()
```
    Creates a native seed.
    The default implementation creates a seed of the native type and, for array seeds, ensures not all bits are zero.
    
    This method should be over-ridden to satisfy seed requirements for the generator.
    
    Returns:
    
    the native seed
    
    Since:
    
    1.3
  - createByteArraySeed
```
protected byte[] createByteArraySeed(org.apache.commons.rng.UniformRandomProvider source)
```
    Creates a byte[] seed using the provided source of randomness.
    The default implementation creates a full-length seed and ensures not all bits are zero.
    
    This method should be over-ridden to satisfy seed requirements for the generator.
    
    Parameters:
    
    source - Source of randomness.
    
    Returns:
    
    the byte[] seed
    
    Since:
    
    1.3
  - convertSeed
```
protected java.lang.Object convertSeed(java.lang.Object seed)
```
    Converts a seed from any of the supported seed types to a native seed.
    The default implementation delegates to the native seed type conversion.
    
    This method should be over-ridden to satisfy seed requirements for the generator.
    
    Parameters:
    
    seed - Input seed (must not be null).
    
    Returns:
    
    the native seed
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the seed type is invalid.
    
    Since:
    
    1.3
  - createSeedBytes
```
public final byte[] createSeedBytes()
```
    Creates a seed suitable for the implementing class represented by this random source.
    It will satisfy the seed size and any other seed requirements for the implementing class. The seed is converted from the native type to bytes.
    
    Returns:
    
    the seed bytes
    
    Since:
    
    1.3
  - createSeedBytes
```
public final byte[] createSeedBytes(org.apache.commons.rng.UniformRandomProvider source)
```
    Creates a seed suitable for the implementing class represented by this random source using the supplied source of randomness.
    It will satisfy the seed size and any other seed requirements for the implementing class. The seed is converted from the native type to bytes.
    
    Parameters:
    
    source - Source of randomness.
    
    Returns:
    
    the seed bytes
    
    Since:
    
    1.3

Enum ProviderBuilder.RandomSourceInternal

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

JDK

WELL_512_A

WELL_1024_A

WELL_19937_A

WELL_19937_C

WELL_44497_A

WELL_44497_B

MT

ISAAC

SPLIT_MIX_64

XOR_SHIFT_1024_S

TWO_CMRES

TWO_CMRES_SELECT

MT_64

MWC_256

KISS

XOR_SHIFT_1024_S_PHI

XO_RO_SHI_RO_64_S

XO_RO_SHI_RO_64_SS

XO_SHI_RO_128_PLUS

XO_SHI_RO_128_SS

XO_RO_SHI_RO_128_PLUS

XO_RO_SHI_RO_128_SS

XO_SHI_RO_256_PLUS

XO_SHI_RO_256_SS

XO_SHI_RO_512_PLUS

XO_SHI_RO_512_SS

PCG_XSH_RR_32

PCG_XSH_RS_32

PCG_RXS_M_XS_64

PCG_MCG_XSH_RR_32

PCG_MCG_XSH_RS_32

MSWS

SFC_32

SFC_64

JSF_32

JSF_64

XO_SHI_RO_128_PP

XO_RO_SHI_RO_128_PP

XO_SHI_RO_256_PP

XO_SHI_RO_512_PP

XO_RO_SHI_RO_1024_PP

XO_RO_SHI_RO_1024_S

XO_RO_SHI_RO_1024_SS

Method Detail

values

valueOf

getRng

isNativeSeed

createSeed

createByteArraySeed

convertSeed

createSeedBytes

createSeedBytes