Support ARABIC and ROMAN

aidhound · Jan 14, 2021 · 12d9824 · 12d9824
1 parent afc761e
commit 12d9824
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 4 deletions.
diff --git a/SUPPORTED_FORMULAS.md b/SUPPORTED_FORMULAS.md
@@ -1,11 +1,12 @@
-# Supported Formulas - 123
+# Supported Formulas - 125
 
 * ABS
 * ACOS
 * ACOSH
 * ACOT
 * ACOTH
 * AND
+* ARABIC
 * ASIN
 * ASINH
 * ATAN
@@ -93,6 +94,7 @@
 * PV
 * QUOTIENT
 * RADIANS
+* ROMAN
 * ROUND
 * ROUNDDOWN
 * ROUNDUP
@@ -125,15 +127,14 @@
 * YEAR
 
 
-# Not Yet Supported Formulas - 340
+# Not Yet Supported Formulas - 338
 
 * ACCRINT
 * ACCRINTM
 * ADDRESS
 * AGGREGATE
 * AMORDEGRC
 * AMORLINC
-* ARABIC
 * AREAS
 * AVERAGEIFS
 * BAHTTEXT
@@ -395,7 +396,6 @@
 * REPLACE
 * REPT
 * RIGHT
-* ROMAN
 * ROW
 * ROWS
 * RRI

diff --git a/hotxlfp/formulas/mathtrig.py b/hotxlfp/formulas/mathtrig.py
@@ -5,8 +5,10 @@
 """
 from __future__ import division
 import math
+import re
 from functools import reduce
 import operator
+import collections
 from . import dispatcher
 from . import error
 from . import utils
@@ -409,3 +411,72 @@ def FACTDOUBLE(number):
         return 1
     return reduce(operator.mul, range(number, 1, -2))
 
+
+@dispatcher.register_for('ROMAN')
+def ROMAN(number, form=0):
+    number = utils.parse_number(number)
+    form = utils.parse_number(form)
+    if form is True:
+        form = 0
+    elif form is False:
+        form = 4
+
+    if utils.any_is_error((number, form)):
+        return error.VALUE
+
+    if not (0 < number < 4000 and 0 <= form <= 4):
+        return error.VALUE # number must be between 1 and 3999
+
+    def numerals(compress):
+        numeral_map = ((1000, 'M'), (500, 'D'), (100, 'C'), (50, 'L'), (10, 'X'), (5, 'V'), (1, 'I'))
+        for i, (arabic, roman) in enumerate(numeral_map, 1):
+            yield arabic, roman
+            # Then we make a list where we try to create new mappings
+            # subtracting the subsequent fixed roman numeral values from our current one 
+            # and prepending their roman numerals to ours, up to compress times.
+            # The more mappings we have the more compressed the representation will be.
+            inbetweeners = collections.deque()
+            for smaller_arabic, smaller_roman in numeral_map[i:]:
+                smaller_arabic = arabic - smaller_arabic
+                if (smaller_arabic, smaller_roman) not in numeral_map:
+                    inbetweeners.appendleft((smaller_arabic, smaller_roman + roman))
+                    if len(inbetweeners) == compress:
+                        break
+            for el in inbetweeners:
+                yield el
+
+    result = ''
+    for arabic_digit, roman_numeral in numerals(form + 1):
+        if not number:
+            break
+        count = int(number / arabic_digit)
+        result += roman_numeral * count
+        number -= arabic_digit * count
+    return result
+
+
+@dispatcher.register_for('ARABIC')
+def ARABIC(text):
+    text = str(text).upper()
+    roman_numeral_regex = '^M{0,4}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})$'
+
+    if re.search(roman_numeral_regex, text) is None:
+        return error.VALUE
+
+    numeral_map = {
+        'M': 1000,
+        'CM': 900,
+        'D': 500,
+        'CD': 400,
+        'C': 100,
+        'XC': 90,
+        'L': 50,
+        'XL': 40,
+        'X': 10,
+        'IX': 9,
+        'V': 5,
+        'IV': 4,
+        'I': 1
+    }
+    result = 0
+    return sum(numeral_map[match.group()] for match in re.finditer('[MDLV]|C[MD]?|X[CL]?|I[XV]?', text))
diff --git a/tests/test_mathtrig.py b/tests/test_mathtrig.py
@@ -464,3 +464,48 @@ def test_factdouble(self):
         ret = p.parse('FACTDOUBLE("foo")')
         self.assertEqual(ret['result'], None)
         self.assertEqual(ret['error'], '#VALUE!')
+
+    def test_roman(self):
+        p = Parser(debug=True)
+        ret = p.parse('ROMAN(499,0)')
+        self.assertEqual(ret['result'], 'CDXCIX')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(499,1)')
+        self.assertEqual(ret['result'], 'LDVLIV')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(499,2)')
+        self.assertEqual(ret['result'], 'XDIX')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(499,3)')
+        self.assertEqual(ret['result'], 'VDIV')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(499,4)')
+        self.assertEqual(ret['result'], 'ID')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(4000)')
+        self.assertEqual(ret['result'], None)
+        self.assertEqual(ret['error'], '#VALUE!')
+        ret = p.parse('ROMAN(499,TRUE())')
+        self.assertEqual(ret['result'], 'CDXCIX')
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ROMAN(499,FALSE())')
+        self.assertEqual(ret['result'], 'ID')
+        self.assertEqual(ret['error'], None)
+
+    def test_arabic(self):
+        p = Parser(debug=True)
+        ret = p.parse('ARABIC("M")')
+        self.assertEqual(ret['result'], 1000)
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ARABIC("LVII")')
+        self.assertEqual(ret['result'], 57)
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ARABIC("mcmxii")')
+        self.assertEqual(ret['result'], 1912)
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ARABIC(ROMAN(499))')
+        self.assertEqual(ret['result'], 499)
+        self.assertEqual(ret['error'], None)
+        ret = p.parse('ARABIC(ROMAN(499, 4))')
+        self.assertEqual(ret['result'], None)
+        self.assertEqual(ret['error'], '#VALUE!')