@quenty/randomutils 2.3.0 → 3.0.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@2.3.0...@quenty/randomutils@3.0.0) (2023-10-11)
+
+
+### Features
+
+* Add GetProbability ([2267080](https://github.com/Quenty/NevermoreEngine/commit/2267080fc6c1c53153f15cd9f638bddbff2371b7))
+* Add WeightedRandomChooser ([b0cdcd1](https://github.com/Quenty/NevermoreEngine/commit/b0cdcd1ab69104535683609469cd806e647ef000))
+
+
+
+
+
 # [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@2.2.0...@quenty/randomutils@2.3.0) (2023-08-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/randomutils",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "Quenty's RandomUtils, utility functions for Roblox",
   "keywords": [
     "Roblox",
@@ -29,7 +29,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/loader": "^6.3.0"
+    "@quenty/loader": "^7.0.0",
+    "@quenty/table": "^3.3.0"
   },
-  "gitHead": "2547e660a0333034a5b20ddd6b23e343bc01f7c6"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/WeightedRandomChooser.lua

@@ -0,0 +1,96 @@
+--[=[
+	@class WeightedRandomChooser
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RandomUtils = require("RandomUtils")
+local Table = require("Table")
+
+local WeightedRandomChooser = {}
+WeightedRandomChooser.ClassName = "WeightedRandomChooser"
+WeightedRandomChooser.__index = WeightedRandomChooser
+
+--[=[
+	Creates a new weighted random chooser
+
+	@return WeightedRandomChooser<T>
+]=]
+function WeightedRandomChooser.new()
+	local self = setmetatable({}, WeightedRandomChooser)
+
+	self._optionToWeight = {}
+
+	return self
+end
+
+--[=[
+	Sets the weight for a given option. Setting the weight to nil
+	removes the option.
+
+	@param option T
+	@param weight number | nil
+]=]
+function WeightedRandomChooser:SetWeight(option, weight)
+	assert(option ~= nil, "Bad option")
+	assert(type(weight) == "number" or weight == nil, "Bad weight")
+
+	self._optionToWeight[option] = weight
+end
+
+--[=[
+	Gets the weight for the option
+
+	@param option T
+	@return number | nil
+]=]
+function WeightedRandomChooser:GetWeight(option)
+	return self._optionToWeight[option]
+end
+
+--[=[
+	Gets the percent probability from 0 to 1
+
+	@param option T
+	@return number | nil
+]=]
+function WeightedRandomChooser:GetProbability(option)
+	local weight = self._optionToWeight[option]
+	if weight then
+		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
+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
+
+--[=[
+	Picks a weighted choise
+
+	@return T
+]=]
+function WeightedRandomChooser:Choose()
+	local options = Table.keys(self._optionToWeight)
+	local weights = {}
+	for index, key in pairs(options) do
+		weights[index] = self._optionToWeight[key]
+	end
+
+	return RandomUtils.weightedChoice(options, weights)
+end
+
+return WeightedRandomChooser