excessive / cpml / 1

Committed 21 Apr 2022 05:46PM UTC coverage: 54.321% (+0.7%) from 53.574%

Build # 1

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #76 from xiejiangzhi/xjz

Add Vec3.angle_to

Run Details

23 of 23 new or added lines in 2 files covered. (100.0%)

130 existing lines in 7 files now uncovered.

5424 of 9985 relevant lines covered (54.32%)

290.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

40.74

/modules/utils.lua

--- Various utility functions
-- @module utils

local modules = (...): gsub('%.[^%.]+$', '') .. "."
local vec2    = require(modules .. "vec2")
local vec3    = require(modules .. "vec3")
local private = require(modules .. "_private_utils")
local abs     = math.abs
local ceil    = math.ceil
local floor   = math.floor
local log     = math.log
local utils   = {}

-- reimplementation of math.frexp, due to its removal from Lua 5.3 :(
-- courtesy of airstruck
local log2 = log(2)

local frexp = math.frexp or function(x)
        if x == 0 then return 0, 0 end
        local e = floor(log(abs(x)) / log2 + 1)
        return x / 2 ^ e, e
end

--- Clamps a value within the specified range.
-- @param value Input value
-- @param min Minimum output value
-- @param max Maximum output value
-- @return number
function utils.clamp(value, min, max)
        return math.max(math.min(value, max), min)
end

--- Returns `value` if it is equal or greater than |`size`|, or 0.
-- @param value
-- @param size
-- @return number
function utils.deadzone(value, size)
        return abs(value) >= size and value or 0
end

--- Check if value is equal or greater than threshold.
-- @param value
-- @param threshold
-- @return boolean
function utils.threshold(value, threshold)
        -- I know, it barely saves any typing at all.
        return abs(value) >= threshold
end

--- Check if value is equal or less than threshold.
-- @param value
-- @param threshold
-- @return boolean
function utils.tolerance(value, threshold)
        -- I know, it barely saves any typing at all.
        return abs(value) <= threshold
end

--- Scales a value from one range to another.
-- @param value Input value
-- @param min_in Minimum input value
-- @param max_in Maximum input value
-- @param min_out Minimum output value
-- @param max_out Maximum output value
-- @return number
function utils.map(value, min_in, max_in, min_out, max_out)
        return ((value) - (min_in)) * ((max_out) - (min_out)) / ((max_in) - (min_in)) + (min_out)
end

--- Linear interpolation.
-- Performs linear interpolation between 0 and 1 when `low` < `progress` < `high`.
-- @param low value to return when `progress` is 0
-- @param high value to return when `progress` is 1
-- @param progress (0-1)
-- @return number
function utils.lerp(low, high, progress)
        return low * (1 - progress) + high * progress
end

--- Exponential decay
-- @param low initial value
-- @param high target value
-- @param rate portion of the original value remaining per second
-- @param dt time delta
-- @return number
function utils.decay(low, high, rate, dt)
        return utils.lerp(low, high, 1.0 - math.exp(-rate * dt))
end

--- Hermite interpolation.
-- Performs smooth Hermite interpolation between 0 and 1 when `low` < `progress` < `high`.
-- @param progress (0-1)
-- @param low value to return when `progress` is 0
-- @param high value to return when `progress` is 1
-- @return number
function utils.smoothstep(progress, low, high)
        local t = utils.clamp((progress - low) / (high - low), 0.0, 1.0)
        return t * t * (3.0 - 2.0 * t)
end

--- Round number at a given precision.
-- Truncates `value` at `precision` points after the decimal (whole number if
-- left unspecified).
-- @param value
-- @param precision
-- @return number
utils.round = private.round

--- Wrap `value` around if it exceeds `limit`.
-- @param value
-- @param limit
-- @return number
function utils.wrap(value, limit)
        if value < 0 then
                value = value + utils.round(((-value/limit)+1))*limit
        end
        return value % limit
end

--- Check if a value is a power-of-two.
-- Returns true if a number is a valid power-of-two, otherwise false.
-- @author undef
-- @param value
-- @return boolean
function utils.is_pot(value)
        -- found here: https://love2d.org/forums/viewtopic.php?p=182219#p182219
        -- check if a number is a power-of-two
        return (frexp(value)) == 0.5
end

--- Check if a value is NaN
-- Returns true if a number is not a valid number
-- @param value
-- @return boolean
utils.is_nan = private.is_nan

-- Originally from vec3
function utils.project_on(a, b)
        local s =
                (a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0) /
                (b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0)

        if a.z and b.z then
                return vec3(
                        b.x * s,
                        b.y * s,
                        b.z * s
                )
        end

        return vec2(
                b.x * s,
                b.y * s
        )
end

-- Originally from vec3
function utils.project_from(a, b)
        local s =
                (b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0) /
                (a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0)

        if a.z and b.z then
                return vec3(
                        b.x * s,
                        b.y * s,
                        b.z * s
                )
        end

        return vec2(
                b.x * s,
                b.y * s
        )
end

-- Originally from vec3
function utils.mirror_on(a, b)
        local s =
                (a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0) /
                (b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0) * 2

        if a.z and b.z then
                return vec3(
                        b.x * s - a.x,
                        b.y * s - a.y,
                        b.z * s - a.z
                )
        end

        return vec2(
                b.x * s - a.x,
                b.y * s - a.y
        )
end

-- Originally from vec3
function utils.reflect(i, n)
        return i - (n * (2 * n:dot(i)))
end

-- Originally from vec3
function utils.refract(i, n, ior)
        local d = n:dot(i)
        local k = 1 - ior * ior * (1 - d * d)

        if k >= 0 then
                return (i * ior) - (n * (ior * d + k ^ 0.5))
        end

        return vec3()
end

return utils

1	--- Various utility functions
2	-- @module utils
3
4	local modules = (...): gsub('%.[^%.]+$', '') .. "."	42✔
5	local vec2 = require(modules .. "vec2")	42✔
6	local vec3 = require(modules .. "vec3")	42✔
7	local private = require(modules .. "_private_utils")	42✔
8	local abs = math.abs	42✔
9	local ceil = math.ceil	42✔
10	local floor = math.floor	42✔
11	local log = math.log	42✔
12	local utils = {}	42✔
13
14	-- reimplementation of math.frexp, due to its removal from Lua 5.3 :(
15	-- courtesy of airstruck
16	local log2 = log(2)	42✔
17
18	local frexp = math.frexp or function(x)	42✔
19	if x == 0 then return 0, 0 end	×
20	local e = floor(log(abs(x)) / log2 + 1)	×
21	return x / 2 ^ e, e	×
22	end
23
24	--- Clamps a value within the specified range.
25	-- @param value Input value
26	-- @param min Minimum output value
27	-- @param max Maximum output value
28	-- @return number
29	function utils.clamp(value, min, max)	42✔
30	return math.max(math.min(value, max), min)	98✔
31	end
32
33	--- Returns `value` if it is equal or greater than \|`size`\|, or 0.
34	-- @param value
35	-- @param size
36	-- @return number
37	function utils.deadzone(value, size)	42✔
38	return abs(value) >= size and value or 0	×
39	end
40
41	--- Check if value is equal or greater than threshold.
42	-- @param value
43	-- @param threshold
44	-- @return boolean
45	function utils.threshold(value, threshold)	42✔
46	-- I know, it barely saves any typing at all.
47	return abs(value) >= threshold	×
48	end
49
50	--- Check if value is equal or less than threshold.
51	-- @param value
52	-- @param threshold
53	-- @return boolean
54	function utils.tolerance(value, threshold)	42✔
55	-- I know, it barely saves any typing at all.
56	return abs(value) <= threshold	896✔
57	end
58
59	--- Scales a value from one range to another.
60	-- @param value Input value
61	-- @param min_in Minimum input value
62	-- @param max_in Maximum input value
63	-- @param min_out Minimum output value
64	-- @param max_out Maximum output value
65	-- @return number
66	function utils.map(value, min_in, max_in, min_out, max_out)	42✔
67	return ((value) - (min_in)) * ((max_out) - (min_out)) / ((max_in) - (min_in)) + (min_out)	×
68	end
69
70	--- Linear interpolation.
71	-- Performs linear interpolation between 0 and 1 when `low` < `progress` < `high`.
72	-- @param low value to return when `progress` is 0
73	-- @param high value to return when `progress` is 1
74	-- @param progress (0-1)
75	-- @return number
76	function utils.lerp(low, high, progress)	42✔
77	return low * (1 - progress) + high * progress	28✔
78	end
79
80	--- Exponential decay
81	-- @param low initial value
82	-- @param high target value
83	-- @param rate portion of the original value remaining per second
84	-- @param dt time delta
85	-- @return number
86	function utils.decay(low, high, rate, dt)	42✔
87	return utils.lerp(low, high, 1.0 - math.exp(-rate * dt))	7✔
88	end
89
90	--- Hermite interpolation.
91	-- Performs smooth Hermite interpolation between 0 and 1 when `low` < `progress` < `high`.
92	-- @param progress (0-1)
93	-- @param low value to return when `progress` is 0
94	-- @param high value to return when `progress` is 1
95	-- @return number
96	function utils.smoothstep(progress, low, high)	42✔
97	local t = utils.clamp((progress - low) / (high - low), 0.0, 1.0)	×
98	return t * t * (3.0 - 2.0 * t)	×
99	end
100
101	--- Round number at a given precision.
102	-- Truncates `value` at `precision` points after the decimal (whole number if
103	-- left unspecified).
104	-- @param value
105	-- @param precision
106	-- @return number
107	utils.round = private.round	42✔
108
109	--- Wrap `value` around if it exceeds `limit`.
110	-- @param value
111	-- @param limit
112	-- @return number
113	function utils.wrap(value, limit)	42✔
114	if value < 0 then	×
115	value = value + utils.round(((-value/limit)+1))*limit	×
116	end
117	return value % limit	×
118	end
119
120	--- Check if a value is a power-of-two.
121	-- Returns true if a number is a valid power-of-two, otherwise false.
122	-- @author undef
123	-- @param value
124	-- @return boolean
125	function utils.is_pot(value)	42✔
126	-- found here: https://love2d.org/forums/viewtopic.php?p=182219#p182219
127	-- check if a number is a power-of-two
128	return (frexp(value)) == 0.5	×
129	end
130
131	--- Check if a value is NaN
132	-- Returns true if a number is not a valid number
133	-- @param value
134	-- @return boolean
135	utils.is_nan = private.is_nan	42✔
136
137	-- Originally from vec3
138	function utils.project_on(a, b)	42✔
139	local s =
140	(a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0) /	×
141	(b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0)	×
142
UNCOV 143	if a.z and b.z then	×
UNCOV 144	return vec3(	×
145	b.x * s,	×
146	b.y * s,	×
147	b.z * s	×
148	)
149	end
150
UNCOV 151	return vec2(	×
UNCOV 152	b.x * s,	×
UNCOV 153	b.y * s	×
154	)
155	end
156
157	-- Originally from vec3
158	function utils.project_from(a, b)	42✔
159	local s =
160	(b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0) /	×
161	(a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0)	×
162
UNCOV 163	if a.z and b.z then	×
UNCOV 164	return vec3(	×
165	b.x * s,	×
166	b.y * s,	×
167	b.z * s	×
168	)
169	end
170
UNCOV 171	return vec2(	×
UNCOV 172	b.x * s,	×
UNCOV 173	b.y * s	×
174	)
175	end
176
177	-- Originally from vec3
178	function utils.mirror_on(a, b)	42✔
179	local s =
180	(a.x * b.x + a.y * b.y + a.z or 0 * b.z or 0) /	×
181	(b.x * b.x + b.y * b.y + b.z or 0 * b.z or 0) * 2	×
182
UNCOV 183	if a.z and b.z then	×
UNCOV 184	return vec3(	×
185	b.x * s - a.x,	×
186	b.y * s - a.y,	×
187	b.z * s - a.z	×
188	)
189	end
190
UNCOV 191	return vec2(	×
UNCOV 192	b.x * s - a.x,	×
193	b.y * s - a.y	×
194	)
195	end
196
197	-- Originally from vec3
198	function utils.reflect(i, n)	42✔
199	return i - (n * (2 * n:dot(i)))	×
200	end
201
202	-- Originally from vec3
203	function utils.refract(i, n, ior)	42✔
UNCOV 204	local d = n:dot(i)	×
205	local k = 1 - ior * ior * (1 - d * d)	×
206
UNCOV 207	if k >= 0 then	×
UNCOV 208	return (i * ior) - (n * (ior * d + k ^ 0.5))	×
209	end
210
UNCOV 211	return vec3()	×
212	end
213
214	return utils	42✔

excessive / cpml / 1

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous