Module org.cicirello.rho_mu

Package org.cicirello.math.rand

Class EnhancedArbitrarilyJumpableGenerator

java.lang.Object

org.cicirello.math.rand.EnhancedRandomGenerator

org.cicirello.math.rand.EnhancedStreamableGenerator

org.cicirello.math.rand.EnhancedJumpableGenerator

org.cicirello.math.rand.EnhancedLeapableGenerator

org.cicirello.math.rand.EnhancedArbitrarilyJumpableGenerator

All Implemented Interfaces:

RandomGenerator, RandomGenerator.ArbitrarilyJumpableGenerator, RandomGenerator.JumpableGenerator, RandomGenerator.LeapableGenerator, RandomGenerator.StreamableGenerator

public class EnhancedArbitrarilyJumpableGenerator
extends EnhancedLeapableGenerator
implements RandomGenerator.ArbitrarilyJumpableGenerator

An EnhancedArbitrarilyJumpableGenerator is used to wrap an object of any class that implements RandomGenerator.ArbitrarilyJumpableGenerator for the purpose of adding all of the functionality of the RandomIndexer and RandomVariates. See the superclass EnhancedRandomGenerator for documentation of the enhanced functionality that is added to the wrapped object.

The methods of the RandomGenerator.ArbitrarilyJumpableGenerator interface, such as jumps(double), that return streams of RandomGenerator.ArbitrarilyJumpableGenerator are implemented to return streams of EnhancedArbitrarilyJumpableGenerator objects that wrap the RandomGenerator.ArbitrarilyJumpableGenerator objects in the streams returned by the enclosed RandomGenerator.ArbitrarilyJumpableGenerator. However, additionally this class provides a counterpart, such as ejumps(double), for each of these methods whose return type is explicitly a stream of EnhancedArbitrarilyJumpableGenerator objects to simplify usage without the need to cast the objects of the stream in order to utilize the enhancements.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.random.RandomGenerator

RandomGenerator.ArbitrarilyJumpableGenerator, RandomGenerator.JumpableGenerator, RandomGenerator.LeapableGenerator, RandomGenerator.SplittableGenerator, RandomGenerator.StreamableGenerator

Constructor Summary

Constructors

Constructor	Description
EnhancedArbitrarilyJumpableGenerator(String algorithmName)	Constructs the EnhancedArbitrarilyJumpableGenerator to wrap an instance of any random number generator supported by your version of Java as specified by its name, as documented via the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.
EnhancedArbitrarilyJumpableGenerator(RandomGenerator.ArbitrarilyJumpableGenerator generator)	Constructs an EnhancedArbitrarilyJumpableGenerator to wrap and enhance a given RandomGenerator.ArbitrarilyJumpableGenerator.

Method Summary

Modifier and Type	Method	Description
EnhancedArbitrarilyJumpableGenerator	copy()	Creates and returns a new EnhancedArbitrarilyJumpableGenerator whose internal state is an exact copy of this one.
final EnhancedArbitrarilyJumpableGenerator	copyAndJump(double distance)	Creates a copy of this EnhancedArbitrarilyJumpableGenerator, jumps this EnhancedArbitrarilyJumpableGenerator forward, and then returns the copy.
final Stream<EnhancedArbitrarilyJumpableGenerator>	ejumps(double distance)	Gets an effectively unlimited stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final Stream<EnhancedArbitrarilyJumpableGenerator>	ejumps(long streamSize, double distance)	Gets a stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final void	jump(double distance)	Changes the state of this EnhancedArbitrarilyJumpableGenerator to jump a fixed distance ahead in its state cycle.
final void	jumpPowerOfTwo(int logDistance)	Changes the state of this EnhancedArbitrarilyJumpableGenerator to jump a distance of 2logDistance ahead in its state cycle.
final Stream<RandomGenerator.ArbitrarilyJumpableGenerator>	jumps(double distance)	Gets an effectively unlimited stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final Stream<RandomGenerator.ArbitrarilyJumpableGenerator>	jumps(long streamSize, double distance)	Gets a stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
static EnhancedArbitrarilyJumpableGenerator	of(String algorithmName)	Gets an EnhancedArbitrarilyJumpableGenerator wrapping an instance of any random number generator supported by your version of Java as specified by its name, as documented via the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.

Methods inherited from class org.cicirello.math.rand.EnhancedLeapableGenerator

