How do I create a weighted collection and then pick a random element from it?

Question

I have a loot box that I want to fill with a random item. But I want each item to have a different chance of being picked. For example:

• 5% chance of 10 gold
• 20% chance of sword
• 45% chance of shield
• 20% chance of armor
• 10% chance of potion

How can I make it so that I select exactly one of the items above, where those percentages are the respective chances of getting the loot?

Answer 1

The Soft-coded Probabilities Solution

The hardcoded probability solution has the disadvantage that you need to set the probabilities in your code. You can't determine them at runtime. It is also hard to maintain.

Here is a dynamic version of the same algorithm.

1. Create an array of pairs of actual items and weight of each item
2. When you add an item, the weight of the item needs to be its own weight plus the sum of the weights of all items already in the array. So you should track the sum separately. Especially because you will need it for the next step.
3. To retrieve an object, generate a random number between 0 and the sum of the weights of all items
4. iterate the array from start to finish until you found an entry with a weight larger or equal than the random number

Here is a sample implementation in Java in form of a template class which you can instantiate for any object your game uses. You can then add objects with the method .addEntry(object, relativeWeight) and pick one of the entries you added previously with .get()

import java.util.ArrayList;
import java.util.List;
import java.util.Random;

public class WeightedRandomBag<T extends Object> {

    private class Entry {
        double accumulatedWeight;
        T object;
    }

    private List<Entry> entries = new ArrayList<>();
    private double accumulatedWeight;
    private Random rand = new Random();

    public void addEntry(T object, double weight) {
        accumulatedWeight += weight;
        Entry e = new Entry();
        e.object = object;
        e.accumulatedWeight = accumulatedWeight;
        entries.add(e);
    }

    public T getRandom() {
        double r = rand.nextDouble() * accumulatedWeight;

        for (Entry entry: entries) {
            if (entry.accumulatedWeight >= r) {
                return entry.object;
            }
        }
        return null; //should only happen when there are no entries
    }
}

Usage:

WeightedRandomBag<String> itemDrops = new WeightedRandomBag<>();

// Setup - a real game would read this information from a configuration file or database
itemDrops.addEntry("10 Gold",  5.0);
itemDrops.addEntry("Sword",   20.0);
itemDrops.addEntry("Shield",  45.0);
itemDrops.addEntry("Armor",   20.0);
itemDrops.addEntry("Potion",  10.0);

// drawing random entries from it
for (int i = 0; i < 20; i++) {
    System.out.println(itemDrops.getRandom());
}

---

Here is the same class implemented in C# for your Unity, XNA or MonoGame project:

using System;
using System.Collections.Generic;

class WeightedRandomBag<T>  {

    private struct Entry {
        public double accumulatedWeight;
        public T item;
    }

    private List<Entry> entries = new List<Entry>();
    private double accumulatedWeight;
    private Random rand = new Random();

    public void AddEntry(T item, double weight) {
        accumulatedWeight += weight;
        entries.Add(new Entry { item = item, accumulatedWeight = accumulatedWeight });
    }

    public T GetRandom() {
        double r = rand.NextDouble() * accumulatedWeight;

        foreach (Entry entry in entries) {
            if (entry.accumulatedWeight >= r) {
                return entry.item;
            }
        }
        return default(T); //should only happen when there are no entries
    }
}

---

And here is one in JavaScript:

var WeightedRandomBag = function() {

    var entries = [];
    var accumulatedWeight = 0.0;

    this.addEntry = function(object, weight) {
        accumulatedWeight += weight;
        entries.push( { object: object, accumulatedWeight: accumulatedWeight });
    }

    this.getRandom = function() {
        var r = Math.random() * accumulatedWeight;
        return entries.find(function(entry) {
            return entry.accumulatedWeight >= r;
        }).object;
    }   
}

Pro:

• Can handle any weight ratios. You can have items with astronomically small probability in the set if you want to. The weights also don't need to add up to 100.
• You can read the items and weights at runtime
• Memory usage proportional to the number of items in the array

Contra:

• Requires some more programming to get right
• In the worst case, you might have to iterate the whole array (O(n) runtime complexity). So when you have a very large set of items and draw very often, it might become slow. A simple optimization is to put the most probable items first so the algorithm terminates early in most cases. A more complex optimization you can do is to exploit the fact that the array is sorted and do a bisection search. This only takes O(log n) time.
• You need to build the list in memory before you can use it (although you can easily add items at runtime. Removing items could also be added, but that would require to update the accumulated weights of all items which come after the removed entry, which again has O(n) worst case runtime)

Answer 2

Note: I created a C# library for this exact problem

The other solutions are fine if you only have a small number of items and your probabilities never change. However, with lots of items or changing probabilities (ex. removing items after selecting them), you'll want something more powerful.

Here are the two most common solutions (both of which are included in the above library)

