[v.69] SimpleSignal | Very Simple & Silly Fast Script Signal

[towerscripter1386 (Tower)]

Yea I can’t seem to find it, that’s the point

[athar_adv (athar_adventure)]

@athar_adv

Test it urself

-- Benchmark utility module

local function table_sum(t)
	local sum = 0
	
	for _, v in t do
		sum += v
	end
	
	return sum
end

local function table_maxv(t)
	local max = -math.huge
	
	for _, v in t do
		if v > max then
			max = v
		end
	end
	
	return max
end

local function table_minv(t)
	local min = math.huge
	
	for _, v in t do
		if v < min then
			min = v
		end
	end
	
	return min
end

local function table_mode(t)
	local counts = {}
	local maxCount = 0
	local modeValue = 0

	for _, value in t do
		counts[value] = (counts[value] or 0) + 1
		if counts[value] > maxCount then
			maxCount = counts[value]
			modeValue = value
		end
	end

	return modeValue -- Return only the first most popular mode
end

local function dround(n: number, r: number)
	local p = 10^r
	
	return math.floor(n * p) / p
end

-- Returns the time it took <code>testfn</code> to run after the initial call.
local function benchmark_start<A..., R...>(testfn: (A...) -> R..., ...: A...): (number, R...)
	local start = os.clock()
	
	local result = {testfn(...)}
	
	return os.clock() - start, unpack(result)
end