copyAndLeap, eleaps, eleaps, leap, leapDistance, leaps, leaps

Methods inherited from class org.cicirello.math.rand.EnhancedJumpableGenerator

copyAndJump, ejumps, ejumps, jump, jumpDistance, jumps, jumps

Methods inherited from class org.cicirello.math.rand.EnhancedStreamableGenerator

erngs, erngs, rngs, rngs

Methods inherited from class org.cicirello.math.rand.EnhancedRandomGenerator

arrayMask, arrayMask, arrayMask, biasedInts, biasedInts, binomials, binomials, cauchys, cauchys, doubles, doubles, doubles, doubles, exponentials, exponentials, gaussians, gaussians, gaussians, gaussians, getDefault, ints, ints, ints, ints, longs, longs, longs, longs, nextBiasedInt, nextBiasedInt, nextBinomial, nextBoolean, nextBytes, nextCauchy, nextCauchy, nextDouble, nextDouble, nextDouble, nextExponential, nextFloat, nextFloat, nextFloat, nextGaussian, nextGaussian, nextGaussian, nextInt, nextInt, nextInt, nextIntPair, nextIntTriple, nextIntTriple, nextLong, nextLong, nextLong, nextWindowedIntPair, nextWindowedIntTriple, nextWindowedIntTriple, sample, sample, sampleInsertion, samplePool, sampleReservoir

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.random.RandomGenerator

doubles, doubles, doubles, doubles, ints, ints, ints, ints, isDeprecated, longs, longs, longs, longs, nextBoolean, nextBytes, nextDouble, nextDouble, nextDouble, nextExponential, nextFloat, nextFloat, nextFloat, nextGaussian, nextGaussian, nextInt, nextInt, nextInt, nextLong, nextLong, nextLong

Methods inherited from interface java.util.random.RandomGenerator.ArbitrarilyJumpableGenerator

jump, leap

Methods inherited from interface java.util.random.RandomGenerator.JumpableGenerator

copyAndJump, jumpDistance, jumps, jumps, rngs, rngs

Methods inherited from interface java.util.random.RandomGenerator.LeapableGenerator

copyAndLeap, leapDistance, leaps, leaps

Constructor Details

EnhancedArbitrarilyJumpableGenerator

public EnhancedArbitrarilyJumpableGenerator(RandomGenerator.ArbitrarilyJumpableGenerator generator)

Constructs an EnhancedArbitrarilyJumpableGenerator to wrap and enhance a given RandomGenerator.ArbitrarilyJumpableGenerator.

Parameters:

generator - the RandomGenerator.ArbitrarilyJumpableGenerator to wrap and enhance.

EnhancedArbitrarilyJumpableGenerator

public EnhancedArbitrarilyJumpableGenerator(String algorithmName)

Constructs the EnhancedArbitrarilyJumpableGenerator to wrap an instance of any random number generator supported by your version of Java as specified by its name, as documented via the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.

Parameters:

algorithmName - The name of the random number generator as documented by the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.

Throws:

NullPointerException - if algorithmName is null.

IllegalArgumentException - if algorithmName is not found.

Method Details

of

public static EnhancedArbitrarilyJumpableGenerator of(String algorithmName)

Gets an EnhancedArbitrarilyJumpableGenerator wrapping an instance of any random number generator supported by your version of Java as specified by its name, as documented via the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.

Parameters:

algorithmName - The name of the random number generator as documented by the RandomGenerator.ArbitrarilyJumpableGenerator.of(java.lang.String) method.

Returns:

an EnhancedArbitrarilyJumpableGenerator wrapping an instance of your chosen random number generator.

Throws:

NullPointerException - if algorithmName is null.

IllegalArgumentException - if algorithmName is not found.

copy

public EnhancedArbitrarilyJumpableGenerator copy()

Creates and returns a new EnhancedArbitrarilyJumpableGenerator whose internal state is an exact copy of this one. Thus, if subjected to the same series of actions, this EnhancedArbitrarilyJumpableGenerator and its copy should behave identically.

Specified by:

copy in interface RandomGenerator.ArbitrarilyJumpableGenerator

Specified by:

copy in interface RandomGenerator.JumpableGenerator

Specified by:

copy in interface RandomGenerator.LeapableGenerator

Overrides:

copy in class EnhancedLeapableGenerator

Returns:

a new EnhancedArbitrarilyJumpableGenerator with internal state identical to this one.

copyAndJump

public final EnhancedArbitrarilyJumpableGenerator copyAndJump(double distance)

Creates a copy of this EnhancedArbitrarilyJumpableGenerator, jumps this EnhancedArbitrarilyJumpableGenerator forward, and then returns the copy.

Specified by:

copyAndJump in interface RandomGenerator.ArbitrarilyJumpableGenerator

Parameters:

distance - the distance to jump ahead in the state cycle

Returns:

a copy of this EnhancedArbitrarilyJumpableGenerator before the jump occurred.

jump

public final void jump(double distance)

Changes the state of this EnhancedArbitrarilyJumpableGenerator to jump a fixed distance ahead in its state cycle.

Specified by:

jump in interface RandomGenerator.ArbitrarilyJumpableGenerator

Parameters:

distance - the distance to jump ahead in the state cycle

jumpPowerOfTwo

public final void jumpPowerOfTwo(int logDistance)

Changes the state of this EnhancedArbitrarilyJumpableGenerator to jump a distance of 2^logDistance ahead in its state cycle.

Specified by:

jumpPowerOfTwo in interface RandomGenerator.ArbitrarilyJumpableGenerator

Parameters:

logDistance - the base-2 logarithm of the distance to jump ahead in the state cycle

ejumps

public final Stream<EnhancedArbitrarilyJumpableGenerator> ejumps(double distance)

Gets an effectively unlimited stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.

The implementation of this method from the RandomGenerator.ArbitrarilyJumpableGenerator interface returns a stream of EnhancedArbitrarilyJumpableGenerator objects, and is thus safe to cast the objects of the stream to EnhancedArbitrarilyJumpableGenerator. However, you may find it more convenient to instead utilize the ejumps(double) method, whose behavior is identical aside from the return type.

Parameters:

distance - the distance to jump ahead in the state cycle

Returns:

a stream of EnhancedArbitrarilyJumpableGenerator objects

ejumps

public final Stream<EnhancedArbitrarilyJumpableGenerator> ejumps(long streamSize,
 double distance)

Gets a stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.

The implementation of this method from the RandomGenerator.ArbitrarilyJumpableGenerator interface returns a stream of EnhancedArbitrarilyJumpableGenerator objects, and is thus safe to cast the objects of the stream to EnhancedArbitrarilyJumpableGenerator. However, you may find it more convenient to instead utilize the ejumps(long, double) method, whose behavior is identical aside from the return type.

Parameters:

streamSize - the number of EnhancedArbitrarilyJumpableGenerator objects in the stream

distance - the distance to jump ahead in the state cycle

Returns:

a stream of EnhancedArbitrarilyJumpableGenerator objects

jumps

public final Stream<RandomGenerator.ArbitrarilyJumpableGenerator> jumps(double distance)

Gets an effectively unlimited stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.

The implementation of this method from the RandomGenerator.ArbitrarilyJumpableGenerator interface returns a stream of EnhancedArbitrarilyJumpableGenerator objects, and is thus safe to cast the objects of the stream to EnhancedArbitrarilyJumpableGenerator. However, you may find it more convenient to instead utilize the ejumps(double) method, whose behavior is identical aside from the return type.

Specified by:

jumps in interface RandomGenerator.ArbitrarilyJumpableGenerator

Parameters:

distance - the distance to jump ahead in the state cycle

Returns:

a stream of EnhancedArbitrarilyJumpableGenerator objects

jumps

public final Stream<RandomGenerator.ArbitrarilyJumpableGenerator> jumps(long streamSize,
 double distance)

Gets a stream of EnhancedArbitrarilyJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.

The implementation of this method from the RandomGenerator.ArbitrarilyJumpableGenerator interface returns a stream of EnhancedArbitrarilyJumpableGenerator objects, and is thus safe to cast the objects of the stream to EnhancedArbitrarilyJumpableGenerator. However, you may find it more convenient to instead utilize the ejumps(long, double) method, whose behavior is identical aside from the return type.

Specified by:

jumps in interface RandomGenerator.ArbitrarilyJumpableGenerator

Parameters:

streamSize - the number of EnhancedArbitrarilyJumpableGenerator objects in the stream

distance - the distance to jump ahead in the state cycle

Returns:

a stream of EnhancedArbitrarilyJumpableGenerator objects