Module:Utils - Revision history

FloraC: Fix for clamp. Improve documentation

2025-12-12T10:14:33Z

Fix for clamp. Improve documentation

← Older revision		Revision as of 10:14, 12 December 2025
Line 19:		Line 19:
	-- Clamp function		-- Clamp function
	-- Underscore-prefixed in case a wrapper for a template is ever needed		-- Underscore-prefixed in case a wrapper for a template is ever needed
	function p._clamp(~~val~~, ~~min_val~~, ~~max_val~~)		function p._clamp(value, min_value, max_value)
	return math.min(math.max(value, ~~min_val~~), ~~max_val~~)		return math.min(math.max(value, min_value), max_value)
	end		end

Line 72:		Line 72:
	end		end

	-- ~~Evaluate input~~ on error ~~use default~~; cannot be used with {{#invoke:}}		-- Parse a ratio string like "3/2" into a number
			-- Use default on error; cannot be used with {{#invoke:}}
	function p.eval_num_arg(input, def_value)		function p.eval_num_arg(input, def_value)
	local result = input		local result = input

2025-10-16T09:23:52Z

todo???

← Older revision		Revision as of 09:23, 16 October 2025
Line 3:		Line 3:
	local get_args = require("Module:Arguments").getArgs		local get_args = require("Module:Arguments").getArgs
	local yesno = require("Module:Yesno")		local yesno = require("Module:Yesno")

			-- TODO??? Enforce rule for prefixing module-callable functions with an
			-- underscore, regardless of whether a wrapper is needed or can be made????

	-- Trim a string (remove leading and trailing, but not interior, whitespace)		-- Trim a string (remove leading and trailing, but not interior, whitespace)

2025-10-16T09:08:44Z

add clamp function

← Older revision		Revision as of 09:08, 16 October 2025
Line 12:		Line 12:
	function p._yesno(frame)		function p._yesno(frame)
	return yesno(frame.args["input"], frame.args["default"])		return yesno(frame.args["input"], frame.args["default"])
			end

			-- Clamp function
			-- Underscore-prefixed in case a wrapper for a template is ever needed
			function p._clamp(val, min_val, max_val)
			return math.min(math.max(value, min_val), max_val)
	end		end

2025-10-05T06:53:21Z

minor renaming of args

← Older revision		Revision as of 06:53, 5 October 2025
Line 14:		Line 14:
	end		end

	-- Check if a table contains x		-- Check if a table contains the given value
	-- Accepts an optional comparison function that accepts two tables, returning		-- Accepts an optional comparison function that accepts two tables, returning
	-- true if x and tbl[i] have the same value.		-- true if value and tbl[i] have the same value.
	function p.table_contains(tbl, x, compare_func)		function p.table_contains(tbl, value, compare_func)
	if compare_func ~= nil then		if compare_func ~= nil then
	-- Use compare function		-- Use compare function
	for i = 1, #tbl do		for i = 1, #tbl do
	if compare_func(x, tbl[i]) then		if compare_func(value, tbl[i]) then
	return true		return true
	end		end
Line 28:		Line 28:
	-- No compare function		-- No compare function
	for i = 1, #tbl do		for i = 1, #tbl do
	if x == tbl[i] then		if value == tbl[i] then
	return true		return true
	end		end
Line 38:		Line 38:
	-- Return the first index with the given value (or nil if not found)		-- Return the first index with the given value (or nil if not found)
	-- Accepts an optional comparison function that accepts two tables, returning		-- Accepts an optional comparison function that accepts two tables, returning
	-- true if v ~~and value~~ have the same value.		-- true if value and v have the same value.
	function p.index_of(array, value, compare_func)		function p.index_of(array, value, compare_func)
	if compare_func ~= nil then		if compare_func ~= nil then

2025-10-05T06:43:32Z

allow functions table_contains and index_of to use optional comparison functions

← Older revision		Revision as of 06:43, 5 October 2025
Line 15:		Line 15:

	-- Check if a table contains x		-- Check if a table contains x
	function p.table_contains(tbl, x)		-- Accepts an optional comparison function that accepts two tables, returning
	for i = 1, #tbl do		-- true if x and tbl[i] have the same value.
	if x == tbl[i] then		function p.table_contains(tbl, x, compare_func)
	return true		if compare_func ~= nil then
			-- Use compare function
			for i = 1, #tbl do
			if compare_func(x, tbl[i]) then
			return true
			end
			end
			else
			-- No compare function
			for i = 1, #tbl do
			if x == tbl[i] then
			return true
			end
	end		end
	end		end
Line 25:		Line 37:

	-- Return the first index with the given value (or nil if not found)		-- Return the first index with the given value (or nil if not found)
	function p.index_of(array, value)		-- Accepts an optional comparison function that accepts two tables, returning
	for i, v in ipairs(array) do		-- true if v and value have the same value.
	if v == value then		function p.index_of(array, value, compare_func)
	return i		if compare_func ~= nil then
			-- Use compare function
			for i, v in ipairs(array) do
			if compare_func(v, value) then
			return i
			end
			end
			else
			-- No compare function
			for i, v in ipairs(array) do
			if v == value then
			return i
			end
	end		end
	end		end

2025-06-10T01:36:43Z

← Older revision		Revision as of 01:36, 10 June 2025
Line 11:		Line 11:
	-- Wrapper function for template access to [[Module:Yesno]]		-- Wrapper function for template access to [[Module:Yesno]]
	function p._yesno(frame)		function p._yesno(frame)
	return yesno(frame.args["input"])		return yesno(frame.args["input"], frame.args["default"])
	end		end

2025-05-30T01:41:44Z

← Older revision		Revision as of 01:41, 30 May 2025
Line 10:		Line 10:

	-- Wrapper function for template access to [[Module:Yesno]]		-- Wrapper function for template access to [[Module:Yesno]]
	function p.~~yesno~~(frame)		function p._yesno(frame)
	return yesno(frame.args["input"])		return yesno(frame.args["input"])
	end		end

2025-05-30T01:38:00Z

← Older revision		Revision as of 01:38, 30 May 2025
Line 9:		Line 9:
	end		end

	-- ~~Direct~~ access to ~~the "yesno" function~~		-- Wrapper function for template access to [[Module:Yesno]]
	function p.yesno(frame)		function p.yesno(frame)
	return yesno(frame.args["input"])		return yesno(frame.args["input"])

2025-05-30T00:47:23Z

← Older revision		Revision as of 00:47, 30 May 2025
Line 1:		Line 1:
			local p = {}

	local get_args = require("Module:Arguments").getArgs		local get_args = require("Module:Arguments").getArgs
	local p = {}		local yesno = require("Module:Yesno")

	-- Trim a string (remove leading and trailing, but not interior, whitespace)		-- Trim a string (remove leading and trailing, but not interior, whitespace)
	function p.trim(s)		function p.trim(s)
	return s:match("^%s(.-)%s$")		return s:match("^%s(.-)%s$")
			end

			-- Direct access to the "yesno" function
			function p.yesno(frame)
			return yesno(frame.args["input"])
	end		end

2025-05-19T17:01:35Z

Let's just use the template

← Older revision		Revision as of 17:01, 19 May 2025
Line 30:		Line 30:
	function p.value_provided(s)		function p.value_provided(s)
	return type(s) == "string" and #s > 0		return type(s) == "string" and #s > 0
	~~end~~

	~~-- Return a link to Wikipedia in Wiki markup~~
	~~function p.wlink(a, b)~~
	~~return string.format("[[wikipedia:%s\|%s]]", a, ((b == nil or p.trim(b) == "") and a or b))~~
	end		end