mirror/batteries
1
0
Fork 0
mirror of https://github.com/1bardesign/batteries.git synced 2024-09-20 00:42:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

added todo for tablex.weighted_random, removed returning the weight value as multi-return wasn't documented and could break in some circumstances

Browse Source
This commit is contained in:
Max Cahill 2021-11-18 10:35:26 +11:00
parent 7aa476a58c
commit 31bfe92d37
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tablex.lua
View File

@ -202,8 +202,11 @@ function tablex.take_random(t, r)
return table.remove(t, tablex.random_index(t, r)) return table.remove(t, tablex.random_index(t, r))
end end
--return a random index based on weights provided --return a random index based on weights provided (or nil if it's empty)
--Example: { 0.3, 1, 6, 0.5 } (3rd index most likely) -- { 0.3, 1, 6, 0.5 } -> (3rd index most likely)
-- possible todo:
-- provide normalisation outside of this function, require normalised weights
-- provide table of values _and_ weights and return the value
function tablex.weighted_random(t, r) function tablex.weighted_random(t, r)
if #t == 0 then if #t == 0 then
return nil return nil
@ -217,9 +220,11 @@ function tablex.weighted_random(t, r)
for i, weight in ipairs(t) do for i, weight in ipairs(t) do
sum = sum + weight sum = sum + weight
if rnd <= sum then if rnd <= sum then
return i, weight return i
end end
end end
--shouldn't get here but safety if using a random that returns >= 1
return #t
end end
--shuffle the order of a table --shuffle the order of a table