SSJ  3.3.1
Stochastic Simulation in Java
Static Public Member Functions | List of all members
RandomPermutation Class Reference

Provides methods to randomly shuffle arrays or lists using a random stream. More...

Static Public Member Functions

static void init (byte[] array, int n)
 Initializes array with the first \(n\) positive integers in natural order as array \([i-1] = i\), for \(i=1,...,n\). More...
 
static void init (short[] array, int n)
 Similar to init(byte[], int). More...
 
static void init (int[] array, int n)
 Similar to init(byte[], int). More...
 
static void init (long[] array, int n)
 Similar to init(byte[], int). More...
 
static void init (float[] array, int n)
 Similar to init(byte[], int). More...
 
static void init (double[] array, int n)
 Similar to init(byte[], int). More...
 
static void shuffle (List<?> list, RandomStream stream)
 Same as java.util.Collections.shuffle(List<?>, Random), but uses a RandomStream instead of java.util.Random. More...
 
static void shuffle (Object[] array, RandomStream stream)
 Randomly permutes array using stream. More...
 
static void shuffle (byte[] array, RandomStream stream)
 Randomly permutes array using stream. More...
 
static void shuffle (short[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (int[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (long[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (char[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (boolean[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (float[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (double[] array, RandomStream stream)
 Similar to shuffle(byte[], RandomStream). More...
 
static void shuffle (List<?> list, int k, RandomStream stream)
 Partially permutes list as follows using stream: draws the first \(k\) new elements of list randomly among the \(n\) old elements of list, assuming that \(k \le n = \) list.size(). More...
 
static void shuffle (Object[] array, int n, int k, RandomStream stream)
 Partially permutes array as follows using stream: draws the new \(k\) elements, array[0] to array[k-1], randomly among the old \(n\) elements, array[0] to array[n-1], assuming that \(k \le n \le\) array.length. More...
 
static void shuffle (byte[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (short[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (int[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (long[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (char[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (boolean[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (float[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 
static void shuffle (double[] array, int n, int k, RandomStream stream)
 Similar to shuffle(Object[], n, k, RandomStream). More...
 

Detailed Description

Provides methods to randomly shuffle arrays or lists using a random stream.

Member Function Documentation

◆ init() [1/6]

static void init ( byte []  array,
int  n 
)
static

Initializes array with the first \(n\) positive integers in natural order as array \([i-1] = i\), for \(i=1,...,n\).

The size of array must be at least \(n\).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ init() [2/6]

static void init ( short []  array,
int  n 
)
static

Similar to init(byte[], int).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ init() [3/6]

static void init ( int []  array,
int  n 
)
static

Similar to init(byte[], int).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ init() [4/6]

static void init ( long []  array,
int  n 
)
static

Similar to init(byte[], int).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ init() [5/6]

static void init ( float []  array,
int  n 
)
static

Similar to init(byte[], int).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ init() [6/6]

static void init ( double []  array,
int  n 
)
static

Similar to init(byte[], int).

Parameters
arraythe array to initialize.
nnumber of elements initialized.

◆ shuffle() [1/20]

static void shuffle ( List<?>  list,
RandomStream  stream 
)
static

Same as java.util.Collections.shuffle(List<?>, Random), but uses a RandomStream instead of java.util.Random.

Parameters
listthe list being shuffled.
streamthe random stream used to generate integers.

◆ shuffle() [2/20]

static void shuffle ( Object []  array,
RandomStream  stream 
)
static

Randomly permutes array using stream.

This method permutes the whole array.

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [3/20]

static void shuffle ( byte []  array,
RandomStream  stream 
)
static

Randomly permutes array using stream.

This method permutes the whole array.

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [4/20]

static void shuffle ( short []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [5/20]

static void shuffle ( int []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [6/20]

static void shuffle ( long []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [7/20]

static void shuffle ( char []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [8/20]

static void shuffle ( boolean []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [9/20]

static void shuffle ( float []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [10/20]

static void shuffle ( double []  array,
RandomStream  stream 
)
static

Similar to shuffle(byte[], RandomStream).

Parameters
arraythe array being shuffled.
streamthe random stream used to generate random numbers.

◆ shuffle() [11/20]

static void shuffle ( List<?>  list,
int  k,
RandomStream  stream 
)
static

Partially permutes list as follows using stream: draws the first \(k\) new elements of list randomly among the \(n\) old elements of list, assuming that \(k \le n = \) list.size().

In other words, \(k\) elements are selected at random without replacement from the \(n\) list entries and are placed in the first \(k\) positions, in random order.

Parameters
listthe list being shuffled.
knumber of elements selected.
streamthe random stream used to generate integers.

◆ shuffle() [12/20]

static void shuffle ( Object []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Partially permutes array as follows using stream: draws the new \(k\) elements, array[0] to array[k-1], randomly among the old \(n\) elements, array[0] to array[n-1], assuming that \(k \le n \le\) array.length.

In other words, \(k\) elements are selected at random without replacement from the first \(n\) array elements and are placed in the first \(k\) positions, in random order.

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [13/20]

static void shuffle ( byte []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [14/20]

static void shuffle ( short []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [15/20]

static void shuffle ( int []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [16/20]

static void shuffle ( long []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [17/20]

static void shuffle ( char []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [18/20]

static void shuffle ( boolean []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [19/20]

static void shuffle ( float []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

◆ shuffle() [20/20]

static void shuffle ( double []  array,
int  n,
int  k,
RandomStream  stream 
)
static

Similar to shuffle(Object[], n, k, RandomStream).

Parameters
arraythe array being shuffled.
nselection amongst the first n elements.
knumber of elements selected.
streamthe random stream used to generate random numbers.

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