Walker's Alias Method

A clever solution that's extremely fast (O(1)!) if your probabilities are constant. In essence, the algorithm creates a 2D dartboard ("alias table") out of your probabilities and throws a dart at it.

There are plenty of articles online about how it works if you'd like to learn more.

The only issue is that if your probabilities change, you need to regenerate the alias table, which is slow. Thus, if you need to remove items after they're picked, this is not the solution for you.

Tree-based solution

The other common solution is to make an array where each item stores the sum of its probability and all the items before it. Then just generate a random number from [0,1) and do a binary search for where that number lands in the list.

This solution is very easy to code/understand, but making a selection is slower than Walker's Alias Method, and changing the probabilities is still O(n). We can improve it by turning the array into a binary-search tree, where each node keeps track of the sum-of-probabilities in all the items in its subtree. Then when we generate the number from [0,1), we can just walk down the tree to find the item it represents.

This gives us O(log n) to pick an item and to change the probabilities! This makes NextWithRemoval() extremely fast!

The results

Here are some quick benchmarks from the above library, comparing these two approaches

         WeightedRandomizer Benchmarks                  |    Tree    |    Table
-----------------------------------------------------------------------------------
Add()x10000 + NextWithReplacement()x10:                 |    4 ms    |      2 ms
Add()x10000 + NextWithReplacement()x10000:              |    7 ms    |      4 ms
Add()x10000 + NextWithReplacement()x100000:             |   35 ms    |     28 ms
( Add() + NextWithReplacement() )x10000 (interleaved)   |    8 ms    |   5403 ms
Add()x10000 + NextWithRemoval()x10000:                  |   10 ms    |   5948 ms

So as you can see, for the special case of static (non-changing) probabilities, Walker's Alias method is about 50-100% faster. But in the more dynamic cases, the tree is several orders of magnitude faster!

Answer 3

The Wheel of Fortune solution

You can use this method when the probabilities in your item pool have a rather large common denominator and you need to draw from it very often.

Create an array of options. But put each element into it multiple times, with the number of duplicates of each element proportional to its chance of appearing. For the example above, all elements have probabilities which are multipliers of 5%, so you can create an array of 20 elements like this:

10 gold
sword
sword
sword
sword
shield
shield
shield
shield
shield
shield
shield
armor
armor
armor
armor
potion
potion

Then simply pick a random element of that list by generating one random integer between 0 and the length of the array - 1.

Disadvantages:

• You need to build the array the first time you want to generate an item.
• When one of your elements is supposed to have a very low probability, you end up with a really large array, which can require a lot of memory.

Advantages:

• When you already have the array and want to draw from it multiple times, then it is very fast. Just one random integer and one array access.

Answer 4

The Hard-coded Probabilities Solution

The most simple way find a random item from a weighted collection is to traverse down a chain of if-else statements, where each if-else increases in probably, as the previous one does not hit.

int rand = random(100); //Random number between 1 and 100 (inclusive)
if(rand <= 5) //5% chance
{
    print("You found 10 gold!");
}
else if(rand <= 25) //20% chance
{
    print("You found a sword!");
}
else if(rand <= 70) //45% chance
{
    print("You found a shield!");
}
else if(rand <= 90) //20% chance
{
    print("You found armor!");
}
else //10% chance
{
    print("You found a potion!");
}

The reason the conditionals are equal to its chance plus all of the previous conditionals chances is because the previous conditionals have already eliminated the possibility of it being those items. So for the shield's conditional else if(rand <= 70), 70 is equal to the 45% chance of the shield, plus the 5% chance of the gold and 20% chance of the sword.

Advantages:

• Easy to program, because it requires no data structures.

Disadvantages:

• Hard to maintain, because you need to maintain your drop-rates in your code. You can't determine them at runtime. So if you want something more future proof, you should check the other answers.

Answer 5

In C# you could use a Linq scan to run your accumulator to check against a random number in the range 0 to 100.0f and .First() to get. So like one line of code.

So something like:

var item = a.Select(x =>
{
    sum += x.prob;
    if (rand < sum)
        return x.item;
    else
        return null;
 }).FirstOrDefault());

sum is a zero initialized integer and a is a list of prob/item structs/tuples/instances. rand is a previously generated random number in the range.

This simply accumulates the sum over the list of ranges until it exceeds the previously selected random number, and returns either the item or null, where null would be returned if the random number range (e.g. 100) is less than the total weighting range by mistake, and the random number selected is outside the total weighting range.

However, you will notice that weights in OP closely match a normal distribution (Bell Curve). I think in general you will not want specific ranges, you will tend to want a distribution that tapers off either around a bell curve or just on a decreasing exponential curve (for example). In this case you could just use a mathematical formula to generate an index into an array of items, sorted in order of preferred probability. A good example is CDF in normal distribution

