initial commit of prefix-conversions (#2243)

* initial commit of prefix-conversions

* minor tweaks;

* Lose the blank lines

Co-authored-by: Christian Clauss <[email protected]>

Author: lance-pyles

Diff for: conversions/prefix_conversions.py

@@ -0,0 +1,100 @@
+"""
+Convert International System of Units (SI) and Binary prefixes
+"""
+from enum import Enum
+from typing import Union
+
+
+class SI_Unit(Enum):
+    yotta = 24
+    zetta = 21
+    exa = 18
+    peta = 15
+    tera = 12
+    giga = 9
+    mega = 6
+    kilo = 3
+    hecto = 2
+    deca = 1
+    deci = -1
+    centi = -2
+    milli = -3
+    micro = -6
+    nano = -9
+    pico = -12
+    femto = -15
+    atto = -18
+    zepto = -21
+    yocto = -24
+
+
+class Binary_Unit(Enum):
+    yotta = 8
+    zetta = 7
+    exa = 6
+    peta = 5
+    tera = 4
+    giga = 3
+    mega = 2
+    kilo = 1
+
+
+def convert_si_prefix(
+    known_amount: float,
+    known_prefix: Union[str, SI_Unit],
+    unknown_prefix: Union[str, SI_Unit],
+) -> float:
+    """
+    Wikipedia reference: https://en.wikipedia.org/wiki/Binary_prefix
+    Wikipedia reference: https://en.wikipedia.org/wiki/International_System_of_Units
+    >>> convert_si_prefix(1, SI_Unit.giga, SI_Unit.mega)
+    1000
+    >>> convert_si_prefix(1, SI_Unit.mega, SI_Unit.giga)
+    0.001
+    >>> convert_si_prefix(1, SI_Unit.kilo, SI_Unit.kilo)
+    1
+    >>> convert_si_prefix(1, 'giga', 'mega')
+    1000
+    >>> convert_si_prefix(1, 'gIGa', 'mEGa')
+    1000
+    """
+    if isinstance(known_prefix, str):
+        known_prefix: SI_Unit = SI_Unit[known_prefix.lower()]
+    if isinstance(unknown_prefix, str):
+        unknown_prefix: SI_Unit = SI_Unit[unknown_prefix.lower()]
+    unknown_amount = known_amount * (10 ** (known_prefix.value - unknown_prefix.value))
+    return unknown_amount
+
+
+def convert_binary_prefix(
+    known_amount: float,
+    known_prefix: Union[str, Binary_Unit],
+    unknown_prefix: Union[str, Binary_Unit],
+) -> float:
+    """
+    Wikipedia reference: https://en.wikipedia.org/wiki/Metric_prefix
+    >>> convert_binary_prefix(1, Binary_Unit.giga, Binary_Unit.mega)
+    1024
+    >>> convert_binary_prefix(1, Binary_Unit.mega, Binary_Unit.giga)
+    0.0009765625
+    >>> convert_binary_prefix(1, Binary_Unit.kilo, Binary_Unit.kilo)
+    1
+    >>> convert_binary_prefix(1, 'giga', 'mega')
+    1024
+    >>> convert_binary_prefix(1, 'gIGa', 'mEGa')
+    1024
+    """
+    if isinstance(known_prefix, str):
+        known_prefix: Binary_Unit = Binary_Unit[known_prefix.lower()]
+    if isinstance(unknown_prefix, str):
+        unknown_prefix: Binary_Unit = Binary_Unit[unknown_prefix.lower()]
+    unknown_amount = known_amount * (
+        2 ** ((known_prefix.value - unknown_prefix.value) * 10)
+    )
+    return unknown_amount
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()