--[[
	Calls <code>testfn</code> <code>repeats</code> times and returns <code>avtype</code> elapsed time (truncated to <code>decimals</code> decimal places).
]]
local function benchmark_findavg(repeats: number, avtype: "mean"|"max"|"min"|"median"|"mode"|"total", decimals: number, benchInterval: number, testfn: () -> ()): (number, {number})
	local times = {}
	local total = 0
	
	for i = 1, repeats do
		local t = benchmark_start(testfn)
		total += t
		
		table.insert(times, t)
		if i % benchInterval == 0 then
			task.wait()
		end
	end
	
	table.sort(times)
	if avtype == "max" then
		return dround(table_maxv(times), decimals), times
	elseif avtype == "min" then
		return dround(table_minv(times), decimals), times
	elseif avtype == "median" then
		return dround(times[#times//2], decimals), times
	elseif avtype == "mean" then
		return dround(table_sum(times)/repeats, decimals), times
	elseif avtype == "mode" then
		return dround(table_mode(times), decimals), times
	elseif avtype == "total" then
		return dround(total, decimals), times
	else
		error(`Unknown avtype {avtype}`)
	end
end

local function stdDeviation(times, mean)
	local sum = 0
	for _, v in times do
		sum += (v - mean)^2
	end
	return math.sqrt(sum/#times)
end

local Benchmark = {
	findavg = benchmark_findavg,
	start = benchmark_start,
	stdDeviation = stdDeviation,
	
	--[[<docstring>
		hi
	]]
	cool_var = 10
}

return Benchmark

This here hjhjhjhjhjjh//30charlimit//

[bro_proxiomFun (Proxiom)]

My bad, probably, I used old version

[towerscripter1386 (Tower)]

I think with my own benchmark I actually found a really bad bug in your module:

--!optimize 2
--!strict

-- yield test
local BadSignal = require(script.BadSignal)
local SimpleSignal = require(script.SimpleSignal)

local loops = 100

local Signal1 = BadSignal:new(1) -- 1 is to tell to not allocate a lot of slots
local Signal2 = SimpleSignal.new()

local t = os.clock()
for i = 1,loops do
	Signal1:Push(true,function(b:any) -- true because we call task.wait()
		local a = i*b::number
		task.wait()
		print("Fired1") -- to detect if all functions ran
	end)
end
print("Bad signal connect: ",os.clock()-t)
t = os.clock()
for i = 1,loops do
	Signal2:Connect(function(b:any)
		local a = i*b::number
		task.wait()
		print("Fired2") -- to detect if all functions ran
	end)
end
print("Simple signal connect: ",os.clock()-t)

local t = os.clock()
for i = 1,10 do
	Signal1:Fire(2)
end
print("Bad signal fire: ",os.clock()-t)
local t = os.clock()
for i = 1,10 do
	Signal2:Fire(2)
end
print("Simple signal fire: ",os.clock()-t)

I know this is a crude benchmark, but the point is that Simple Signal refuses to run functions that were suspended. Out of 10 fire calls, it will run only once per connection. I guess fix it and it will be a lot more fair comparison

[AlexanderLindholt (Alexander)]

Can you elaborate on your bug report? I can’t seem to grasp what exactly the issue is.

@towerscripter1386

Simple Signal refuses to run functions that were suspended

Functions can’t be suspended, only coroutines, and there are no coroutines in the provided code.

[towerscripter1386 (Tower)]

In crude terms, out of 1000 intended prints, only 100 printed. If you run the code you can see that

[athar_adv (athar_adventure)]

Hi, unfortunately I can’t replicate the issue It’s most likely just the output overloading from the sheer amount of prints lol

[towerscripter1386 (Tower)]

Try this one:

--!optimize 2
--!strict

-- yield test
local BadSignal = require(script.BadSignal)
local SimpleSignal = require(script.SimpleSignal)

local loops = 1 

local Signal1 = BadSignal:new(1) -- 1 is to tell to not allocate a lot of slots
local Signal2 = SimpleSignal.new()

local t = os.clock()
for i = 1,loops do
	Signal1:Push(true,function(b:any) -- true because we call task.wait()
		local a = i*b::number
		task.wait()
		print("Fired1") -- to detect if all functions ran
	end)
end
print("Bad signal connect: ",os.clock()-t)
t = os.clock()
for i = 1,loops do
	Signal2:Connect(function(b:any)
		local a = i*b::number
		task.wait()
		print("Fired2") -- to detect if all functions ran
	end)
end
print("Simple signal connect: ",os.clock()-t)

local t = os.clock()
for i = 1,10 do
	Signal1:Fire(2)
end
print("Bad signal fire: ",os.clock()-t)
local t = os.clock()
for i = 1,10 do
	Signal2:Fire(2)
end
print("Simple signal fire: ",os.clock()-t)

there should be 10 Fired1 and 1 Fired2

[AlexanderLindholt (Alexander)]

He might be onto something.

I think it’s due to the fact that your method only has one thread for each connection, and if that connection callback is not done before firing again, when you resume the non-suspended thread, nothing happens (hence the error cannot resume non-suspended thread).

[athar_adv (athar_adventure)]

Ahh yeah, I do think this is unfortunately just a limit of using 1 thread per connection; however I do have an idea on how to fix it Gimme like a few minutes

[AlexanderLindholt (Alexander)]

Hm sure, but I think the best solution is just usual thread recycling, like what Signal+ used to have.

[athar_adv (athar_adventure)]

Package Version 63:

• Removed the method of 1-thread-per-connection in favor of a more robust thread recycling method which is able to achieve around the same fire times as the old method, without all the issues

• Added SimpleSignal.setCleaningInterval(n: number) to set the interval for cleaning up unused threads

• *Fixed n being subtracted in the deallocateThreads loop instead of i … this is what you get for abbreviating variables kids

Note that this update introduces alot of possibilities for things to go wrong, so if you encounter something report it to me asap

[EmberSquared]

How does this compare to other signals, FastSignal etc…

[athar_adv (athar_adventure)]

It is multiple times faster for :Fire() because it caches and reuses threads alot more, and around the same speed for :Connect() and :Disconnect(), with the only downside being that it needs its own dedicated loop to deallocate unused threads; which isn’t really a big problem :V

[EmberSquared]

I see, pretty smart
Most likely will give it a try in thbe future

[KinderDev (Kinder)]

I donated 80 Robux since I can clearly tell that you’ve put a LOT of work into this module from reading all the replies!

But I would love to ask, what does a Signal module even do? I’ve seen the term thrown around so much I feel like it’s lost all meaning, could you just break it down for me? Thanks!

[athar_adv (athar_adventure)]

Thanks for donating! All support not only goes into making SimpleSignal, but also all my other stuff like SImpleZone to SimpleComplete

A signal module is basically a fancy way to store a bunch of functions, and fire them all at once; running each one in its own thread so they can safely yield

It’s very, very similar to Roblox’s RBXScriptSignals like Part.Touched, just custom-made so you can use them for your own events.

[bro_proxiomFun (Proxiom)]

Change this

To something like this

because the license should belong to a person, not a module.

[AlexanderLindholt (Alexander)]

I noticed this too.

Another thing is that you can’t really modify the MIT license I believe. Although he hasn’t even done that, even though he says so, which is extremely weird?

[athar_adv (athar_adventure)]

@bro_proxiomFun

Change this

To something like this

because the license should belong to a person, not a module.

Ahh yes, I’ll fix it in 64

@AlexanderLindholt

I noticed this too.

Another thing is that you can’t really modify the MIT license I believe. Although he hasn’t even done that, even though he says so, which is extremely weird?

I did modify it, and it is legal (even though the precedence is kinda small)