selectRandomWeighted: Difference between revisions
Jump to navigation
Jump to search
(Move to 1.76 category) |
m (template:command argument fix) |
||
| Line 11: | Line 11: | ||
* The weights don't have to total to 1 | * The weights don't have to total to 1 | ||
* If numbers of items and weights do not match, the shortest array is used | * If numbers of items and weights do not match, the shortest array is used | ||
* A single array Syntax is slightly faster then Alt Syntax |= | * A single array Syntax is slightly faster then Alt Syntax |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|'''selectRandomWeighted''' valuesAndWeights |= | |'''selectRandomWeighted''' valuesAndWeights |SYNTAX= | ||
|p1= valuesAndWeights: [[Array]] - array in format [value1, weight1, value2, weight2...], where:<span> | |p1= valuesAndWeights: [[Array]] - array in format [value1, weight1, value2, weight2...], where:<span> | ||
| Line 21: | Line 21: | ||
</span> | </span> | ||
| [[Anything]] - random weighted value or [[Nothing]] if array is empty or all weights are 0 |= | | [[Anything]] - random weighted value or [[Nothing]] if array is empty or all weights are 0 |RETURNVALUE= | ||
|s2 = values '''selectRandomWeighted''' weights |= | |s2 = values '''selectRandomWeighted''' weights |SYNTAX= | ||
|p21= values: [[Array]] - array of [[Anything]] | |p21= values: [[Array]] - array of [[Anything]] | ||
|p22= weights: [[Array]] - array of [[Number]]s | |p22= weights: [[Array]] - array of [[Number]]s | ||
| r2 = [[Anything]] - random weighted value or [[Nothing]] if any of arrays is empty or all weights are 0 |= | | r2 = [[Anything]] - random weighted value or [[Nothing]] if any of arrays is empty or all weights are 0 |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_randomWeightedElement = [[selectRandomWeighted]] [1,0.1,2,0.2,3,1.3,4,2.4,5,7.5];</code> |= | |x1= <code>_randomWeightedElement = [[selectRandomWeighted]] [1,0.1,2,0.2,3,1.3,4,2.4,5,7.5];</code> |EXAMPLE1= | ||
|x2= <code>_randomWeightedElement = [1,2,3,4,5] [[selectRandomWeighted]] [0.1,0.2,1.3,2.4,7.5];</code> |= | |x2= <code>_randomWeightedElement = [1,2,3,4,5] [[selectRandomWeighted]] [0.1,0.2,1.3,2.4,7.5];</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[random]], [[select]], [[selectRandom]], [[selectMin]], [[selectMax]] |= | | [[random]], [[select]], [[selectRandom]], [[selectMin]], [[selectMax]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:46, 7 April 2019
Description
- Description:
- Returns a random element from the given array according to assigned weights. Engine solution to BIS_fnc_selectRandomWeighted. A few notes:
- Negative weights are not supported
- If an item's weight is 0, the item is ignored
- The weights don't have to total to 1
- If numbers of items and weights do not match, the shortest array is used
- A single array Syntax is slightly faster then Alt Syntax
- Groups:
- Uncategorised
Syntax
- Syntax:
- selectRandomWeighted valuesAndWeights
- Parameters:
- valuesAndWeights: Array - array in format [value1, weight1, value2, weight2...], where:
- Return Value:
- Anything - random weighted value or Nothing if array is empty or all weights are 0
Alternative Syntax
- Syntax:
- values selectRandomWeighted weights
- Parameters:
- values: Array - array of Anything
- weights: Array - array of Numbers
- Return Value:
- Anything - random weighted value or Nothing if any of arrays is empty or all weights are 0
Examples
- Example 1:
_randomWeightedElement = selectRandomWeighted [1,0.1,2,0.2,3,1.3,4,2.4,5,7.5];- Example 2:
_randomWeightedElement = [1,2,3,4,5] selectRandomWeighted [0.1,0.2,1.3,2.4,7.5];
Additional Information
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
- Posted on June 26, 2017 - 19:17 (UTC)
- Killzone Kid
- A 100000 runs of the following code:
_values = [0,1,2,3,4,5,6,7,8,9]; _weights = [0.109,0.65,0.01,1.01,1.24,0,1.59,0.09,1.15,0.55]; _result = _values selectRandomWeighted _weights;Gave this result:0 - 0 0.01 - 144 0.09 - 1409 0.109 - 1633 0.55 - 8673 0.65 - 10127 1.01 - 15668 1.15 - 18059 1.24 - 19518 1.59 - 24769