dfhack/plugins/lua/cxxrandom.lua

215 lines
6.8 KiB
Lua

Merge branch cxxrandom Implements helper functions for random number generation. Implemented using C++11 <random> library. Exported Lua Functions: - seedRNG(seed) - rollInt(min, max) - rollDouble(min, max) - rollNormal(mean, std_deviation) - rollBool(chance_for_true) - resetIndexRolls(string, array_length) --String identifies the instance of SimpleNumDistribution to reset - rollIndex(string, array_length) --String identifies the instance of SimpleNumDistribution to use --(Shuffles a vector of indices, Next() increments through then reshuffles when end() is reached) On branch cxxrandom-rel Changes to be committed: modified: plugins/CMakeLists.txt new file: plugins/cxxrandom.cpp new file: plugins/lua/cxxrandom.lua ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Squashed commit of the following: commit 3a7ef70d45f3e0c2fe367141dd0349dddaaff60d Merge: fd9f1982 7aa0608c Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Fri Dec 22 22:17:27 2017 -0800 Merge remote-tracking branch 'origin/temp' into cxxrandom commit 7aa0608cb85dcf82686193db7a6e9d1318f5f2a5 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Thu Dec 21 21:43:35 2017 -0800 Revises cxxrandom plugin New functions: - seedRNG(ushort seed) --lua exported - GetDistribContainer() --internal singleton - RNG() --internal singleton Summary: - Removed class CXXRNG --Refactored functions that used CXXRNG Changes to be committed: modified: plugins/cxxrandom.cpp commit b42979818a01c1121eace7b1ac14676f5ad5d8b2 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Wed Dec 20 13:21:49 2017 -0800 Fixes plugin_init() Misread the lines indicated by lethosor to be excluded, had broken the plugin in the process. Changes to be committed: modified: plugins/cxxrandom.cpp commit 753a00a14d9e6519d299638e014abf30509940af Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Wed Dec 20 12:36:17 2017 -0800 Cleans up cxxrandom.cpp DFHack contributions specifies: -spaces instead of tabs, so tabs were converted. -C++ headers before dfhack stuff, so it was done *Also added author name, creation date, and last updated date. Changes to be committed: modified: plugins/cxxrandom.cpp commit 498ebe4b8fdccc01ac1f169269f3093c830a8a10 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Tue Dec 19 22:51:58 2017 -0800 Updates cxxrandom, fixes instance leak deleted header moved definition to cpp file #lethosor fixed singleton instance, no longer a pointer commented out dfhack commands, now only init/shutdown and exported lua functions modified: cxxrandom.cpp deleted: cxxrandom.h commit 821044bef2a0201d0d74192e445c7b29766b42a1 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Sun Dec 17 04:01:11 2017 -0800 Fixes RollIndex and Renames RollNormal Renamed the Normal Distribution RNG function to fit the standard. Now named RollNormal(m,s) Fixed some wonky white space in the lua macro export block. Fixed a stupid mistake with the RollIndex output. (it was outputting 0's) Updated usage details. Changes to be committed: modified: plugins/cxxrandom.cpp commit 1536f43d137b6bc55d55759b43bdccf6ff429b33 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Fri Dec 15 08:50:08 2017 -0800 Fixes/Improves cxxrandom Modified return types Corrected index distribution code commit 8629c7e1509522cb0cc4b649914b90d033cb4763 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Thu Dec 14 19:02:29 2017 -0800 Implements SimpleNumDistribution Exported additional functions to lua. Functions allow the generation of random 0-N index values. Generation promises all unique values [0,N] will be returned once each when generation is run N times. On branch cxxrandom Changes to be committed: modified: plugins/cxxrandom.cpp modified: plugins/cxxrandom.h commit f035f3d20415790542cf83e5e696261661d911f3 Author: Josh Cooper <cooper.s.josh@gmail.com> Date: Wed Dec 13 23:55:39 2017 -0800 Implements cxxrandom cxxrandom was implemented using a singleton. This singleton provides an interface for generating uniform numbers, or numbers in a normal distribution, and also booleans(given the probability for the true outcome) The singleton interface is wrapped in functions which are exposed for lua usage. Integrated into plugins/CMakeLists.txt On branch dev Changes to be committed: modified: CMakeLists.txt new file: cxxrandom.cpp new file: cxxrandom.h new file: lua/cxxrandom.lua
2017-12-22 23:41:45 -07:00
local _ENV = mkmodule('plugins.cxxrandom')
[Release] cxxrandom v2.0 Major Revision update v2.0 =-=-=-=-= Native functions(exported to lua): -GenerateEngine: returns engine id (args: seed) -DestroyEngine: destroys corresponding engine (args: rngID) -NewSeed re-seeds engine (args: rngID, seed) -rollInt generates random integer (args: rngID, min, max) -rollDouble generates random double (args: rngID, min, max) -rollNormal generates random normal[gaus.] (args: rngID, avg, stddev) -rollBool generates random boolean (args: rngID, chance) -MakeNumSequence returns sequence id (args: start, end) -AddToSequence adds a number to the sequence (args: seqID, num) -ShuffleSequence shuffles the number sequence (args: rngID, seqID) -NextInSequence returns the next number in seq.(args: seqID) Lua plugin functions: -MakeNewEngine returns engine id (args: seed) Lua plugin classes: -crng methods: -init(id, df, dist) :: constructor id - Reference ID of engine to use in RNGenerations df (optional) - bool indicating whether to destroy the Engine when the crng object is garbage collected dist (optional) - lua number distribution to use -__gc() :: destructor -changeSeed(seed) :: alters engine's seed value -setNumDistrib(distrib) :: set's the number distribution crng object should use distrib - number distribution object to use in RNGenerations -next() :: returns the next number in the distribution -shuffle() :: effectively shuffles the number distribution -normal_distribution methods: -init(avg, stddev) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -real_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -int_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -bool_distribution methods: -init(min, max) :: constructor -next(id) :: returns next boolean in the distribution id - engine ID to pass to native function -num_sequence methods: -init(a, b) :: constructor -add(num) :: adds num to the end of the number sequence -shuffle() :: shuffles the sequence of numbers -next() :: returns next number in the sequence Adds missing function exports. Fixes numerous problems I won't go into
2018-04-29 17:23:57 -06:00
function MakeNewEngine(seed)
if type(seed) == 'number' then
if seed == 0 then
print(":WARNING: Seeds equal to 0 are used if no seed is provided. This indicates to cxxrandom.plug.dll that the engine needs to be seeded with the current time.\nRecommendation: use a non-zero value for your seed, or don't provide a seed to use the time since epoch(1969~).")
end
return GenerateEngine(seed)
elseif type(seed) == 'nil' then
return GenerateEngine(0)
else
error("Argument `seed` must be a number, or nil.")
end
end
--Class: crng
-------------
crng = {}
function crng:new(engineID, destroyEngineOnDestruction, distrib)
local o = {}
self.__index = self
local idtype = type(engineID)
local flagtype = type(destroyEngineOnDestruction)
2022-04-12 12:48:19 -06:00
[Release] cxxrandom v2.0 Major Revision update v2.0 =-=-=-=-= Native functions(exported to lua): -GenerateEngine: returns engine id (args: seed) -DestroyEngine: destroys corresponding engine (args: rngID) -NewSeed re-seeds engine (args: rngID, seed) -rollInt generates random integer (args: rngID, min, max) -rollDouble generates random double (args: rngID, min, max) -rollNormal generates random normal[gaus.] (args: rngID, avg, stddev) -rollBool generates random boolean (args: rngID, chance) -MakeNumSequence returns sequence id (args: start, end) -AddToSequence adds a number to the sequence (args: seqID, num) -ShuffleSequence shuffles the number sequence (args: rngID, seqID) -NextInSequence returns the next number in seq.(args: seqID) Lua plugin functions: -MakeNewEngine returns engine id (args: seed) Lua plugin classes: -crng methods: -init(id, df, dist) :: constructor id - Reference ID of engine to use in RNGenerations df (optional) - bool indicating whether to destroy the Engine when the crng object is garbage collected dist (optional) - lua number distribution to use -__gc() :: destructor -changeSeed(seed) :: alters engine's seed value -setNumDistrib(distrib) :: set's the number distribution crng object should use distrib - number distribution object to use in RNGenerations -next() :: returns the next number in the distribution -shuffle() :: effectively shuffles the number distribution -normal_distribution methods: -init(avg, stddev) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -real_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -int_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -bool_distribution methods: -init(min, max) :: constructor -next(id) :: returns next boolean in the distribution id - engine ID to pass to native function -num_sequence methods: -init(a, b) :: constructor -add(num) :: adds num to the end of the number sequence -shuffle() :: shuffles the sequence of numbers -next() :: returns next number in the sequence Adds missing function exports. Fixes numerous problems I won't go into
2018-04-29 17:23:57 -06:00
if idtype == 'number' then
o.rngID = engineID
elseif idtype == 'nil' then
o.rngID = GenerateEngine(0)
else
error("Invalid argument type (engineID): " .. tostring(engineID))
end
if flagtype ~= 'nil' and flagtype == 'boolean' then
o.destroyid = destroyEngineOnDestruction
elseif flagtype == 'nil' then
o.destroyid = true
else
error("Invalid arugment type (destroyEngineOnDestruction): " .. tostring(destroyEngineOnDestruction))
end
if type(distrib) ~= 'nil' then
if type(distrib) == 'table' and type(distrib.next) == 'function' then
o.distrib = distrib
o.distrib.rngID = o.rngID
else
error("Invalid distribution used as an argument. Cannot set this as the number distribution.")
end
end
setmetatable(o,self)
return o
end
--crng destructor - we may need to destroy the engine, the user may be doing it manually though
function crng:__gc()
if self.destroyid then
DestroyEngine(self.rngID)
end
end
function crng:changeSeed(seed)
if type(seed) == 'number' then
if seed == 0 then
print(":WARNING: Seeds equal to 0 are used if no seed is provided. This indicates to cxxrandom.plug.dll that the engine needs to be seeded with the current time.\nRecommendation: use a non-zero value for your seed, or don't provide a seed to use the time since epoch(1969~).")
end
return NewSeed(self.rngID, seed)
elseif type(seed) == 'nil' then
return NewSeed(self.rngID, 0)
else
error("Argument `seed` must be a number, or nil.")
end
end
function crng:setNumDistrib(distrib)
if type(distrib) == 'table' and type(distrib.next) == 'function' then
self.distrib = distrib
self.distrib.rngID = self.rngID
else
error("Invalid distribution used as an argument. Cannot set this as the number distribution.")
end
end
function crng:next()
if type(self.distrib) == 'table' and type(self.distrib.next) == 'function' then
return self.distrib:next(self.rngID)
else
error("crng object does not have a valid number distribution set")
end
end
function crng:shuffle()
if type(self.distrib) == 'table' and type(self.distrib.shuffle) == 'function' then
self.distrib:shuffle(self.rngID)
else
print(":WARNING: No self.distrib.shuffle not found.")
changeSeed(0)
end
end
--Class: normal_distribution
----------------------------
normal_distribution = {}
function normal_distribution:new(avg, stddev)
local o = {}
self.__index = self
if type(avg) ~= 'number' or type(stddev) ~= 'number' then
error("Invalid arguments in normal_distribution construction. Average and standard deviation must be numbers.")
end
o.average = avg
o.std_deviation = stddev
setmetatable(o,self)
return o
end
function normal_distribution:next(id)
return rollNormal(id, self.average, self.std_deviation)
end
--Class: real_distribution
----------------------------
real_distribution = {}
function real_distribution:new(min, max)
local o = {}
self.__index = self
if type(min) ~= 'number' or type(max) ~= 'number' then
error("Invalid arguments in real_distribution construction. min and max must be numbers.")
end
o.min = min
o.max = max
setmetatable(o,self)
return o
end
function real_distribution:next(id)
return rollDouble(id, self.min, self.max)
end
--Class: int_distribution
----------------------------
int_distribution = {}
function int_distribution:new(min, max)
local o = {}
self.__index = self
if type(min) ~= 'number' or type(max) ~= 'number' then
error("Invalid arguments in int_distribution construction. min and max must be numbers.")
end
o.min = min
o.max = max
setmetatable(o,self)
return o
end
function int_distribution:next(id)
return rollInt(id, self.min, self.max)
end
--Class: bool_distribution
----------------------------
bool_distribution = {}
function bool_distribution:new(chance)
local o = {}
self.__index = self
if type(min) ~= 'number' or type(max) ~= 'number' then
error("Invalid arguments in bool_distribution construction. min and max must be numbers.")
end
o.p = chance
setmetatable(o,self)
return o
end
function bool_distribution:next(id)
return rollBool(id, self.p)
end
--Class: num_sequence
----------------------------
num_sequence = {}
function num_sequence:new(a,b)
local o = {}
self.__index = self
local btype = type(b)
local atype = type(a)
if atype == 'number' and btype == 'number' then
if a == b then
print(":WARNING: You've provided two equal arguments to initialize your sequence with. This is the mechanism used to indicate to cxxrandom.plug.dll that an empty sequence is desired.\nRecommendation: provide no arguments if you wish for an empty sequence.")
end
o.seqID = MakeNumSequence(a, b)
elseif atype == 'table' then
o.seqID = MakeNumSequence(0,0)
for _,v in pairs(a) do
if type(v) ~= 'number' then
error("num_sequence can only be initialized using numbers. " .. tostring(v) .. " is not a number.")
end
AddToSequence(o.seqID, v)
end
elseif atype == "nil" and btype == "nil" then
o.seqID = MakeNumSequence(0,0)
else
error("Invalid arguments - a: " .. tostring(a) .. " and b: " .. tostring(b))
end
2019-04-15 17:21:54 -06:00
--print("seqID:"..o.seqID)
[Release] cxxrandom v2.0 Major Revision update v2.0 =-=-=-=-= Native functions(exported to lua): -GenerateEngine: returns engine id (args: seed) -DestroyEngine: destroys corresponding engine (args: rngID) -NewSeed re-seeds engine (args: rngID, seed) -rollInt generates random integer (args: rngID, min, max) -rollDouble generates random double (args: rngID, min, max) -rollNormal generates random normal[gaus.] (args: rngID, avg, stddev) -rollBool generates random boolean (args: rngID, chance) -MakeNumSequence returns sequence id (args: start, end) -AddToSequence adds a number to the sequence (args: seqID, num) -ShuffleSequence shuffles the number sequence (args: rngID, seqID) -NextInSequence returns the next number in seq.(args: seqID) Lua plugin functions: -MakeNewEngine returns engine id (args: seed) Lua plugin classes: -crng methods: -init(id, df, dist) :: constructor id - Reference ID of engine to use in RNGenerations df (optional) - bool indicating whether to destroy the Engine when the crng object is garbage collected dist (optional) - lua number distribution to use -__gc() :: destructor -changeSeed(seed) :: alters engine's seed value -setNumDistrib(distrib) :: set's the number distribution crng object should use distrib - number distribution object to use in RNGenerations -next() :: returns the next number in the distribution -shuffle() :: effectively shuffles the number distribution -normal_distribution methods: -init(avg, stddev) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -real_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -int_distribution methods: -init(min, max) :: constructor -next(id) :: returns next number in the distribution id - engine ID to pass to native function -bool_distribution methods: -init(min, max) :: constructor -next(id) :: returns next boolean in the distribution id - engine ID to pass to native function -num_sequence methods: -init(a, b) :: constructor -add(num) :: adds num to the end of the number sequence -shuffle() :: shuffles the sequence of numbers -next() :: returns next number in the sequence Adds missing function exports. Fixes numerous problems I won't go into
2018-04-29 17:23:57 -06:00
setmetatable(o,self)
return o
end
function num_sequence:__gc()
DestroyNumSequence(self.seqID)
end
function num_sequence:add(x)
if type(x) ~= 'number' then
error("Cannot add non-number to num_sequence.")
end
AddToSequence(self.seqID, x)
end
function num_sequence:next()
return NextInSequence(self.seqID)
end
function num_sequence:shuffle()
if self.rngID == 'nil' then
error("Add num_sequence object to crng as distribution, before attempting to shuffle.")
end
ShuffleSequence(self.rngID, self.seqID)
end
2022-04-12 12:48:19 -06:00
return _ENV