Class Enhanced32Random
- All Implemented Interfaces:
Externalizable,Serializable,RandomGenerator
- Direct Known Subclasses:
Bear32Random,Chill32Random,Chip32Random,Choo32Random,ChopRandom,Jsf32Random,Lamb32Random,Respite32Random,Taxon32Random,Xoshiro128PlusPlusRandom,Xoshiro160RoadroxoRandom
EnhancedRandom meant for generators that use 32-bit math and natively operate on
int results instead of long results.- See Also:
-
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 -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns true if this generator mainly operates via itsnextInt()method internally, which means itsnextLong()must generate twointvalues instead of naturally producing onelong.doublemaxDoubleOf(double innerBound, double outerBound, int trials) Returns the maximum result oftrialscalls tonextDouble(double, double)using the giveninnerBoundandouterBound.floatmaxFloatOf(float innerBound, float outerBound, int trials) Returns the maximum result oftrialscalls tonextFloat(float, float)using the giveninnerBoundandouterBound.intmaxIntOf(int innerBound, int outerBound, int trials) Returns the maximum result oftrialscalls tonextSignedInt(int, int)using the giveninnerBoundandouterBound.longmaxLongOf(long innerBound, long outerBound, int trials) Returns the maximum result oftrialscalls tonextSignedLong(long, long)using the giveninnerBoundandouterBound.doubleminDoubleOf(double innerBound, double outerBound, int trials) Returns the minimum result oftrialscalls tonextDouble(double, double)using the giveninnerBoundandouterBound.floatminFloatOf(float innerBound, float outerBound, int trials) Returns the minimum result oftrialscalls tonextFloat(float, float)using the giveninnerBoundandouterBound.intminIntOf(int innerBound, int outerBound, int trials) Returns the minimum result oftrialscalls tonextSignedInt(int, int)using the giveninnerBoundandouterBound.longminLongOf(long innerBound, long outerBound, int trials) Returns the minimum result oftrialscalls tonextSignedLong(long, long)using the giveninnerBoundandouterBound.intnext(int bits) Generates the next pseudorandom number with a specific maximum size in bits (not a max number).booleanReturns the next pseudorandom, uniformly distributedbooleanvalue from this random number generator's sequence.booleannextBoolean(float chance) Returns true if a random value between 0 and 1 is less than the specified value.voidnextBytes(byte[] bytes) Generates random bytes and places them into a user-supplied byte array.doubleReturns the next pseudorandom, uniformly distributeddoublevalue between0.0(inclusive) and1.0(exclusive) from this random number generator's sequence.doublenextDouble(double outerBound) Gets a pseudo-random double between 0 (inclusive) andouterBound(exclusive).doublenextDouble(double innerBound, double outerBound) Gets a pseudo-random double betweeninnerBound(inclusive) andouterBound(exclusive).doubleGets a random double between 0.0 and 1.0, exclusive at both ends; this method is also more uniform thannextDouble()if you use the bit-patterns of the returned doubles.doublenextExclusiveDouble(double outerBound) Just likenextDouble(double), but this is exclusive on both 0.0 andouterBound.doublenextExclusiveDouble(double innerBound, double outerBound) doubleGets a random double between 0.0 and 1.0, exclusive at both ends.floatGets a random float between 0.0 and 1.0, exclusive at both ends.floatnextExclusiveFloat(float outerBound) Just likenextFloat(float), but this is exclusive on both 0.0 andouterBound.floatnextExclusiveFloat(float innerBound, float outerBound) floatGets a random float between 0.0 and 1.0, exclusive at both ends.doubleGets a random double that may be positive or negative, but cannot be 0, and always has a magnitude less than 1.floatGets a random float that may be positive or negative, but cannot be 0, and always has a magnitude less than 1.doubleReturns a non-negativedoublevalue pseudorandomly chosen from an exponential distribution whose mean is 1.floatReturns the next pseudorandom, uniformly distributedfloatvalue between0.0(inclusive) and1.0(exclusive) from this random number generator's sequence.floatnextFloat(float outerBound) Gets a pseudo-random float between 0 (inclusive) andouterBound(exclusive).floatnextFloat(float innerBound, float outerBound) Gets a pseudo-random float betweeninnerBound(inclusive) andouterBound(exclusive).doubleReturns the next pseudorandom, Gaussian ("normally") distributeddoublevalue with mean0.0and standard deviation1.0from this random number generator's sequence.doublenextGaussian(double mean, double stddev) Returns the next pseudorandom, Gaussian ("normally") distributeddoublevalue with the specified mean and standard deviation from this random number generator's sequence.floatReturns the next pseudorandom, Gaussian ("normally") distributedfloatvalue with mean0.0and standard deviation1.0from this random number generator's sequence.floatnextGaussianFloat(float mean, float stddev) Returns the next pseudorandom, Gaussian ("normally") distributedfloatvalue with the specified mean and standard deviation from this random number generator's sequence.doubleThis is just likenextDouble(), returning a double between 0 and 1, except that it is inclusive on both 0.0 and 1.0.doublenextInclusiveDouble(double outerBound) Just likenextDouble(double), but this is inclusive on both 0.0 andouterBound.doublenextInclusiveDouble(double innerBound, double outerBound) floatThis is just likenextFloat(), returning a float between 0 and 1, except that it is inclusive on both 0.0 and 1.0.floatnextInclusiveFloat(float outerBound) Just likenextFloat(float), but this is inclusive on both 0.0 andouterBound.floatnextInclusiveFloat(float innerBound, float outerBound) intnextInt()Returns the next pseudorandom, uniformly distributedintvalue from this random number generator's sequence.intnextInt(int bound) Returns a pseudorandom, uniformly distributedintvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.intnextInt(int innerBound, int outerBound) Returns a pseudorandom, uniformly distributedintvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive).longnextLong()Returns the next pseudorandom, uniformly distributedlongvalue from this random number generator's sequence.longnextLong(long bound) Returns a pseudorandom, uniformly distributedlongvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.longnextLong(long inner, long outer) Returns a pseudorandom, uniformly distributedlongvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive).intnextSign()Returns -1 or 1, randomly.intnextSignedInt(int outerBound) Returns a pseudorandom, uniformly distributedintvalue between an inner bound of 0 (inclusive) and the specifiedouterBound(exclusive).intnextSignedInt(int innerBound, int outerBound) Returns a pseudorandom, uniformly distributedintvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive).longnextSignedLong(long outerBound) Returns a pseudorandom, uniformly distributedlongvalue between an inner bound of 0 (inclusive) and the specifiedouterBound(exclusive).longnextSignedLong(long inner, long outer) Returns a pseudorandom, uniformly distributedlongvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive).floatReturns a triangularly distributed random number between -1.0 (exclusive) and 1.0 (exclusive), where values around zero are more likely.floatnextTriangular(float max) Returns a triangularly distributed random number between-max(exclusive) andmax(exclusive), where values around zero are more likely.floatnextTriangular(float min, float max) Returns a triangularly distributed random number betweenmin(inclusive) andmax(exclusive), where themodeargument defaults to the midpoint between the bounds, giving a symmetric distribution.floatnextTriangular(float min, float max, float mode) Returns a triangularly distributed random number betweenmin(inclusive) andmax(exclusive), where values aroundmodeare more likely.intnextUnsignedInt(int bound) Returns a pseudorandom, uniformly distributedintvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.<T> TrandomElement(List<T> list) Gets a randomly selected item from the given List, such as an ArrayList.<T> TrandomElement(T[] array) Gets a randomly-selected item from the given array, which must be non-null and non-emptyvoidshuffle(boolean[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(boolean[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(byte[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(byte[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(char[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(char[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(double[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(double[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(float[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(float[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(int[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(int[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(long[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(long[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(short[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.voidshuffle(short[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.<T> voidShuffles the given List in-place pseudo-randomly, using this to determine how to shuffle.<T> voidShuffles a section of the given List in-place pseudo-randomly, using this to determine how to shuffle.<T> voidshuffle(T[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.<T> voidshuffle(T[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.Methods inherited from class com.github.tommyettinger.random.EnhancedRandom
appendSerialized, appendSerialized, areEqual, copy, fixGamma, fixGamma, getMinimumPeriod, getSelectedState, getStateCount, getTag, lcm, previousInt, previousLong, probit, processSignedInt32, processUnsignedInt32, rateGamma, readExternal, seedFromMath, setSeed, setSelectedState, setState, setState, setState, setState, setState, setState, setState, setWith, skip, stringDeserialize, stringDeserialize, stringSerialize, stringSerialize, writeExternalMethods inherited from class java.util.Random
doubles, doubles, doubles, doubles, from, ints, ints, ints, ints, longs, longs, longs, longsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.random.RandomGenerator
isDeprecated
-
Constructor Details
-
Enhanced32Random
public Enhanced32Random() -
Enhanced32Random
public Enhanced32Random(long seed)
-
-
Method Details
-
mainlyGeneratesInt
public boolean mainlyGeneratesInt()Returns true if this generator mainly operates via itsnextInt()method internally, which means itsnextLong()must generate twointvalues instead of naturally producing onelong. This affects how the minimum period is measured forEnhancedRandom.getMinimumPeriod(). Most generators not intentionally targeting Google Web Toolkit mainly operate vianextLong()here, and return false. A generator that returns true here does not necessarily use 32-bit math; a generator can use 64-bit math internally but only produce 32 bits at a time by truncating its results.
In Enhanced32Random, this returnstrueby default.- Overrides:
mainlyGeneratesIntin classEnhancedRandom- Returns:
- true if measurements of the period measure calls to
nextInt()instead ofnextLong() - See Also:
-
next
public int next(int bits) Generates the next pseudorandom number with a specific maximum size in bits (not a max number). If you want to get a random number in a range, you should usually usenextInt(int)instead. For some specific cases, this method is more efficient and less biased thannextInt(int). Forbitsvalues between 1 and 30, this should be similar in effect tonextInt(1 << bits); though it won't typically produce the same values, they will have the correct range. Ifbitsis 31, this can return any non-negativeint; note thatnextInt(1 << 31)won't behave this way because1 << 31is negative. Ifbitsis 32 (or 0), this can return anyint.The general contract of
nextis that it returns anintvalue and if the argumentbitsis between1and32(inclusive), then that many low-order bits of the returned value will be (approximately) independently chosen bit values, each of which is (approximately) equally likely to be0or1.Note that you can give this values for
bitsthat are outside its expected range of 1 to 32, but the value used, as long as bits is positive, will effectively bebits % 32. As stated before, a value of 0 for bits is the same as a value of 32.- Overrides:
nextin classEnhancedRandom- Parameters:
bits- the amount of random bits to request, from 1 to 32- Returns:
- the next pseudorandom value from this random number generator's sequence
-
nextBytes
public void nextBytes(byte[] bytes) Generates random bytes and places them into a user-supplied byte array. The number of random bytes produced is equal to the length of the byte array.- Specified by:
nextBytesin interfaceRandomGenerator- Overrides:
nextBytesin classEnhancedRandom- Parameters:
bytes- the byte array to fill with random bytes- Throws:
NullPointerException- if the byte array is null
-
nextInt
public int nextInt()Returns the next pseudorandom, uniformly distributedintvalue from this random number generator's sequence. The general contract ofnextIntis that oneintvalue is pseudorandomly generated and returned. All 232 possibleintvalues are produced with (approximately) equal probability.
In Enhanced32Random, this throws an UnsupportedOperationException because the concrete subclass must implement this.- Specified by:
nextIntin interfaceRandomGenerator- Overrides:
nextIntin classEnhancedRandom- Returns:
- the next pseudorandom, uniformly distributed
intvalue from this random number generator's sequence
-
nextInt
public int nextInt(int bound) Returns a pseudorandom, uniformly distributedintvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence. The general contract ofnextIntis that oneintvalue in the specified range is pseudorandomly generated and returned. Allboundpossibleintvalues are produced with (approximately) equal probability.
This method clamps bound to be at least 0; it never returns a negative int.
It should be mentioned that the technique this uses has some bias, depending onbound, but it typically isn't measurable without specifically looking for it. Using the method this does allows this method to always advance the state by one step, instead of a varying and unpredictable amount with the more typical ways of rejection-sampling random numbers and only using numbers that can produce an int within the bound without bias. See M.E. O'Neill's blog about random numbers for discussion of alternative, unbiased methods.- Specified by:
nextIntin interfaceRandomGenerator- Overrides:
nextIntin classEnhancedRandom- Parameters:
bound- the upper bound (exclusive). If negative or 0, this always returns 0.- Returns:
- the next pseudorandom, uniformly distributed
intvalue between zero (inclusive) andbound(exclusive) from this random number generator's sequence
-
nextUnsignedInt
public int nextUnsignedInt(int bound) Returns a pseudorandom, uniformly distributedintvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence. The general contract ofnextIntis that oneintvalue in the specified range is pseudorandomly generated and returned. Allboundpossibleintvalues are produced with (approximately) equal probability.
This method treats the outer bound as unsigned, so if a negative int is passed asbound, it will be treated as positive and larger thanInteger.MAX_VALUE. That means this can produce results that are positive or negative, but when you mask the result and the bound with0xFFFFFFFFL(to treat them as unsigned), the result will always be between0L(inclusive) and the masked bound (exclusive).
This is primarily useful as a building block for other methods in this class.- Overrides:
nextUnsignedIntin classEnhancedRandom- Parameters:
bound- the upper bound (exclusive); treated as unsigned- Returns:
- the next pseudorandom, uniformly distributed
intvalue between zero (inclusive) andbound(exclusive), treated as unsigned, from this random number generator's sequence
-
nextSignedInt
public int nextSignedInt(int outerBound) Returns a pseudorandom, uniformly distributedintvalue between an inner bound of 0 (inclusive) and the specifiedouterBound(exclusive). This is meant for cases where the outer bound may be negative, especially if the bound is unknown or may be user-specified. A negative outer bound is used as the lower bound; a positive outer bound is used as the upper bound. An outer bound of -1, 0, or 1 will always return 0, keeping the bound exclusive (except for outer bound 0). This method is slightly slower thannextInt(int).- Overrides:
nextSignedIntin classEnhancedRandom- Parameters:
outerBound- the outer exclusive bound; may be any int value, allowing negative- Returns:
- a pseudorandom int between 0 (inclusive) and outerBound (exclusive)
- See Also:
-
nextInt
public int nextInt(int innerBound, int outerBound) Returns a pseudorandom, uniformly distributedintvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive). IfouterBoundis less than or equal toinnerBound, this always returnsinnerBound.
For any case where outerBound might be valid but less than innerBound, you can usenextSignedInt(int, int). If outerBound is less than innerBound here, this simply returns innerBound.- Specified by:
nextIntin interfaceRandomGenerator- Overrides:
nextIntin classEnhancedRandom- Parameters:
innerBound- the inclusive inner bound; may be any int, allowing negativeouterBound- the exclusive outer bound; must be greater than innerBound (otherwise this returns innerBound)- Returns:
- a pseudorandom int between innerBound (inclusive) and outerBound (exclusive)
- See Also:
-
nextSignedInt
public int nextSignedInt(int innerBound, int outerBound) Returns a pseudorandom, uniformly distributedintvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive). This is meant for cases where either bound may be negative, especially if the bounds are unknown or may be user-specified.- Overrides:
nextSignedIntin classEnhancedRandom- Parameters:
innerBound- the inclusive inner bound; may be any int, allowing negativeouterBound- the exclusive outer bound; may be any int, allowing negative- Returns:
- a pseudorandom int between innerBound (inclusive) and outerBound (exclusive)
- See Also:
-
nextLong
public long nextLong()Returns the next pseudorandom, uniformly distributedlongvalue from this random number generator's sequence. The general contract ofnextLongis that onelongvalue is pseudorandomly generated and returned.
The only methods that need to be implemented by this interface are this andEnhancedRandom.copy(), though other methods can be implemented as appropriate for generators that, for instance, natively produce ints rather than longs.- Specified by:
nextLongin interfaceRandomGenerator- Specified by:
nextLongin classEnhancedRandom- Returns:
- the next pseudorandom, uniformly distributed
longvalue from this random number generator's sequence
-
nextLong
public long nextLong(long bound) Returns a pseudorandom, uniformly distributedlongvalue between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence. The general contract ofnextLongis that onelongvalue in the specified range is pseudorandomly generated and returned. Allboundpossiblelongvalues are produced with (approximately) equal probability, though there is a small amount of bias depending on the bound.
Note that this advances the state by the same amount as a single call tonextLong(), which allows methods likeEnhancedRandom.skip(long)to function correctly, but introduces some bias whenboundis very large. This will also advance the state ifboundis 0 or negative, so usage with a variable bound will advance the state reliably.
This method has some bias, particularly on larger bounds. Actually measuring bias with bounds in the trillions or greater is challenging but not impossible, so don't use this for a real-money gambling purpose. The bias isn't especially significant, though.- Specified by:
nextLongin interfaceRandomGenerator- Overrides:
nextLongin classEnhancedRandom- Parameters:
bound- the upper bound (exclusive). If negative or 0, this always returns 0.- Returns:
- the next pseudorandom, uniformly distributed
longvalue between zero (inclusive) andbound(exclusive) from this random number generator's sequence - See Also:
-
nextSignedLong
public long nextSignedLong(long outerBound) Returns a pseudorandom, uniformly distributedlongvalue between an inner bound of 0 (inclusive) and the specifiedouterBound(exclusive). This is meant for cases where the outer bound may be negative, especially if the bound is unknown or may be user-specified. A negative outer bound is used as the lower bound; a positive outer bound is used as the upper bound. An outer bound of -1, 0, or 1 will always return 0, keeping the bound exclusive (except for outer bound 0).Note that this advances the state by the same amount as a single call to
nextLong(), which allows methods likeEnhancedRandom.skip(long)to function correctly, but introduces some bias whenboundis very large. This method should be about as fast asnextLong(long), unlike the speed difference betweennextInt(int)andnextSignedInt(int).- Overrides:
nextSignedLongin classEnhancedRandom- Parameters:
outerBound- the outer exclusive bound; may be any long value, allowing negative- Returns:
- a pseudorandom long between 0 (inclusive) and outerBound (exclusive)
- See Also:
-
nextLong
public long nextLong(long inner, long outer) Returns a pseudorandom, uniformly distributedlongvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive). IfouterBoundis less than or equal toinnerBound, this always returnsinnerBound.
For any case where outerBound might be valid but less than innerBound, you can usenextSignedLong(long, long).- Specified by:
nextLongin interfaceRandomGenerator- Overrides:
nextLongin classEnhancedRandom- Parameters:
inner- the inclusive inner bound; may be any long, allowing negativeouter- the exclusive outer bound; must be greater than innerBound (otherwise this returns innerBound)- Returns:
- a pseudorandom long between innerBound (inclusive) and outerBound (exclusive)
- See Also:
-
nextSignedLong
public long nextSignedLong(long inner, long outer) Returns a pseudorandom, uniformly distributedlongvalue between the specifiedinnerBound(inclusive) and the specifiedouterBound(exclusive). This is meant for cases where either bound may be negative, especially if the bounds are unknown or may be user-specified.- Overrides:
nextSignedLongin classEnhancedRandom- Parameters:
inner- the inclusive inner bound; may be any long, allowing negativeouter- the exclusive outer bound; may be any long, allowing negative- Returns:
- a pseudorandom long between innerBound (inclusive) and outerBound (exclusive)
- See Also:
-
nextBoolean
public boolean nextBoolean()Returns the next pseudorandom, uniformly distributedbooleanvalue from this random number generator's sequence. The general contract ofnextBooleanis that onebooleanvalue is pseudorandomly generated and returned. The valuestrueandfalseare produced with (approximately) equal probability.
The public implementation simply returns a sign check onnextInt(), returning true if the generated int is negative. This is typically the safest way to implement this method; many types of generators have less statistical quality on their lowest bit, so just returning based on the lowest bit isn't always a good idea.- Specified by:
nextBooleanin interfaceRandomGenerator- Overrides:
nextBooleanin classEnhancedRandom- Returns:
- the next pseudorandom, uniformly distributed
booleanvalue from this random number generator's sequence
-
nextFloat
public float nextFloat()Returns the next pseudorandom, uniformly distributedfloatvalue between0.0(inclusive) and1.0(exclusive) from this random number generator's sequence.The general contract of
nextFloatis that onefloatvalue, chosen (approximately) uniformly from the range0.0f(inclusive) to1.0f(exclusive), is pseudorandomly generated and returned. All 224 possiblefloatvalues of the form m x 2-24, where m is a positive integer less than 224, are produced with (approximately) equal probability.The public implementation uses the upper 24 bits of
nextLong(), with an unsigned right shift and a multiply by a very small float (5.9604645E-8for0x1p-24f). It tends to be fast if nextLong() is fast, but alternative implementations could use 24 bits ofnextInt()(or justnext(int), giving it24) if that generator doesn't efficiently generate 64-bit longs.- Specified by:
nextFloatin interfaceRandomGenerator- Overrides:
nextFloatin classEnhancedRandom- Returns:
- the next pseudorandom, uniformly distributed
floatvalue between0.0and1.0from this random number generator's sequence
-
nextFloat
public float nextFloat(float outerBound) Gets a pseudo-random float between 0 (inclusive) andouterBound(exclusive). The outerBound may be positive or negative. Exactly the same asnextFloat() * outerBound.- Specified by:
nextFloatin interfaceRandomGenerator- Overrides:
nextFloatin classEnhancedRandom- Parameters:
outerBound- the exclusive outer bound- Returns:
- a float between 0 (inclusive) and
outerBound(exclusive)
-
nextFloat
public float nextFloat(float innerBound, float outerBound) Gets a pseudo-random float betweeninnerBound(inclusive) andouterBound(exclusive). Either, neither, or both of innerBound and outerBound may be negative; this does not change which is inclusive and which is exclusive.- Specified by:
nextFloatin interfaceRandomGenerator- Overrides:
nextFloatin classEnhancedRandom- Parameters:
innerBound- the inclusive inner bound; may be negativeouterBound- the exclusive outer bound; may be negative- Returns:
- a float between
innerBound(inclusive) andouterBound(exclusive)
-
nextDouble
public double nextDouble()Returns the next pseudorandom, uniformly distributeddoublevalue between0.0(inclusive) and1.0(exclusive) from this random number generator's sequence.The general contract of
nextDoubleis that onedoublevalue, chosen (approximately) uniformly from the range0.0d(inclusive) to1.0d(exclusive), is pseudorandomly generated and returned.The public implementation uses the upper 53 bits of
nextLong(), with an unsigned right shift and a multiply by a very small double (1.1102230246251565E-16, or0x1p-53). It should perform well if nextLong() performs well, and is expected to perform less well if the generator naturally produces 32 or fewer bits at a time.- Specified by:
nextDoublein interfaceRandomGenerator- Overrides:
nextDoublein classEnhancedRandom- Returns:
- the next pseudorandom, uniformly distributed
doublevalue between0.0and1.0from this random number generator's sequence
-
nextDouble
public double nextDouble(double outerBound) Gets a pseudo-random double between 0 (inclusive) andouterBound(exclusive). The outerBound may be positive or negative. Exactly the same asnextDouble() * outerBound.- Specified by:
nextDoublein interfaceRandomGenerator- Overrides:
nextDoublein classEnhancedRandom- Parameters:
outerBound- the exclusive outer bound- Returns:
- a double between 0 (inclusive) and
outerBound(exclusive)
-
nextDouble
public double nextDouble(double innerBound, double outerBound) Gets a pseudo-random double betweeninnerBound(inclusive) andouterBound(exclusive). Either, neither, or both of innerBound and outerBound may be negative; this does not change which is inclusive and which is exclusive.- Specified by:
nextDoublein interfaceRandomGenerator- Overrides:
nextDoublein classEnhancedRandom- Parameters:
innerBound- the inclusive inner bound; may be negativeouterBound- the exclusive outer bound; may be negative- Returns:
- a double between
innerBound(inclusive) andouterBound(exclusive)
-
nextInclusiveDouble
public double nextInclusiveDouble()This is just likenextDouble(), returning a double between 0 and 1, except that it is inclusive on both 0.0 and 1.0. It returns 1.0 rarely, 0.000000000000000005421010862427522% of the time if there is no bias in the generator, but it can happen.
This method does not return purely-equidistant doubles, because there the resolution of possible doubles it can generate is higher as it approaches 0.0 . The smallest non-zero double this can return is 2.710505431213763e-20 (0x1.0000000000003p-65 in hex), and the largest non-one double this can return is 0.9999999999999999 (0x1.fffffffffffffp-1 in hex). This uses nearly identical code tonextExclusiveDouble(), but does some really unusual operations on both the bits and the double value to be able to produce 0.0 and 1.0 . This retains the exclusive version's quality of having approximately uniform distributions for every mantissa bit, unlike most ways of generating random floating-point numbers.- Overrides:
nextInclusiveDoublein classEnhancedRandom- Returns:
- a double between 0.0, inclusive, and 1.0, inclusive
-
nextInclusiveDouble
public double nextInclusiveDouble(double outerBound) Just likenextDouble(double), but this is inclusive on both 0.0 andouterBound. It may be important to note that it returns outerBound on only 0.000000000000011102230246251565% of calls.- Overrides:
nextInclusiveDoublein classEnhancedRandom- Parameters:
outerBound- the outer inclusive bound; may be positive or negative- Returns:
- a double between 0.0, inclusive, and
outerBound, inclusive
-
nextInclusiveDouble
public double nextInclusiveDouble(double innerBound, double outerBound) Just likenextDouble(double, double), but this is inclusive on bothinnerBoundandouterBound. It may be important to note that it returns outerBound on only 0.000000000000011102230246251565% of calls, if it can return it at all because of floating-point imprecision when innerBound is a larger number.- Overrides:
nextInclusiveDoublein classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer inclusive bound; may be positive or negative- Returns:
- a double between
innerBound, inclusive, andouterBound, inclusive
-
nextInclusiveFloat
public float nextInclusiveFloat()This is just likenextFloat(), returning a float between 0 and 1, except that it is inclusive on both 0.0 and 1.0.- Overrides:
nextInclusiveFloatin classEnhancedRandom- Returns:
- a float between 0.0, inclusive, and 1.0, inclusive
-
nextInclusiveFloat
public float nextInclusiveFloat(float outerBound) Just likenextFloat(float), but this is inclusive on both 0.0 andouterBound. It may be important to note that it returns outerBound on only 0.00000596046412226771% of calls.- Overrides:
nextInclusiveFloatin classEnhancedRandom- Parameters:
outerBound- the outer inclusive bound; may be positive or negative- Returns:
- a float between 0.0, inclusive, and
outerBound, inclusive
-
nextInclusiveFloat
public float nextInclusiveFloat(float innerBound, float outerBound) Just likenextFloat(float, float), but this is inclusive on bothinnerBoundandouterBound. It may be important to note that it returns outerBound on only 0.00000596046412226771% of calls, if it can return it at all because of floating-point imprecision when innerBound is a larger number.- Overrides:
nextInclusiveFloatin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer inclusive bound; may be positive or negative- Returns:
- a float between
innerBound, inclusive, andouterBound, inclusive
-
nextExclusiveDouble
public double nextExclusiveDouble()Gets a random double between 0.0 and 1.0, exclusive at both ends; this method is also more uniform thannextDouble()if you use the bit-patterns of the returned doubles. This is a simplified version of this algorithm by Allen Downey. This can return double values between 2.710505431213761E-20 and 0.9999999999999999, or 0x1.0p-65 and 0x1.fffffffffffffp-1 in hex notation. It cannot return 0 or 1. Some cases can prefernextExclusiveDoubleEquidistant(), which is implemented more traditionally but may have slower performance. This method can also return doubles that are extremely close to 0, but can't return doubles that are as close to 1, due to how floating-point numbers work. However, nextExclusiveDoubleEquidistant() can return only a minimum value that is as distant from 0 as its maximum value is distant from 1.
To compare, nextDouble() and nextExclusiveDoubleEquidistant() are less likely to produce a "1" bit for their lowest 5 bits of mantissa/significand (the least significant bits numerically, but potentially important for some uses), with the least significant bit produced half as often as the most significant bit in the mantissa. As for this method, it has approximately the same likelihood of producing a "1" bit for any position in the mantissa.
The implementation may have different performance characteristics thannextDouble(), because this doesn't perform any floating-point multiplication or division, and instead assembles bits obtained by one call tonextLong(). This usesBitConversion.longBitsToDouble(long)andBitConversion.countLeadingZeros(long), both of which typically have optimized intrinsics on HotSpot, and this is branchless and loopless, unlike the original algorithm by Allen Downey. When compared withnextExclusiveDoubleEquidistant(), this method performs better on at least HotSpot JVMs. On GraalVM 17, this is over twice as fast as nextExclusiveDoubleEquidistant().- Overrides:
nextExclusiveDoublein classEnhancedRandom- Returns:
- a random uniform double between 2.710505431213761E-20 and 0.9999999999999999 (both inclusive)
-
nextExclusiveDoubleEquidistant
public double nextExclusiveDoubleEquidistant()Gets a random double between 0.0 and 1.0, exclusive at both ends. This can return double values between 1.1102230246251565E-16 and 0.9999999999999999, or 0x1.0p-53 and 0x1.fffffffffffffp-1 in hex notation. It cannot return 0 or 1, and its minimum and maximum results are equally distant from 0 and from 1, respectively. Many usages may prefernextExclusiveDouble(), which is better-distributed if you consider the bit representation of the returned doubles, tends to perform better, and can return doubles that much closer to 0 than this can.
The implementation simply usesnextLong(long)to get a uniformly-chosen long between 1 and (2 to the 53) - 1, both inclusive, and multiplies it by (2 to the -53). Using larger values than (2 to the 53) would cause issues with the double math.- Overrides:
nextExclusiveDoubleEquidistantin classEnhancedRandom- Returns:
- a random uniform double between 0 and 1 (both exclusive)
-
nextExclusiveDouble
public double nextExclusiveDouble(double outerBound) Just likenextDouble(double), but this is exclusive on both 0.0 andouterBound. LikenextExclusiveDouble(), which this uses, this may have better bit-distribution of double values, and it may also be better able to produce very small doubles whenouterBoundis large. It should typically be a little faster thannextDouble(double).- Overrides:
nextExclusiveDoublein classEnhancedRandom- Parameters:
outerBound- the outer exclusive bound; may be positive or negative- Returns:
- a double between 0.0, exclusive, and
outerBound, exclusive
-
nextExclusiveDouble
public double nextExclusiveDouble(double innerBound, double outerBound) Just likenextDouble(double, double), but this is exclusive on bothinnerBoundandouterBound. LikenextExclusiveDouble(), which this uses,, this may have better bit-distribution of double values, and it may also be better able to produce doubles close to innerBound whenouterBound - innerBoundis large. It should typically be a little faster thannextDouble(double, double).- Overrides:
nextExclusiveDoublein classEnhancedRandom- Parameters:
innerBound- the inner exclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negative- Returns:
- a double between
innerBound, exclusive, andouterBound, exclusive
-
nextExclusiveSignedDouble
public double nextExclusiveSignedDouble()Gets a random double that may be positive or negative, but cannot be 0, and always has a magnitude less than 1.
This is a modified version of this algorithm by Allen Downey. This version can return double values between -0.9999999999999999 and -5.421010862427522E-20, as well as between 5.421010862427522E-20 and 0.9999999999999999, or -0x1.fffffffffffffp-1 to -0x1.0p-64 as well as between 0x1.0p-64 and 0x1.fffffffffffffp-1 in hex notation. It cannot return -1, 0 or 1. It has much more uniform bit distribution across its mantissa/significand bits thanRandom.nextDouble(), especially when the result of nextDouble() is expanded to the -1.0 to 1.0 range (such as with2.0 * (nextDouble() - 0.5)). Where that code usingnextDouble()is unable to produce a "1" bit for its lowest bit of mantissa (the least significant bits numerically, but potentially important for some uses), this has approximately the same likelihood of producing a "1" bit for any positions in the mantissa, and also equal odds for the sign bit.
Some useful properties here are that this produces a negative result exactly as often as the underlying generator produces a negative result withnextLong(), and the least-significant bits that the underlying generator produces withnextLong()are also the least-significant in magnitude here. This could be used with lower-quality randomness, like a linear congruential generator, and the flaws those have with their low-order bits would barely affect floating-point results here. This generator also produces results that are symmetrical around 0.0, with every possible positive number having a possible negative number of equal magnitude, if the underlying generator is at least 1-dimensionally equidistributed. Note that generators such asXoroshiro128StarStarRandomandXoshiro256StarStarRandomcannot return 0L fromnextLong()as frequently as other results, so this is not (technically) true of those. Those generators (and other LFSR-type generators) will produce 5.421010862427522E-20 less frequently than -5.421010862427522E-20 .- Overrides:
nextExclusiveSignedDoublein classEnhancedRandom- Returns:
- a random uniform double between -1 and 1 with a tiny hole around 0 (all exclusive)
-
nextExclusiveFloat
public float nextExclusiveFloat()Gets a random float between 0.0 and 1.0, exclusive at both ends. This method is also more uniform thannextFloat()if you use the bit-patterns of the returned floats. This is a simplified version of this algorithm by Allen Downey. This version can return float values between 2.7105054E-20 to 0.99999994, or 0x1.0p-65 to 0x1.fffffep-1 in hex notation. It cannot return 0 or 1. To compare, nextFloat() is less likely to produce a "1" bit for its lowest 5 bits of mantissa/significand (the least significant bits numerically, but potentially important for some uses), with the least significant bit produced half as often as the most significant bit in the mantissa. As for this method, it has approximately the same likelihood of producing a "1" bit for any position in the mantissa.
The implementation may have different performance characteristics thannextFloat(), because this doesn't perform any floating-point multiplication or division, and instead assembles bits obtained by two calls tonextInt(). This usesBitConversion.intBitsToFloat(int)andBitConversion.countLeadingZeros(long), both of which typically have optimized intrinsics on HotSpot, and this is branchless and loopless, unlike the original algorithm by Allen Downey.- Overrides:
nextExclusiveFloatin classEnhancedRandom- Returns:
- a random uniform float between 0 and 1 (both exclusive)
-
nextExclusiveFloatEquidistant
public float nextExclusiveFloatEquidistant()Gets a random float between 0.0 and 1.0, exclusive at both ends. This can return float values between 5.9604645E-8 and 0.99999994, or 0x1.0p-24 and 0x1.fffffep-1 in hex notation. It cannot return 0 or 1, and its minimum and maximum results are equally distant from 0 and from 1, respectively. Most usages might prefernextExclusiveFloat(), which is better-distributed if you consider the bit representation of the returned floats, tends to perform better, and can return floats that much closer to 0 than this can.
The implementation simply usesnextInt(int)to get a uniformly-chosen int between 1 and (2 to the 24) - 1, both inclusive, and multiplies it by (2 to the -24). Using larger values than (2 to the 24) would cause issues with the float math.- Overrides:
nextExclusiveFloatEquidistantin classEnhancedRandom- Returns:
- a random uniform float between 0 and 1 (both exclusive)
-
nextExclusiveFloat
public float nextExclusiveFloat(float outerBound) Just likenextFloat(float), but this is exclusive on both 0.0 andouterBound. LikenextExclusiveFloat(), this may have better bit-distribution of float values, and it may also be better able to produce very small floats whenouterBoundis large. It should be a little faster thannextFloat(float).- Overrides:
nextExclusiveFloatin classEnhancedRandom- Parameters:
outerBound- the outer exclusive bound; may be positive or negative- Returns:
- a float between 0.0, exclusive, and
outerBound, exclusive
-
nextExclusiveFloat
public float nextExclusiveFloat(float innerBound, float outerBound) Just likenextFloat(float, float), but this is exclusive on bothinnerBoundandouterBound. LikenextExclusiveFloat(), this may have better bit-distribution of float values, and it may also be better able to produce floats close to innerBound whenouterBound - innerBoundis large. It should be a little faster thannextFloat(float, float).- Overrides:
nextExclusiveFloatin classEnhancedRandom- Parameters:
innerBound- the inner exclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negative- Returns:
- a float between
innerBound, exclusive, andouterBound, exclusive
-
nextExclusiveSignedFloat
public float nextExclusiveSignedFloat()Gets a random float that may be positive or negative, but cannot be 0, and always has a magnitude less than 1.
This is a modified version of this algorithm by Allen Downey. This version can return float values between -0.99999994 and -5.421011E-20, as well as between 5.421011E-20 and 0.99999994, or -0x1.fffffep-1 to -0x1.0p-64 as well as between 0x1.0p-64 and 0x1.fffffep-1 in hex notation. It cannot return -1, 0 or 1. It has much more uniform bit distribution across its mantissa/significand bits thanRandom.nextFloat(), especially when the result of nextFloat() is expanded to the -1.0 to 1.0 range (such as with2.0 * (nextFloat() - 0.5)). Where the given example code is unable to produce a "1" bit for its lowest bit of mantissa (the least significant bits numerically, but potentially important for some uses), this has approximately the same likelihood of producing a "1" bit for any positions in the mantissa, and also equal odds for the sign bit.
This callsnextInt()twice.- Overrides:
nextExclusiveSignedFloatin classEnhancedRandom- Returns:
- a random uniform float between -1 and 1 with a tiny hole around 0 (all exclusive)
-
nextGaussian
public double nextGaussian()Returns the next pseudorandom, Gaussian ("normally") distributeddoublevalue with mean0.0and standard deviation1.0from this random number generator's sequence.The general contract of
nextGaussianis that onedoublevalue, chosen from (approximately) the usual normal distribution with mean0.0and standard deviation1.0, is pseudorandomly generated and returned.This does not use a rough approximation, which is a departure from earlier versions; instead, it uses the Ziggurat method, which produces high-quality variables very quickly. Like earlier versions that used probit() or a bit-counting approximation, this requests exactly one long from the generator's sequence (using
nextLong()). This makes it different from code like java.util.Random's nextGaussian() method, which can (rarely) fetch a higher number of random doubles.The implementation here was ported from code by Olaf Berstein, based on a paper by Jorgen A. Doornik and some steps from a paper by George Marsaglia.
Distributorhas more information, for the curious.- Specified by:
nextGaussianin interfaceRandomGenerator- Overrides:
nextGaussianin classEnhancedRandom- Returns:
- the next pseudorandom, Gaussian ("normally") distributed
doublevalue with mean0.0and standard deviation1.0from this random number generator's sequence
-
nextGaussian
public double nextGaussian(double mean, double stddev) Returns the next pseudorandom, Gaussian ("normally") distributeddoublevalue with the specified mean and standard deviation from this random number generator's sequence.
This defaults to simply returningmean + stddev * nextGaussian().- Specified by:
nextGaussianin interfaceRandomGenerator- Overrides:
nextGaussianin classEnhancedRandom- Parameters:
mean- the mean of the Gaussian distribution to be drawn fromstddev- the standard deviation (square root of the variance) of the Gaussian distribution to be drawn from- Returns:
- a Gaussian distributed
doublewith the specified mean and standard deviation
-
nextGaussianFloat
public float nextGaussianFloat()Returns the next pseudorandom, Gaussian ("normally") distributedfloatvalue with mean0.0and standard deviation1.0from this random number generator's sequence.The general contract of
nextGaussianFloatis that onefloatvalue, chosen from (approximately) the usual normal distribution with mean0.0and standard deviation1.0, is pseudorandomly generated and returned.This uses
Distributor.probitI(int). Unlike nextGaussian(), this requests exactly one int from the generator's sequence (usingnextInt()). This also makes it different from code like java.util.Random's nextGaussian() method, which can (rarely) fetch an arbitrarily higher number of random doubles.- Overrides:
nextGaussianFloatin classEnhancedRandom- Returns:
- the next pseudorandom, Gaussian ("normally") distributed
floatvalue with mean0.0and standard deviation1.0from this random number generator's sequence
-
nextGaussianFloat
public float nextGaussianFloat(float mean, float stddev) Returns the next pseudorandom, Gaussian ("normally") distributedfloatvalue with the specified mean and standard deviation from this random number generator's sequence.
This defaults to simply returningmean + stddev * nextGaussianFloat().- Overrides:
nextGaussianFloatin classEnhancedRandom- Parameters:
mean- the mean of the Gaussian distribution to be drawn fromstddev- the standard deviation (square root of the variance) of the Gaussian distribution to be drawn from- Returns:
- a Gaussian distributed
floatwith the specified mean and standard deviation
-
nextExponential
public double nextExponential()Returns a non-negativedoublevalue pseudorandomly chosen from an exponential distribution whose mean is 1.- Specified by:
nextExponentialin interfaceRandomGenerator- Overrides:
nextExponentialin classEnhancedRandom- Returns:
- a non-negative
doublevalue pseudorandomly chosen from an exponential distribution with a mean of 1
-
nextBoolean
public boolean nextBoolean(float chance) Returns true if a random value between 0 and 1 is less than the specified value.- Overrides:
nextBooleanin classEnhancedRandom- Parameters:
chance- a float between 0.0 and 1.0; higher values are more likely to result in true- Returns:
- a boolean selected with the given
chanceof being true
-
nextSign
public int nextSign()Returns -1 or 1, randomly.- Overrides:
nextSignin classEnhancedRandom- Returns:
- -1 or 1, selected with approximately equal likelihood
-
nextTriangular
public float nextTriangular()Returns a triangularly distributed random number between -1.0 (exclusive) and 1.0 (exclusive), where values around zero are more likely. Advances the state twice.This is an optimized version of
nextTriangular(-1, 1, 0)- Overrides:
nextTriangularin classEnhancedRandom
-
nextTriangular
public float nextTriangular(float max) Returns a triangularly distributed random number between-max(exclusive) andmax(exclusive), where values around zero are more likely. Advances the state twice.This is an optimized version of
nextTriangular(-max, max, 0)- Overrides:
nextTriangularin classEnhancedRandom- Parameters:
max- the upper limit
-
nextTriangular
public float nextTriangular(float min, float max) Returns a triangularly distributed random number betweenmin(inclusive) andmax(exclusive), where themodeargument defaults to the midpoint between the bounds, giving a symmetric distribution. Advances the state once.This method is equivalent to
nextTriangular(min, max, (min + max) * 0.5f)- Overrides:
nextTriangularin classEnhancedRandom- Parameters:
min- the lower limitmax- the upper limit
-
nextTriangular
public float nextTriangular(float min, float max, float mode) Returns a triangularly distributed random number betweenmin(inclusive) andmax(exclusive), where values aroundmodeare more likely. Advances the state once.- Overrides:
nextTriangularin classEnhancedRandom- Parameters:
min- the lower limitmax- the upper limitmode- the point around which the values are more likely
-
minIntOf
public int minIntOf(int innerBound, int outerBound, int trials) Returns the minimum result oftrialscalls tonextSignedInt(int, int)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the lower the average value this returns.- Overrides:
minIntOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the lowest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
maxIntOf
public int maxIntOf(int innerBound, int outerBound, int trials) Returns the maximum result oftrialscalls tonextSignedInt(int, int)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the higher the average value this returns.- Overrides:
maxIntOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the highest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
minLongOf
public long minLongOf(long innerBound, long outerBound, int trials) Returns the minimum result oftrialscalls tonextSignedLong(long, long)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the lower the average value this returns.- Overrides:
minLongOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the lowest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
maxLongOf
public long maxLongOf(long innerBound, long outerBound, int trials) Returns the maximum result oftrialscalls tonextSignedLong(long, long)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the higher the average value this returns.- Overrides:
maxLongOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the highest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
minDoubleOf
public double minDoubleOf(double innerBound, double outerBound, int trials) Returns the minimum result oftrialscalls tonextDouble(double, double)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the lower the average value this returns.- Overrides:
minDoubleOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the lowest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
maxDoubleOf
public double maxDoubleOf(double innerBound, double outerBound, int trials) Returns the maximum result oftrialscalls tonextDouble(double, double)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the higher the average value this returns.- Overrides:
maxDoubleOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the highest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
minFloatOf
public float minFloatOf(float innerBound, float outerBound, int trials) Returns the minimum result oftrialscalls tonextFloat(float, float)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the lower the average value this returns.- Overrides:
minFloatOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the lowest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
maxFloatOf
public float maxFloatOf(float innerBound, float outerBound, int trials) Returns the maximum result oftrialscalls tonextFloat(float, float)using the giveninnerBoundandouterBound. The innerBound is inclusive; the outerBound is exclusive. The higher trials is, the higher the average value this returns.- Overrides:
maxFloatOfin classEnhancedRandom- Parameters:
innerBound- the inner inclusive bound; may be positive or negativeouterBound- the outer exclusive bound; may be positive or negativetrials- how many random numbers to acquire and compare- Returns:
- the highest random number between innerBound (inclusive) and outerBound (exclusive) this found
-
randomElement
public <T> T randomElement(T[] array) Gets a randomly-selected item from the given array, which must be non-null and non-empty- Overrides:
randomElementin classEnhancedRandom- Type Parameters:
T- any reference type- Parameters:
array- a non-null, non-empty array ofTitems- Returns:
- a random item from
array - Throws:
NullPointerException- if array is nullIndexOutOfBoundsException- if array is empty
-
randomElement
Gets a randomly selected item from the given List, such as an ArrayList. If the List is empty, this throws an IndexOutOfBoundsException.- Overrides:
randomElementin classEnhancedRandom- Type Parameters:
T- the type of items- Parameters:
list- a non-empty implementation of List, such as ArrayList- Returns:
- a randomly-selected item from list
-
shuffle
public void shuffle(int[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- an int array; must be non-null
-
shuffle
public void shuffle(int[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- an int array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(long[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a long array; must be non-null
-
shuffle
public void shuffle(long[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a long array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(float[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a float array; must be non-null
-
shuffle
public void shuffle(float[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a float array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(char[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a char array; must be non-null
-
shuffle
public void shuffle(char[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a char array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(byte[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a byte array; must be non-null
-
shuffle
public void shuffle(byte[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a byte array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(double[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a double array; must be non-null
-
shuffle
public void shuffle(double[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a double array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(short[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a short array; must be non-null
-
shuffle
public void shuffle(short[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a short array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public void shuffle(boolean[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a boolean array; must be non-null
-
shuffle
public void shuffle(boolean[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a boolean array; must be non-nulloffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
public <T> void shuffle(T[] items) Shuffles the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- an array of some reference type; must be non-null but may contain null items
-
shuffle
public <T> void shuffle(T[] items, int offset, int length) Shuffles a section of the given array in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- an array of some reference type; must be non-null but may contain null itemsoffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-
shuffle
Shuffles the given List in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a List of some typeT; must be non-null but may contain null items
-
shuffle
Shuffles a section of the given List in-place pseudo-randomly, using this to determine how to shuffle.- Overrides:
shufflein classEnhancedRandom- Parameters:
items- a List of some typeT; must be non-null but may contain null itemsoffset- the index of the first element of the array that can be shuffledlength- the length of the section to shuffle
-