Class WeightedList<T>

constructor

• new WeightedList<T>(list?: WeightedList<T>): WeightedList<T>

  Optionally merge with an existing WeightedList.

  Type Parameters

  • T

  Parameters

  • Optionallist: WeightedList<T>

    An existing WeightedList to merge with, if provided.

  Returns WeightedList<T>

clear

• clear(): void

  Remove all items from the list and reset it.

  Returns void

getTotalWeight

• getTotalWeight(): number

  Returns the total weight of all items inside the list.

  Returns number

  The total weight of all items.

popRandom

• popRandom(): InputEntry<T> | undefined

  Returns and removes a random item from the list based on its weight.

  Returns InputEntry<T> | undefined

  The item and its weight, or undefined if the list is empty.

probability

• probability(index: number): number | undefined

  Returns the probability of a specific item inside the list based on its weight.

  Parameters

  • index: number

    The index of the item.

  Returns number | undefined

  The probability of the item, or undefined if the index is invalid.

push

• push(...items: InputEntry<T>[]): void

  Add one or more objects with their associated weights.

  Parameters

  • ...items: InputEntry<T>[]

    One or more objects with their weights to add to the list.

  Returns void

random

• random(): T | undefined

  Get a random object from the list based on its weight. The higher the weight, the more likely it will be chosen.

  Returns T | undefined

  A random object from the list or undefined if the list is empty.

toString

• toString(): string

  Returns a string representation of the WeightedList.

  Returns string

  A string summarizing the list, including length, total weight, and item details.

values

• values(): T[]

  Returns all objects inside the list.

  Returns T[]

  An array of all objects in the list.

weights

• weights(): InputEntry<T>[]

  Returns a list of all objects and their associated weights.

  Returns InputEntry<T>[]

  An array of objects and their weights.

length