godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #91615 from Frozenfire92/remap-doc-nan-note 

Add docs note about remap returning undefined when istart == istop
This commit is contained in:
Rémi Verschelde 2024-05-08 09:54:20 +02:00
parent 63ed5749ac 26feefa91c
commit 4c30718102
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/@GlobalScope.xml
View File

@ -1097,6 +1097,7 @@
remap(75, 0, 100, -1, 1) # Returns 0.5 remap(75, 0, 100, -1, 1) # Returns 0.5
[/codeblock] [/codeblock]
For complex use cases where multiple ranges are needed, consider using [Curve] or [Gradient] instead. For complex use cases where multiple ranges are needed, consider using [Curve] or [Gradient] instead.
[b]Note:[/b] If [code]istart == istop[/code], the return value is undefined (most likely NaN, INF, or -INF).
</description> </description>
</method> </method>
<method name="rid_allocate_id"> <method name="rid_allocate_id">

3
tests/core/math/test_math_funcs.h
View File

@ -381,6 +381,9 @@ TEST_CASE_TEMPLATE("[Math] remap", T, float, double) {
CHECK(Math::remap((T)-100.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)0.0)); CHECK(Math::remap((T)-100.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)0.0));
CHECK(Math::remap((T)-200.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1000.0)); CHECK(Math::remap((T)-200.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1000.0));
CHECK(Math::remap((T)-250.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1500.0)); CHECK(Math::remap((T)-250.0, (T)-100.0, (T)-200.0, (T)0.0, (T)-1000.0) == doctest::Approx((T)-1500.0));
// Note: undefined behaviour can happen when `p_istart == p_istop`. We don't bother testing this as it will
// vary between hardware and compilers properly implementing IEEE 754.
} }
TEST_CASE_TEMPLATE("[Math] angle_difference", T, float, double) { TEST_CASE_TEMPLATE("[Math] angle_difference", T, float, double) {