Merge and add benchmarks to palindrome algorithms in the strings/ directory

DIRECTORY.md

@@ -577,6 +577,7 @@
   * [Hexagonal Number](maths/hexagonal_number.py)
   * [Integration By Simpson Approx](maths/integration_by_simpson_approx.py)
   * [Is Ip V4 Address Valid](maths/is_ip_v4_address_valid.py)
+  * [Is Palindrome](maths/is_palindrome.py)
   * [Is Square Free](maths/is_square_free.py)
   * [Jaccard Similarity](maths/jaccard_similarity.py)
   * [Juggler Sequence](maths/juggler_sequence.py)
@@ -1154,7 +1155,6 @@
   * [Indian Phone Validator](strings/indian_phone_validator.py)
   * [Is Contains Unique Chars](strings/is_contains_unique_chars.py)
   * [Is Isogram](strings/is_isogram.py)
-  * [Is Palindrome](strings/is_palindrome.py)
   * [Is Pangram](strings/is_pangram.py)
   * [Is Spain National Id](strings/is_spain_national_id.py)
   * [Is Srilankan Phone Number](strings/is_srilankan_phone_number.py)

strings/palindrome.py

@@ -1,5 +1,7 @@
 # Algorithms to determine if a string is palindrome
 
+from timeit import timeit
+
 test_data = {
     "MALAYALAM": True,
     "String": False,
@@ -33,6 +35,25 @@ def is_palindrome(s: str) -> bool:
     return True
 
 
+def is_palindrome_traversal(s: str) -> bool:
+    """
+    Return True if s is a palindrome otherwise return False.
+
+    >>> all(is_palindrome_traversal(key) is value for key, value in test_data.items())
+    True
+    """
+    end = len(s) // 2
+    n = len(s)
+
+    # We need to traverse till half of the length of string
+    # as we can get access of the i'th last element from
+    # i'th index.
+    # eg: [0,1,2,3,4,5] => 4th index can be accessed
+    # with the help of 1st index (i==n-i-1)
+    # where n is length of string
+    return all(s[i] == s[n - i - 1] for i in range(end))
+
+
 def is_palindrome_recursive(s: str) -> bool:
     """
     Return True if s is a palindrome otherwise return False.
@@ -58,9 +79,29 @@ def is_palindrome_slice(s: str) -> bool:
     return s == s[::-1]
 
 
+def benchmark_function(name: str) -> None:
+    setup = f"from __main__ import test_data, {name}"
+    number = 100000
+    res = timeit(
+        f"all({name}(key) is value for key, value in test_data.items())",
+        setup=setup,
+        number=number,
+    )
+    print(f"{name:<35} finished {number} runs in {res:.5f} seconds")
+
+
 if __name__ == "__main__":
     for key, value in test_data.items():
         assert is_palindrome(key) is is_palindrome_recursive(key)
         assert is_palindrome(key) is is_palindrome_slice(key)
         print(f"{key:21} {value}")
     print("a man a plan a canal panama")
+
+    benchmark_function("is_palindrome")  # finished 100000 runs in 0.33785 seconds
+    benchmark_function(
+        "is_palindrome_traversal"
+    )  # finished 100000 runs in 0.70002 seconds
+    benchmark_function(
+        "is_palindrome_recursive"
+    )  # finished 100000 runs in 0.48514 seconds
+    benchmark_function("is_palindrome_slice")  # finished 100000 runs in 0.18703 seconds