Merge branch 'TheAlgorithms:master' into master

Author: imSanko

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
     -   id: auto-walrus
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.3
+    rev: v0.1.4
     hooks:
       - id: ruff
 
@@ -33,7 +33,7 @@ repos:
           - tomli
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "1.3.0"
+    rev: "1.4.1"
     hooks:
       - id: pyproject-fmt
 

DIRECTORY.md

@@ -725,6 +725,7 @@
     * [Carmichael Number](maths/special_numbers/carmichael_number.py)
     * [Catalan Number](maths/special_numbers/catalan_number.py)
     * [Hamming Numbers](maths/special_numbers/hamming_numbers.py)
+    * [Happy Number](maths/special_numbers/happy_number.py)
     * [Harshad Numbers](maths/special_numbers/harshad_numbers.py)
     * [Hexagonal Number](maths/special_numbers/hexagonal_number.py)
     * [Krishnamurthy Number](maths/special_numbers/krishnamurthy_number.py)
@@ -1310,6 +1311,7 @@
   * [Get Amazon Product Data](web_programming/get_amazon_product_data.py)
   * [Get Imdb Top 250 Movies Csv](web_programming/get_imdb_top_250_movies_csv.py)
   * [Get Imdbtop](web_programming/get_imdbtop.py)
+  * [Get Ip Geolocation](web_programming/get_ip_geolocation.py)
   * [Get Top Billionaires](web_programming/get_top_billionaires.py)
   * [Get Top Hn Posts](web_programming/get_top_hn_posts.py)
   * [Get User Tweets](web_programming/get_user_tweets.py)

data_structures/arrays/find_triplets_with_0_sum.py

@@ -22,3 +22,66 @@ def find_triplets_with_0_sum(nums: list[int]) -> list[list[int]]:
         list(x)
         for x in sorted({abc for abc in combinations(sorted(nums), 3) if not sum(abc)})
     ]
+
+
+def find_triplets_with_0_sum_hashing(arr: list[int]) -> list[list[int]]:
+    """
+    Function for finding the triplets with a given sum in the array using hashing.
+
+    Given a list of integers, return elements a, b, c such that a + b + c = 0.
+
+    Args:
+        nums: list of integers
+    Returns:
+        list of lists of integers where sum(each_list) == 0
+    Examples:
+        >>> find_triplets_with_0_sum_hashing([-1, 0, 1, 2, -1, -4])
+        [[-1, 0, 1], [-1, -1, 2]]
+        >>> find_triplets_with_0_sum_hashing([])
+        []
+        >>> find_triplets_with_0_sum_hashing([0, 0, 0])
+        [[0, 0, 0]]
+        >>> find_triplets_with_0_sum_hashing([1, 2, 3, 0, -1, -2, -3])
+        [[-1, 0, 1], [-3, 1, 2], [-2, 0, 2], [-2, -1, 3], [-3, 0, 3]]
+
+    Time complexity: O(N^2)
+    Auxiliary Space: O(N)
+
+    """
+    target_sum = 0
+
+    # Initialize the final output array with blank.
+    output_arr = []
+
+    # Set the initial element as arr[i].
+    for index, item in enumerate(arr[:-2]):
+        # to store second elements that can complement the final sum.
+        set_initialize = set()
+
+        # current sum needed for reaching the target sum
+        current_sum = target_sum - item
+
+        # Traverse the subarray arr[i+1:].
+        for other_item in arr[index + 1 :]:
+            # required value for the second element
+            required_value = current_sum - other_item
+
+            # Verify if the desired value exists in the set.
+            if required_value in set_initialize:
+                # finding triplet elements combination.
+                combination_array = sorted([item, other_item, required_value])
+                if combination_array not in output_arr:
+                    output_arr.append(combination_array)
+
+            # Include the current element in the set
+            # for subsequent complement verification.
+            set_initialize.add(other_item)
+
+    # Return all the triplet combinations.
+    return output_arr
+
+
+if __name__ == "__main__":
+    from doctest import testmod
+
+    testmod()

pyproject.toml

@@ -117,6 +117,10 @@ max-branches = 20    # default: 12
 max-returns = 8      # default: 6
 max-statements = 88  # default: 50
 
+[tool.codespell]
+ignore-words-list = "3rt,ans,bitap,crate,damon,fo,followings,hist,iff,kwanza,manuel,mater,secant,som,sur,tim,toi,zar"
+skip = "./.*,*.json,ciphers/prehistoric_men.txt,project_euler/problem_022/p022_names.txt,pyproject.toml,strings/dictionary.txt,strings/words.txt"
+
 [tool.pytest.ini_options]
 markers = [
     "mat_ops: mark a test as utilizing matrix operations.",
@@ -133,7 +137,3 @@ omit = [
   "project_euler/*"
 ]
 sort = "Cover"
-
-[tool.codespell]
-ignore-words-list = "3rt,ans,bitap,crate,damon,fo,followings,hist,iff,kwanza,manuel,mater,secant,som,sur,tim,toi,zar"
-skip = "./.*,*.json,ciphers/prehistoric_men.txt,project_euler/problem_022/p022_names.txt,pyproject.toml,strings/dictionary.txt,strings/words.txt"

strings/detecting_english_programmatically.py

@@ -25,6 +25,18 @@ def get_english_count(message: str) -> float:
 
 
 def remove_non_letters(message: str) -> str:
+    """
+    >>> remove_non_letters("Hi! how are you?")
+    'Hi how are you'
+    >>> remove_non_letters("P^y%t)h@o*n")
+    'Python'
+    >>> remove_non_letters("1+1=2")
+    ''
+    >>> remove_non_letters("www.google.com/")
+    'wwwgooglecom'
+    >>> remove_non_letters("")
+    ''
+    """
     return "".join(symbol for symbol in message if symbol in LETTERS_AND_SPACE)
 
 

strings/string_switch_case.py

@@ -28,6 +28,12 @@ def to_simple_case(str_: str) -> str:
     """
     >>> to_simple_case("one two 31235three4four")
     'OneTwo31235three4four'
+    >>> to_simple_case("This should be combined")
+    'ThisShouldBeCombined'
+    >>> to_simple_case("The first letters are capitalized, then string is merged")
+    'TheFirstLettersAreCapitalizedThenStringIsMerged'
+    >>> to_simple_case("special characters :, ', %, ^, $, are ignored")
+    'SpecialCharactersAreIgnored'
     """
     string_split = split_input(str_)
     return "".join(
@@ -37,6 +43,14 @@ def to_simple_case(str_: str) -> str:
 
 def to_complex_case(text: str, upper: bool, separator: str) -> str:
     """
+    Returns the string concatenated with the delimiter we provide.
+
+    Parameters:
+    @text: The string on which we want to perform operation
+    @upper: Boolean value to determine whether we want capitalized result or not
+    @separator: The delimiter with which we want to concatenate words
+
+    Examples:
     >>> to_complex_case("one two 31235three4four", True, "_")
     'ONE_TWO_31235THREE4FOUR'
     >>> to_complex_case("one two 31235three4four", False, "-")