Also an example here.

Another example is that you could take a random value from 90 degrees to 180 degrees to get the lower right quadrant of a circle, take the x component using cos(r) and use that to index into a prioritized list.

With different formulae you could have a general approach where you just input a prioritized list of any length (e.g. N) and map the outcome of the formula (e.g.: cos(x) is 0 to 1) by multiplication (e.g.: Ncos(x) = 0 to N) to get the index.

Answer 6

Probabilities don’t need to be hard-coded. The items and the thresholds can be together in an array.

for X in items’range loop
  If items (X).threshold < random() then
     Announce (items(X).name)
     Exit loop
  End if
End loop

You do have to accumulate the thresholds still, but you can do it when creating a parameter file instead of coding it.

Answer 7

Not really a new answer, but modifications to two of the answers above with:

1. Adjusted for removal of objects from the pool.
2. Added Supplier for easy stream construction (static <T> Stream<T> generate(Supplier<T> s)), if needed.
3. Not thread safe, so you may want to synchronize methods.
4. Java 16+

/**
 * Remove items from a pool, with probability proportionate to a (positive) item weight.
 * @param <T>
 */
public class WeightedRandomBag<T> implements Supplier<T> {

    private static record Entry<T>(double weight, T object) {}

    final private List<Entry<T>> entries = new ArrayList<>();
    private double accumulatedWeight;
    final private Random rand = new Random();

    public void addEntry(T object, double weight) {
        if (weight < 0) throw new IllegalArgumentException("weight cannot be negative");
        accumulatedWeight += weight;
        entries.add(new Entry<>(weight, object));
    }

    /**
     * This operation also removes the entry from the pool!
     */
    @Override
    public T get() {
        double r = rand.nextDouble() * accumulatedWeight;
        double currentAccumulatedWeight = 0;
        for (int i = 0; i < entries.size(); i++) {
            var entry = entries.get(i);
            currentAccumulatedWeight += entry.weight;
            if (currentAccumulatedWeight >= r) {
                accumulatedWeight -= entry.weight;
                return entries.remove(i).object;
            }
        }
        return null;
    }

}

/**
 * Remove items from a pool, with probability proportionate to a (positive) item priority.
 * @param <T>
 */
public class WheelOfFortune<T> implements Supplier<T> {

    final private ArrayList<T> entries = new ArrayList<>();

    public void add(T object, int priority) {
        if (priority <= 0) throw new IllegalArgumentException("priority must be >1");
        for (int i = 0; i < priority; i++) entries.add(object);
    }

    /**
     * This operation also removes the entry from the pool!
     */
    @Override
    public T get() {
        if (entries.isEmpty()) return null;
        int i = (int) (Math.random() * entries.size());
        return entries.remove(i);
    }

}
```

Answer 8

I done this function: https://github.com/thewheelmaker/GDscript_Weighted_Random Now! in your case you can use it like this:

on_normal_case([5,20,45,20,10],0)

It gives just a number between 0 to 4 but you can put it in array where you got the items.

item_array[on_normal_case([5,20,45,20,10],0)]

Or in function:

item_function(on_normal_case([5,20,45,20,10],0))

Here is the code. I made it on GDscript, you can, but it can alter other language, also check for logic errors:

func on_normal_case(arrayy,transformm):
    var random_num=0
    var sum=0
    var summatut=0
    #func sumarrays_inarray(array):
    for i in range(arrayy.size()):
        sum=sum+arrayy[i]
#func no_fixu_random_num(here_range,start_from):
    random_num=randi()%sum+1
#Randomies be pressed down
#first start from zero
    if 0<=random_num and random_num<=arrayy[0]:
        #print(random_num)
        #print(array[0])
        return 0+ transformm
    summatut=summatut+arrayy[0]
    for i in range(arrayy.size()-1):
        #they must pluss together
        #if array[i]<=random_num and random_num<array[i+1]:
        if summatut<random_num and random_num<=summatut+arrayy[i+1]:
            #return i+1+transform
            #print(random_num)
            #print(summatut)
            return i+1+ transformm

        summatut=summatut+arrayy[i+1]
    pass

It works like this: on_normal_case([50,50],0) This gives 0 or 1, it has same probability both.

on_normal_case([50,50],1) This gives 1 or 2, it has same probability both.

on_normal_case([20,80],1) This gives 1 or 2, it has bigger change to get two.

on_normal_case([20,80,20,20,30],1) This give random numbers range 1-5 and bigger numbers are more likely than smaller numbers.

on_normal_case([20,80,0,0,20,20,30,0,0,0,0,33],45) This throw dices between numbers 45,46,49,50,51,56 you see when there is zero it never occure.

So it function returns just one random number that depends lenght of that arrayy array and transformm number, and ints in the array are probability weights that a number might occure, where that number is location on the array, pluss transformm number.