Class RandomSelector<Type>

A class for randomly selecting elements from a given list. This class assumes an equal distribution for all elements of the list.

Type Parameters

Type

Index

Constructors

Accessors

Methods

getRandomElement getRandomElementAndRemove

Constructors

constructor

new RandomSelector<Type>(elements): RandomSelector<Type>
Type Parameters
- Type
Parameters
- elements: Type[]
Returns RandomSelector<Type>
- Defined in random/random-selector.ts:33

Accessors

size

get size(): number
Get the number of elements in the list.

Returns number
- Defined in random/random-selector.ts:40

Methods

getRandomElement

getRandomElement(): undefined | Type
Selects random element from the list.
This method assumes an equal distribution for all elements of the list.
If the list is empty, the function will return undefined.

Returns undefined | Type
- Defined in random/random-selector.ts:49

getRandomElementAndRemove

getRandomElementAndRemove(): undefined | Type
Selects random element from the list, then removes that element from the list.
This method assumes an equal distribution for all elements of the list.
If the list is empty, the function will return undefined.

Returns undefined | Type
- Defined in random/random-selector.ts:58