com.annimon.stream

Class RandomCompat

java.lang.Object

com.annimon.stream.RandomCompat

public final class RandomCompat
extends java.lang.Object

Backported stream apis from Random class, based on IntStream only for now.

Constructor Summary

Constructors

Constructor and Description
RandomCompat() Constructs object, inner random created with default constructor.
RandomCompat(long seed) Constructs object, inner random created with seed passed as param.
RandomCompat(java.util.Random random) Constructs object with the given Random instance.

Method Summary

Modifier and Type	Method and Description
java.util.Random	getRandom() Returns underlying Random instance.
IntStream	ints() Returns an effectively unlimited stream of pseudorandom int values.
IntStream	ints(int randomNumberOrigin, int randomNumberBound) Returns an effectively unlimited stream of pseudorandom int values, each conforming to the given origin (inclusive) and bound (exclusive)
IntStream	ints(long streamSize) Returns a stream producing the given streamSize number of pseudorandom int values.
IntStream	ints(long streamSize, int randomNumberOrigin, int randomNumberBound) Returns a stream producing the given streamSize number of pseudorandom int values, each conforming to the given origin (inclusive) and bound (exclusive).

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomCompat

public RandomCompat()

Constructs object, inner random created with default constructor.

RandomCompat

public RandomCompat(long seed)

Constructs object, inner random created with seed passed as param.

Parameters:

seed - seed to initialize random object

RandomCompat

public RandomCompat(java.util.Random random)

Constructs object with the given Random instance.

Parameters:

random - Random instance

Method Detail

getRandom

public java.util.Random getRandom()

Returns underlying Random instance.

Returns:

Random object instance

ints

public IntStream ints(long streamSize)

Returns a stream producing the given streamSize number of pseudorandom int values.

A pseudorandom int value is generated as if it's the result of calling the method Random.nextInt()

Parameters:

streamSize - the number of values to generate

Returns:

a stream of pseudorandom int values

Throws:

java.lang.IllegalArgumentException - if streamSize is less than zero

ints

public IntStream ints()

Returns an effectively unlimited stream of pseudorandom int values.

A pseudorandom int value is generated as if it's the result of calling the method Random.nextInt().

Returns:

a stream of pseudorandom int values

ints

public IntStream ints(long streamSize,
                      int randomNumberOrigin,
                      int randomNumberBound)

Returns a stream producing the given streamSize number of pseudorandom int values, each conforming to the given origin (inclusive) and bound (exclusive).

Parameters:

streamSize - the number of values to generate

randomNumberOrigin - the origin (inclusive) of each random value

randomNumberBound - the bound (exclusive) if each random value

Returns:

a stream of pseudorandom int values, each with the given origin (inclusive) and bound (exclusive)

Throws:

java.lang.IllegalArgumentException - if streamSize is less than zero, or randomNumberOrigin is greater than or equal to randomNumberBound

ints

public IntStream ints(int randomNumberOrigin,
                      int randomNumberBound)

Returns an effectively unlimited stream of pseudorandom int values, each conforming to the given origin (inclusive) and bound (exclusive)

Parameters:

randomNumberOrigin - the origin (inclusive) of each random value

randomNumberBound - the bound (exclusive) of each random value

Returns:

a stream of pseudorandom int values, each with the given origin (inclusive) and bound (exclusive)

Throws:

java.lang.IllegalArgumentException - if randomNumberOrigin is greater than or equal to randomNumberBound