@quenty/randomutils 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@3.0.0...@quenty/randomutils@3.1.0) (2023-12-14)
+
+
+### Features
+
+* Cache random choice calculations to be speedy ([c32f301](https://github.com/Quenty/NevermoreEngine/commit/c32f30184d11e1ce04e3e9fa2cbd21861c54a09b))
+
+
+
+
+
 # [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@2.3.0...@quenty/randomutils@3.0.0) (2023-10-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/randomutils",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Quenty's RandomUtils, utility functions for Roblox",
   "keywords": [
     "Roblox",
@@ -29,8 +29,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/loader": "^7.0.0",
-    "@quenty/table": "^3.3.0"
+    "@quenty/loader": "^7.1.0",
+    "@quenty/table": "^3.4.0"
   },
-  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Shared/WeightedRandomChooser.lua

@@ -4,7 +4,6 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local RandomUtils = require("RandomUtils")
 local Table = require("Table")
 
 local WeightedRandomChooser = {}
@@ -35,9 +34,23 @@ function WeightedRandomChooser:SetWeight(option, weight)
 	assert(option ~= nil, "Bad option")
 	assert(type(weight) == "number" or weight == nil, "Bad weight")
 
+	if self._optionToWeight[option] == weight then
+		return
+	end
+
+	self._cache = nil
 	self._optionToWeight[option] = weight
 end
 
+--[=[
+	Removes the option from the chooser. Equivalent of setting the weight to nil
+
+	@param option T
+]=]
+function WeightedRandomChooser:Remove(option)
+	self:SetWeight(option, nil)
+end
+
 --[=[
 	Gets the weight for the option
 
@@ -60,37 +73,64 @@ function WeightedRandomChooser:GetProbability(option)
 		return nil
 	end
 
-	-- TODO: Cache if we call like a million times
-	local total = 0
-	for _, item in pairs(self._optionToWeight) do
-		total = total + item
-	end
-
-	return weight/total
+	local cache = self:_getOrCreateDataCache()
+	return weight/cache.total
 end
 
 --[=[
-	Removes the option from the chooser. Equivalent of setting the weight to nil
+	Picks a weighted choise
 
-	@param option T
+	@param random Random
+	@return T
 ]=]
-function WeightedRandomChooser:Remove(option)
-	self:SetWeight(option, nil)
+function WeightedRandomChooser:Choose(random)
+	local data = self:_getOrCreateDataCache()
+
+	local randomNum
+	if random then
+		randomNum = random:NextNumber()
+	else
+		randomNum = math.random()
+	end
+
+	local totalSum = 0
+
+	-- TODO: Binary search
+	for i=1, #data.options do
+		totalSum = totalSum + data.weights[i]
+
+		-- TODO: cache threshold?
+		local threshold = totalSum/data.total
+		if randomNum <= threshold then
+			return data.options[i]
+		end
+	end
+
+	warn("[WeightedRandomChooser.Choose] - Failed to reach threshold! Algorithm is wrong!")
+	return data.options[#data.options]
 end
 
---[=[
-	Picks a weighted choise
+function WeightedRandomChooser:_getOrCreateDataCache()
+	if self._cache then
+		return self._cache
+	end
 
-	@return T
-]=]
-function WeightedRandomChooser:Choose()
 	local options = Table.keys(self._optionToWeight)
 	local weights = {}
+
+	local total = 0
 	for index, key in pairs(options) do
-		weights[index] = self._optionToWeight[key]
+		local weight = self._optionToWeight[key]
+		total = total + weight
+		weights[index] = weight
 	end
 
-	return RandomUtils.weightedChoice(options, weights)
+	self._cache = {
+		options = options;
+		weights = weights;
+		total = total;
+	}
+	return self._cache
 end
 
 return WeightedRandomChooser