Rename unconstrained_map_range to map_unconstrained_range

Author: lesamouraipourpre

adafruit_simplemath.py

@@ -35,7 +35,7 @@ def map_range(
     :attr:`out_min` is greater than :attr:`out_max`, the corresponding range
     is reversed, allowing, for example, mapping a range of 0-10 to 50-0.
 
-    See also :py:func:`unconstrained_map_range`
+    See also :py:func:`map_unconstrained_range`
 
     .. code-block::
 
@@ -55,11 +55,11 @@ def map_range(
     :rtype: float
     """
 
-    mapped = unconstrained_map_range(x, in_min, in_max, out_min, out_max)
+    mapped = map_unconstrained_range(x, in_min, in_max, out_min, out_max)
     return constrain(mapped, out_min, out_max)
 
 
-def unconstrained_map_range(
+def map_unconstrained_range(
     x: float, in_min: float, in_max: float, out_min: float, out_max: float
 ) -> float:
     """
@@ -74,10 +74,10 @@ def unconstrained_map_range(
 
     .. code-block::
 
-        from adafruit_simplemath import unconstrained_map_range
+        from adafruit_simplemath import map_unconstrained_range
 
         celsius = -20
-        fahrenheit = unconstrained_map_range(celsius, 0, 100, 32, 212)
+        fahrenheit = map_unconstrained_range(celsius, 0, 100, 32, 212)
         print(celsius, "degress Celsius =", fahrenheit, "degrees Fahrenheit")
 
     :param float x: Value to convert

examples/simplemath_simpletest.py

@@ -3,7 +3,7 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-from adafruit_simplemath import map_range, unconstrained_map_range, constrain
+from adafruit_simplemath import map_range, map_unconstrained_range, constrain
 
 print("map_range() examples")
 # Map, say, a sensor value, from a range of 0-255 to 0-1023.
@@ -21,13 +21,13 @@
 x = map_range(percent, 0, 100, 0, screen_width - 1)
 print("X position", percent, "% from the left of screen is", x)
 
-print("\nunconstrained_map_range() examples")
+print("\nmap_unconstrained_range() examples")
 celsius = 20
-fahrenheit = unconstrained_map_range(celsius, 0, 100, 32, 212)
+fahrenheit = map_unconstrained_range(celsius, 0, 100, 32, 212)
 print(celsius, "degress Celsius =", fahrenheit, "degrees Fahrenheit")
 
 celsius = -20
-fahrenheit = unconstrained_map_range(celsius, 0, 100, 32, 212)
+fahrenheit = map_unconstrained_range(celsius, 0, 100, 32, 212)
 print(celsius, "degress Celsius =", fahrenheit, "degrees Fahrenheit")
 
 print("\nconstrain() examples")

tests/map_unconstrained_range_test.py

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2021 James Carr
+#
+# SPDX-License-Identifier: Unlicense
+
+from adafruit_simplemath import map_unconstrained_range
+
+
+def test_map_unconstrained_range():
+    assert map_unconstrained_range(-40, 32, 212, 0, 100) == -40.0
+    assert map_unconstrained_range(50, 32, 212, 0, 100) == 10.0
+    assert map_unconstrained_range(392, 32, 212, 0, 100) == 200.0