Skip to content

Docs: explain weightedPick distribution #7366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ICOM725 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: explain weightedPick distribution #7366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/math/random-data-generator/RandomDataGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,12 @@ var RandomDataGenerator = new Class({
/**
* Returns a random element from within the given array, favoring the earlier entries.
*
* The index is calculated as `floor(u * u * (n - 0.5) + 0.5)`, where `u` is a
* uniform random value from 0 (inclusive) to 1 (exclusive) and `n` is the array length.
* Squaring `u` biases the selection toward the start of the array; the weights
* do not decrease linearly. For an array of four elements, the probabilities are
* approximately 37.8%, 27.7%, 19.1% and 15.5%, in index order.
*
* @method Phaser.Math.RandomDataGenerator#weightedPick
* @since 3.0.0
*
Expand Down