A static-util class that provides additional functionality for generating pseudo-random numbers. More...

Static Public Member Functions
static float	floatRandom (float range)
	Returns a pseudo-random `float` between inclusive `0` and exclusive `range`.
static double	inclusive (double min, double max)
	Returns a pseudo-random `int` value between inclusive `min` and inclusive `max`.
static int	inclusive (int min, int max)
	Returns a pseudo-random `int` value between inclusive `min` and inclusive `max`.
static int	inclusive (int range)
	Returns a pseudo-random `int` value between inclusive `0` and inclusive `range`.
static int	inclusiveExcludes (int min, int max, int... exclude)
	Returns a pseudo-random `int` value between inclusive `min` and inclusive `max` excluding the specified numbers within the `excludes` array.
static boolean	nextBoolean ()
	Returns a pseudo-random `boolean`.
static double	nextDouble ()
	Returns a pseudo-random `double`.
static boolean	random (boolean... array)
	Pseudo-randomly retrieves an `boolean` from this `array`.
static byte	random (byte... array)
	Pseudo-randomly retrieves an `byte` from this `array`.
static char	random (char... array)
	Pseudo-randomly retrieves an `char` from this `array`.
static double	random (double... array)
	Pseudo-randomly retrieves an `double` from this `array`.
static float	random (float... array)
	Pseudo-randomly retrieves an `float` from this `array`.
static int	random (int... array)
	Pseudo-randomly retrieves an `int` from this `array`.
static< T > T	random (List< T > list)
	Pseudo-randomly retrieves a element from `list`.
static long	random (long... array)
	Pseudo-randomly retrieves an `long` from this `array`.
static short	random (short... array)
	Pseudo-randomly retrieves an `short` from this `array`.
static< T > T	random (T[] array)
	Pseudo-randomly retrieves a element from `array`.
static< T > T	randomExclude (T[] array, T exclude)
	Returns a pseudo-random `int` value between inclusive `min` and inclusive `max` excluding the specified numbers within the `excludes` array.
