Module org.cicirello.rho_mu

Package org.cicirello.math.rand

Class EnhancedLeapableGenerator

java.lang.Object

org.cicirello.math.rand.EnhancedRandomGenerator

org.cicirello.math.rand.EnhancedStreamableGenerator

org.cicirello.math.rand.EnhancedJumpableGenerator

org.cicirello.math.rand.EnhancedLeapableGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

EnhancedArbitrarilyJumpableGenerator

public class EnhancedLeapableGenerator
extends EnhancedJumpableGenerator
implements RandomGenerator.LeapableGenerator

An EnhancedLeapableGenerator is used to wrap an object of any class that implements RandomGenerator.LeapableGenerator 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.LeapableGenerator interface, such as leaps(), that return streams of RandomGenerator.JumpableGenerator are implemented to return streams of EnhancedJumpableGenerator objects that wrap the RandomGenerator.JumpableGenerator objects in the streams returned by the enclosed RandomGenerator.LeapableGenerator. However, additionally this class provides a counterpart, such as eleaps(), for each of these methods whose return type is explicitly a stream of EnhancedJumpableGenerator 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
EnhancedLeapableGenerator(String algorithmName)	Constructs the EnhancedLeapableGenerator 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.LeapableGenerator.of(java.lang.String) method.
EnhancedLeapableGenerator(RandomGenerator.LeapableGenerator generator)	Constructs an EnhancedLeapableGenerator to wrap and enhance a given RandomGenerator.LeapableGenerator.

Method Summary

Modifier and Type	Method	Description
EnhancedLeapableGenerator	copy()	Creates and returns a new EnhancedLeapableGenerator whose internal state is an exact copy of this one.
final EnhancedLeapableGenerator	copyAndLeap()	Creates a copy of this EnhancedLeapableGenerator, leaps this EnhancedLeapableGenerator forward, and then returns the copy.
final Stream<EnhancedJumpableGenerator>	eleaps()	Gets an effectively unlimited stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final Stream<EnhancedJumpableGenerator>	eleaps(long streamSize)	Gets a stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final void	leap()	Changes the state of this EnhancedLeapableGenerator to leap a large fixed distance, indicated by the leapDistance() method, in its state cycle.
final double	leapDistance()	Returns the distance by which the leap() method will leap ahead in this EnhancedLeapableGenerator instance's state cycle.
final Stream<RandomGenerator.JumpableGenerator>	leaps()	Gets an effectively unlimited stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
final Stream<RandomGenerator.JumpableGenerator>	leaps(long streamSize)	Gets a stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one.
static EnhancedLeapableGenerator	of(String algorithmName)	Gets an EnhancedLeapableGenerator wrapping an instance of any random number generator supported by your version of Java as specified by its name, as documented via the RandomGenerator.LeapableGenerator.of(java.lang.String) method.

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.JumpableGenerator

copyAndJump, jump, jumpDistance, jumps, jumps, rngs, rngs

Constructor Details

EnhancedLeapableGenerator

public EnhancedLeapableGenerator(RandomGenerator.LeapableGenerator generator)

Constructs an EnhancedLeapableGenerator to wrap and enhance a given RandomGenerator.LeapableGenerator.

Parameters:

generator - the RandomGenerator.LeapableGenerator to wrap and enhance.

EnhancedLeapableGenerator

public EnhancedLeapableGenerator(String algorithmName)

Constructs the EnhancedLeapableGenerator 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.LeapableGenerator.of(java.lang.String) method.

Parameters:

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

Throws:

NullPointerException - if algorithmName is null.

IllegalArgumentException - if algorithmName is not found.

Method Details

of

public static EnhancedLeapableGenerator of(String algorithmName)

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

Parameters:

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

Returns:

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

Throws:

NullPointerException - if algorithmName is null.

IllegalArgumentException - if algorithmName is not found.

copy

public EnhancedLeapableGenerator copy()

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

Specified by:

copy in interface RandomGenerator.JumpableGenerator

Specified by:

copy in interface RandomGenerator.LeapableGenerator

Overrides:

copy in class EnhancedJumpableGenerator

Returns:

a new EnhancedLeapableGenerator with internal state identical to this one.

copyAndLeap

public final EnhancedLeapableGenerator copyAndLeap()

Creates a copy of this EnhancedLeapableGenerator, leaps this EnhancedLeapableGenerator forward, and then returns the copy.

Specified by:

copyAndLeap in interface RandomGenerator.LeapableGenerator

Returns:

a copy of this EnhancedLeapableGenerator before the leap occurred.

leap

public final void leap()

Changes the state of this EnhancedLeapableGenerator to leap a large fixed distance, indicated by the leapDistance() method, in its state cycle.

Specified by:

leap in interface RandomGenerator.LeapableGenerator

leapDistance

public final double leapDistance()

Returns the distance by which the leap() method will leap ahead in this EnhancedLeapableGenerator instance's state cycle.

Specified by:

leapDistance in interface RandomGenerator.LeapableGenerator

Returns:

the leap distance

eleaps

public final Stream<EnhancedJumpableGenerator> eleaps()

Gets an effectively unlimited stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one. Although jumpable, the random number generators in the stream are not also leapable.

The behavior of this method is identical to that of leaps(), but may be more convenient to use due to explicit return type of a stream of EnhancedJumpableGenerator objects.

Returns:

a stream of EnhancedJumpableGenerator objects

eleaps

public final Stream<EnhancedJumpableGenerator> eleaps(long streamSize)

Gets a stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one. Although jumpable, the random number generators in the stream are not also leapable.

The behavior of this method is identical to that of leaps(long), but may be more convenient to use due to explicit return type of a stream of EnhancedJumpableGenerator objects.

Parameters:

streamSize - the number of EnhancedJumpableGenerator objects in the stream

Returns:

a stream of EnhancedJumpableGenerator objects

leaps

public final Stream<RandomGenerator.JumpableGenerator> leaps()

Gets an effectively unlimited stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one. Although jumpable, the random number generators in the stream are not also leapable.

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

Specified by:

leaps in interface RandomGenerator.LeapableGenerator

Returns:

a stream of EnhancedJumpableGenerator objects

leaps

public final Stream<RandomGenerator.JumpableGenerator> leaps(long streamSize)

Gets a stream of EnhancedJumpableGenerator objects, each wrapping an object of the same random number generator algorithm as this one. Although jumpable, the random number generators in the stream are not also leapable.

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

Specified by:

leaps in interface RandomGenerator.LeapableGenerator

Parameters:

streamSize - the number of EnhancedJumpableGenerator objects in the stream

Returns:

a stream of EnhancedJumpableGenerator objects