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.

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
DoubleStream	doubles() Returns an effectively unlimited stream of pseudorandom double values, each between zero (inclusive) and one (exclusive).
DoubleStream	doubles(double randomNumberOrigin, double randomNumberBound) Returns an effectively unlimited stream of pseudorandom double values, each conforming to the given origin (inclusive) and bound (exclusive)
DoubleStream	doubles(long streamSize) Returns a stream producing the given streamSize number of pseudorandom double values, each between zero (inclusive) and one (exclusive).
DoubleStream	doubles(long streamSize, double randomNumberOrigin, double randomNumberBound) Returns a stream producing the given streamSize number of pseudorandom double values, each conforming to the given origin (inclusive) and bound (exclusive).
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).
LongStream	longs() Returns an effectively unlimited stream of pseudorandom long values, each between zero (inclusive) and one (exclusive).
LongStream	longs(long streamSize) Returns a stream producing the given streamSize number of pseudorandom long values, each between zero (inclusive) and one (exclusive).
LongStream	longs(long randomNumberOrigin, long randomNumberBound) Returns an effectively unlimited stream of pseudorandom long values, each conforming to the given origin (inclusive) and bound (exclusive)
LongStream	longs(long streamSize, long randomNumberOrigin, long randomNumberBound) Returns a stream producing the given streamSize number of pseudorandom long 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(@NotNull
                    java.util.Random random)

Constructs object with the given Random instance.

Parameters:

random - Random instance

Method Detail

getRandom

@NotNull
public java.util.Random getRandom()

Returns underlying Random instance.

Returns:

Random object instance

ints

@NotNull
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

longs

@NotNull
public LongStream longs(long streamSize)

Returns a stream producing the given streamSize number of pseudorandom long values, each between zero (inclusive) and one (exclusive).

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

Parameters:

streamSize - the number of values to generate

Returns:

a stream of pseudorandom long values

Throws:

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

doubles

@NotNull
public DoubleStream doubles(long streamSize)

Returns a stream producing the given streamSize number of pseudorandom double values, each between zero (inclusive) and one (exclusive).

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

Parameters:

streamSize - the number of values to generate

Returns:

a stream of pseudorandom double values

Throws:

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

ints

@NotNull
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

longs

@NotNull
public LongStream longs()

Returns an effectively unlimited stream of pseudorandom long values, each between zero (inclusive) and one (exclusive).

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

Returns:

a stream of pseudorandom long values

doubles

@NotNull
public DoubleStream doubles()

Returns an effectively unlimited stream of pseudorandom double values, each between zero (inclusive) and one (exclusive).

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

Returns:

a stream of pseudorandom double values

ints

@NotNull
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

longs

@NotNull
public LongStream longs(long streamSize,
                                 long randomNumberOrigin,
                                 long randomNumberBound)

Returns a stream producing the given streamSize number of pseudorandom long 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 long 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

doubles

@NotNull
public DoubleStream doubles(long streamSize,
                                     double randomNumberOrigin,
                                     double randomNumberBound)

Returns a stream producing the given streamSize number of pseudorandom double 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 double 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

@NotNull
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

longs

@NotNull
public LongStream longs(long randomNumberOrigin,
                                 long randomNumberBound)

Returns an effectively unlimited stream of pseudorandom long 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 long values, each with the given origin (inclusive) and bound (exclusive)

Throws:

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

doubles

@NotNull
public DoubleStream doubles(double randomNumberOrigin,
                                     double randomNumberBound)

Returns an effectively unlimited stream of pseudorandom double 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 double values, each with the given origin (inclusive) and bound (exclusive)

Throws:

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