static boolean[]	shuffle (boolean[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `boolean` array.
static byte[]	shuffle (byte[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `byte` array.
static char[]	shuffle (char[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `char` array.
static double[]	shuffle (double[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `double` array.
static float[]	shuffle (float[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `float` array.
static int[]	shuffle (int[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `int` array.
static long[]	shuffle (long[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `long` array.
static short[]	shuffle (short[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `short` array.
static< T > T[]	shuffle (T[] array)
	An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an `T` array.
static boolean	success (double value)
	Determines if a pseudorandomly generated double rounded to two decimal places is below or equal to `value`.

Private Member Functions
	RandomUtils ()
	A private constructor to discourage external instantiation.

Detailed Description

A static-util class that provides additional functionality for generating pseudo-random numbers.

All functions in this class are backed by ThreadLocalRandom rather than the more commonly used Random. It is generally preferred to use this over Random because although Random is thread safe; the same seed is shared concurrently, which leads to contention between multiple threads and overhead as a result. Surprisingly because of the way that ThreadLocalRandom works, even in completely single-threaded situations it runs up to three times faster than Random.

Author: lare96 http://github.com/lare96

See also: java.util.Random and java.util.concurrent.ThreadLocalRandom in multithreaded environments

Definition at line 22 of file RandomUtils.java.

Constructor & Destructor Documentation

◆ RandomUtils()

com.runehive.util.RandomUtils.RandomUtils ( )

private

A private constructor to discourage external instantiation.

Definition at line 27 of file RandomUtils.java.

27 {

28 }

Member Function Documentation

◆ floatRandom()

float com.runehive.util.RandomUtils.floatRandom ( float range )

static

Returns a pseudo-random float between inclusive 0 and exclusive range.

Parameters

range The exclusive range.

Returns: The pseudo-random float.

Exceptions

IllegalArgumentException If the specified range is less than 0.

Definition at line 56 of file RandomUtils.java.

                                                 {
        if (range < 0F)
            throw new IllegalArgumentException("range <= 0");
        return ThreadLocalRandom.current().nextFloat() * range;
    }

◆ inclusive() [1/3]

double com.runehive.util.RandomUtils.inclusive	(	double	min,
		double	max )

static

Returns a pseudo-random int value between inclusive min and inclusive max.

Parameters

min	The minimum inclusive number.
max	The maximum inclusive number.

Returns: The pseudo-random int.

Exceptions

IllegalArgumentException If max - min + 1 is less than 0.

Definition at line 87 of file RandomUtils.java.

                                                           {
        if (min == max)
            return min;
        checkArgument(max >= min, "max < min");
        return ThreadLocalRandom.current().nextDouble(max - min) + min;
    }

◆ inclusive() [2/3]

int com.runehive.util.RandomUtils.inclusive	(	int	min,
		int	max )

static

Returns a pseudo-random int value between inclusive min and inclusive max.

Parameters

min	The minimum inclusive number.
max	The maximum inclusive number.

Returns: The pseudo-random int.

Exceptions

IllegalArgumentException If max - min + 1 is less than 0.

Definition at line 70 of file RandomUtils.java.

                                                  {
        if (min == max)
            return min;
        checkArgument(max >= min, "max < min");
        return ThreadLocalRandom.current().nextInt((max - min) + 1) + min;
    }

Here is the caller graph for this function:

◆ inclusive() [3/3]

int com.runehive.util.RandomUtils.inclusive ( int range )

static

Returns a pseudo-random int value between inclusive 0 and inclusive range.

Parameters

range The maximum inclusive number.

Returns: The pseudo-random int.

Exceptions

IllegalArgumentException If max - min + 1 is less than 0.

Definition at line 101 of file RandomUtils.java.

                                           {
        return inclusive(0, range);
    }

References inclusive().

Here is the call graph for this function:

◆ inclusiveExcludes()

int com.runehive.util.RandomUtils.inclusiveExcludes	(	int	min,
		int	max,
		int...	exclude )

static

Returns a pseudo-random int value between inclusive min and inclusive max excluding the specified numbers within the excludes array.

Parameters

min	the minimum inclusive number.
max	the maximum inclusive number.

Returns: the pseudo-random int.

Exceptions

IllegalArgumentException if max - min + 1 is less than 0.

Definition at line 359 of file RandomUtils.java.

                                                                          {
        Arrays.sort(exclude);
 
        int result = inclusive(min, max);
        while (Arrays.binarySearch(exclude, result) >= 0) {
            result = inclusive(min, max);
        }
 
        return result;
    }

References inclusive().

Referenced by com.runehive.game.world.entity.combat.magic.MagicImpact.kbdShock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextBoolean()

boolean com.runehive.util.RandomUtils.nextBoolean ( )

static

Returns a pseudo-random boolean.

Returns: The pseudo-random boolean.

Definition at line 35 of file RandomUtils.java.

                                        {
        return ThreadLocalRandom.current().nextBoolean();
    }

◆ nextDouble()

double com.runehive.util.RandomUtils.nextDouble ( )

static

Returns a pseudo-random double.

Returns: The pseudo-random double.

Definition at line 44 of file RandomUtils.java.

                                      {
        return ThreadLocalRandom.current().nextDouble();
    }

◆ random() [1/10]

boolean com.runehive.util.RandomUtils.random ( boolean... array )

static

Pseudo-randomly retrieves an boolean from this array.

Parameters

array The array to retrieve an boolean from.

Returns: The boolean retrieved from the array.

Definition at line 181 of file RandomUtils.java.

                                                   {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [2/10]

byte com.runehive.util.RandomUtils.random ( byte... array )

static

Pseudo-randomly retrieves an byte from this array.

Parameters

array The array to retrieve an byte from.

Returns: The byte retrieved from the array.

Definition at line 161 of file RandomUtils.java.

                                             {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [3/10]

char com.runehive.util.RandomUtils.random ( char... array )

static

Pseudo-randomly retrieves an char from this array.

Parameters

array The array to retrieve an char from.

Returns: The char retrieved from the array.

Definition at line 191 of file RandomUtils.java.

                                             {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [4/10]

double com.runehive.util.RandomUtils.random ( double... array )

static

Pseudo-randomly retrieves an double from this array.

Parameters

array The array to retrieve an double from.

Returns: The double retrieved from the array.

Definition at line 141 of file RandomUtils.java.

                                                 {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [5/10]

float com.runehive.util.RandomUtils.random ( float... array )

static

Pseudo-randomly retrieves an float from this array.

Parameters

array The array to retrieve an float from.

Returns: The float retrieved from the array.

Definition at line 171 of file RandomUtils.java.

                                               {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [6/10]

int com.runehive.util.RandomUtils.random ( int... array )

static

Pseudo-randomly retrieves an int from this array.

Parameters

array The array to retrieve an int from.

Returns: The int retrieved from the array.

Definition at line 121 of file RandomUtils.java.

                                           {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [7/10]

static< T > T com.runehive.util.RandomUtils.random ( List< T > list )

static

Pseudo-randomly retrieves a element from list.

Parameters

list	The list to retrieve an element from.

Returns: The element retrieved from the list.

Definition at line 201 of file RandomUtils.java.

                                             {
        if (list.isEmpty()) return null;
        return list.get((int) (ThreadLocalRandom.current().nextDouble() * list.size()));
    }

◆ random() [8/10]

long com.runehive.util.RandomUtils.random ( long... array )

static

Pseudo-randomly retrieves an long from this array.

Parameters

array The array to retrieve an long from.

Returns: The long retrieved from the array.

Definition at line 131 of file RandomUtils.java.

                                             {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [9/10]

short com.runehive.util.RandomUtils.random ( short... array )

static

Pseudo-randomly retrieves an short from this array.

Parameters

array The array to retrieve an short from.

Returns: The short retrieved from the array.

Definition at line 151 of file RandomUtils.java.

                                               {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

◆ random() [10/10]

static< T > T com.runehive.util.RandomUtils.random ( T[] array )

static

Pseudo-randomly retrieves a element from array.

Parameters

array The array to retrieve an element from.

Returns: The element retrieved from the array.

Definition at line 111 of file RandomUtils.java.

                                          {
        return array[(int) (ThreadLocalRandom.current().nextDouble() * array.length)];
    }

Here is the caller graph for this function:

◆ randomExclude()

static< T > T com.runehive.util.RandomUtils.randomExclude	(	T[]	array,
		T	exclude )

static

Returns a pseudo-random int value between inclusive min and inclusive max excluding the specified numbers within the excludes array.

Returns: the pseudo-random int.

Exceptions

IllegalArgumentException if max - min + 1 is less than 0.

Definition at line 378 of file RandomUtils.java.

                                                            {
        T result = random(array);
        while (exclude.equals(result))
            result = random(array);
        return result;
    }

References random().

Referenced by com.runehive.game.world.entity.combat.strategy.npc.boss.Venenatis.Web.finishOutgoing(), com.runehive.game.world.entity.combat.strategy.npc.boss.DemonicGorillas.getNextForm(), com.runehive.game.world.entity.combat.strategy.npc.boss.DemonicGorillas.getNextStrategy(), com.runehive.game.world.entity.combat.strategy.npc.boss.Hydra.getNextStrategy(), com.runehive.content.activity.impl.zulrah.ZulrahActivity.nextForm(), and com.runehive.game.world.entity.combat.strategy.npc.boss.StoneGuardian.nextForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shuffle() [1/9]

boolean[] com.runehive.util.RandomUtils.shuffle ( boolean[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an boolean array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 324 of file RandomUtils.java.

                                                     {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            boolean a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [2/9]

byte[] com.runehive.util.RandomUtils.shuffle ( byte[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an byte array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 292 of file RandomUtils.java.

                                               {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            byte a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [3/9]

char[] com.runehive.util.RandomUtils.shuffle ( char[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an char array.

Parameters

array The array that will be shuffled.

Definition at line 339 of file RandomUtils.java.

                                               {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            char a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [4/9]

double[] com.runehive.util.RandomUtils.shuffle ( double[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an double array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 260 of file RandomUtils.java.

                                                   {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            double a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [5/9]

float[] com.runehive.util.RandomUtils.shuffle ( float[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an float array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 308 of file RandomUtils.java.

                                                 {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            float a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [6/9]

int[] com.runehive.util.RandomUtils.shuffle ( int[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an int array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 228 of file RandomUtils.java.

                                             {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            int a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [7/9]

long[] com.runehive.util.RandomUtils.shuffle ( long[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an long array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 244 of file RandomUtils.java.

                                               {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            long a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [8/9]

short[] com.runehive.util.RandomUtils.shuffle ( short[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an short array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 276 of file RandomUtils.java.

                                                 {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            short a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ shuffle() [9/9]

static< T > T[] com.runehive.util.RandomUtils.shuffle ( T[] array )

static

An implementation of the Fisher-Yates shuffle algorithm that will shuffle the elements of an T array.

Parameters

array The array that will be shuffled.

Returns: The shuffled array.

Definition at line 212 of file RandomUtils.java.

                                             {
        for (int i = array.length - 1; i > 0; i--) {
            int index = ThreadLocalRandom.current().nextInt(i + 1);
            T a = array[index];
            array[index] = array[i];
            array[i] = a;
        }
        return array;
    }

◆ success()

boolean com.runehive.util.RandomUtils.success ( double value )

static

Determines if a pseudorandomly generated double rounded to two decimal places is below or equal to value.

Parameters

value the value to determine this for.

Returns: true if successful, false otherwise.

Definition at line 392 of file RandomUtils.java.

                                                {
        return value >= 1.00 || ThreadLocalRandom.current().nextDouble() <= value;
    }

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

java/com/runehive/util/RandomUtils.java

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RandomUtils()

Member Function Documentation

◆ floatRandom()

◆ inclusive() [1/3]

◆ inclusive() [2/3]

◆ inclusive() [3/3]

◆ inclusiveExcludes()

◆ nextBoolean()

◆ nextDouble()

◆ random() [1/10]

◆ random() [2/10]

◆ random() [3/10]

◆ random() [4/10]

◆ random() [5/10]

◆ random() [6/10]

◆ random() [7/10]

◆ random() [8/10]

◆ random() [9/10]

◆ random() [10/10]

◆ randomExclude()

◆ shuffle() [1/9]

◆ shuffle() [2/9]

◆ shuffle() [3/9]

◆ shuffle() [4/9]

◆ shuffle() [5/9]

◆ shuffle() [6/9]

◆ shuffle() [7/9]

◆ shuffle() [8/9]

◆ shuffle() [9/9]

◆ success()