Merge pull request TheAlgorithms#2 from TheAlgorithms/master

update

Author: itsvinayak

Diff for: .github/workflows/autoblack.yml

@@ -0,0 +1,34 @@
+# GitHub Action that uses Black to reformat the Python code in an incoming pull request.
+# If all Python code in the pull request is complient with Black then this Action does nothing.
+# Othewrwise, Black is run and its changes are committed back to the incoming pull request.
+# https://github.com/cclauss/autoblack
+
+name: autoblack
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        python-version: [3.7]
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install psf/black
+        run: pip install black
+      - name: Run black --check .
+        run: black --check .
+      - name: If needed, commit black changes to the pull request
+        if: failure()
+        run: |
+          black .
+          git config --global user.name 'autoblack'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git checkout $GITHUB_HEAD_REF
+          git commit -am "fixup: Format Python code with psf/black"
+          git push

Diff for: .travis.yml

@@ -11,5 +11,4 @@ script:
   - mypy --ignore-missing-imports .
   - pytest . --doctest-modules
 after_success:
-  - scripts/build_directory_md.py > DIRECTORY.md
-  - cat DIRECTORY.md
+  - scripts/build_directory_md.py 2>&1 | tee DIRECTORY.md

Diff for: data_structures/binary_tree/non_recursive_segment_tree.py

@@ -0,0 +1,153 @@
+"""
+A non-recursive Segment Tree implementation with range query and single element update,
+works virtually with any list of the same type of elements with a "commutative" combiner.
+
+Explanation:
+https://www.geeksforgeeks.org/iterative-segment-tree-range-minimum-query/
+https://www.geeksforgeeks.org/segment-tree-efficient-implementation/
+
+>>> SegmentTree([1, 2, 3], lambda a, b: a + b).query(0, 2)
+6
+>>> SegmentTree([3, 1, 2], min).query(0, 2)
+1
+>>> SegmentTree([2, 3, 1], max).query(0, 2)
+3
+>>> st = SegmentTree([1, 5, 7, -1, 6], lambda a, b: a + b)
+>>> st.update(1, -1)
+>>> st.update(2, 3)
+>>> st.query(1, 2)
+2
+>>> st.query(1, 1)
+-1
+>>> st.update(4, 1)
+>>> st.query(3, 4)
+0
+>>> st = SegmentTree([[1, 2, 3], [3, 2, 1], [1, 1, 1]], lambda a, b: [a[i] + b[i] for i in range(len(a))])
+>>> st.query(0, 1)
+[4, 4, 4]
+>>> st.query(1, 2)
+[4, 3, 2]
+>>> st.update(1, [-1, -1, -1])
+>>> st.query(1, 2)
+[0, 0, 0]
+>>> st.query(0, 2)
+[1, 2, 3]
+"""
+from typing import List, Callable, TypeVar
+
+T = TypeVar("T")
+
+
+class SegmentTree:
+    def __init__(self, arr: List[T], fnc: Callable[[T, T], T]) -> None:
+        """
+        Segment Tree constructor, it works just with commutative combiner.
+        :param arr: list of elements for the segment tree
+        :param fnc: commutative function for combine two elements
+
+        >>> SegmentTree(['a', 'b', 'c'], lambda a, b: '{}{}'.format(a, b)).query(0, 2)
+        'abc'
+        >>> SegmentTree([(1, 2), (2, 3), (3, 4)], lambda a, b: (a[0] + b[0], a[1] + b[1])).query(0, 2)
+        (6, 9)
+        """
+        self.N = len(arr)
+        self.st = [None for _ in range(len(arr))] + arr
+        self.fn = fnc
+        self.build()
+
+    def build(self) -> None:
+        for p in range(self.N - 1, 0, -1):
+            self.st[p] = self.fn(self.st[p * 2], self.st[p * 2 + 1])
+
+    def update(self, p: int, v: T) -> None:
+        """
+        Update an element in log(N) time
+        :param p: position to be update
+        :param v: new value
+
+        >>> st = SegmentTree([3, 1, 2, 4], min)
+        >>> st.query(0, 3)
+        1
+        >>> st.update(2, -1)
+        >>> st.query(0, 3)
+        -1
+        """
+        p += self.N
+        self.st[p] = v
+        while p > 1:
+            p = p // 2
+            self.st[p] = self.fn(self.st[p * 2], self.st[p * 2 + 1])
+
+    def query(self, l: int, r: int) -> T:
+        """
+        Get range query value in log(N) time
+        :param l: left element index
+        :param r: right element index
+        :return: element combined in the range [l, r]
+
+        >>> st = SegmentTree([1, 2, 3, 4], lambda a, b: a + b)
+        >>> st.query(0, 2)
+        6
+        >>> st.query(1, 2)
+        5
+        >>> st.query(0, 3)
+        10
+        >>> st.query(2, 3)
+        7
+        """
+        l, r = l + self.N, r + self.N
+        res = None
+        while l <= r:
+            if l % 2 == 1:
+                res = self.st[l] if res is None else self.fn(res, self.st[l])
+            if r % 2 == 0:
+                res = self.st[r] if res is None else self.fn(res, self.st[r])
+            l, r = (l + 1) // 2, (r - 1) // 2
+        return res
+
+
+if __name__ == "__main__":
+    from functools import reduce
+
+    test_array = [1, 10, -2, 9, -3, 8, 4, -7, 5, 6, 11, -12]
+
+    test_updates = {
+        0: 7,
+        1: 2,
+        2: 6,
+        3: -14,
+        4: 5,
+        5: 4,
+        6: 7,
+        7: -10,
+        8: 9,
+        9: 10,
+        10: 12,
+        11: 1,
+    }
+
+    min_segment_tree = SegmentTree(test_array, min)
+    max_segment_tree = SegmentTree(test_array, max)
+    sum_segment_tree = SegmentTree(test_array, lambda a, b: a + b)
+
+    def test_all_segments():
+        """
+        Test all possible segments
+        """
+        for i in range(len(test_array)):
+            for j in range(i, len(test_array)):
+                min_range = reduce(min, test_array[i : j + 1])
+                max_range = reduce(max, test_array[i : j + 1])
+                sum_range = reduce(lambda a, b: a + b, test_array[i : j + 1])
+                assert min_range == min_segment_tree.query(i, j)
+                assert max_range == max_segment_tree.query(i, j)
+                assert sum_range == sum_segment_tree.query(i, j)
+
+    test_all_segments()
+
+    for index, value in test_updates.items():
+        test_array[index] = value
+        min_segment_tree.update(index, value)
+        max_segment_tree.update(index, value)
+        sum_segment_tree.update(index, value)
+        test_all_segments()

Diff for: dynamic_programming/max_sum_contigous_subsequence.py

@@ -0,0 +1,20 @@
+def max_subarray_sum(nums: list) -> int:
+    """
+    >>> max_subarray_sum([6 , 9, -1, 3, -7, -5, 10])
+    17
+    """
+    if not nums:
+        return 0
+    n = len(nums)
+    s = [0] * n
+    res, s, s_pre = nums[0], nums[0], nums[0]
+    for i in range(1, n):
+        s = max(nums[i], s_pre + nums[i])
+        s_pre = s
+        res = max(res, s)
+    return res
+
+
+if __name__ == "__main__":
+    nums = [6, 9, -1, 3, -7, -5, 10]
+    print(max_subarray_sum(nums))

Diff for: maths/factorial_python.py

@@ -1,21 +1,34 @@
 def factorial(input_number: int) -> int:
     """
-        Non-recursive algorithm of finding factorial of the
-        input number.
-        >>> factorial(1)
-        1
-        >>> factorial(6)
-        720
-        >>> factorial(0)
-        1
+    Calculate the factorial of specified number
+
+    >>> factorial(1)
+    1
+    >>> factorial(6)
+    720
+    >>> factorial(0)
+    1
+    >>> factorial(-1)
+    Traceback (most recent call last):
+        ...
+    ValueError: factorial() not defined for negative values
+    >>> factorial(0.1)
+    Traceback (most recent call last):
+        ...
+    ValueError: factorial() only accepts integral values
     """
 
     if input_number < 0:
-        raise ValueError("Input input_number should be non-negative")
-    elif input_number == 0:
-        return 1
-    else:
-        result = 1
-        for i in range(input_number):
-            result = result * (i + 1)
+        raise ValueError("factorial() not defined for negative values")
+    if not isinstance(input_number, int):
+        raise ValueError("factorial() only accepts integral values")
+    result = 1
+    for i in range(1, input_number):
+        result = result * (i + 1)
     return result
+
+
+if __name__ == '__main__':
+    import doctest
+
+    doctest.testmod()

Diff for: maths/factorial_recursive.py

@@ -1,14 +1,30 @@
-def fact(n):
+def factorial(n: int) -> int:
     """
-    Return 1, if n is 1 or below,
-    otherwise, return n * fact(n-1).
+    Calculate the factorial of specified number
+
+    >>> factorial(1)
+    1
+    >>> factorial(6)
+    720
+    >>> factorial(0)
+    1
+    >>> factorial(-1)
+    Traceback (most recent call last):
+        ...
+    ValueError: factorial() not defined for negative values
+    >>> factorial(0.1)
+    Traceback (most recent call last):
+        ...
+    ValueError: factorial() only accepts integral values
     """
-    return 1 if n <= 1 else n * fact(n - 1)
+    if n < 0:
+        raise ValueError("factorial() not defined for negative values")
+    if not isinstance(n, int):
+        raise ValueError("factorial() only accepts integral values")
+    return 1 if n == 0 or n == 1 else n * factorial(n - 1)
+
 
+if __name__ == '__main__':
+    import doctest
 
-"""
-Show factorial for i,
-where i ranges from 1 to 20.
-"""
-for i in range(1, 21):
-    print(i, ": ", fact(i), sep="")
+    doctest.testmod()

Diff for: maths/perfect_square.py

@@ -0,0 +1,27 @@
+import math
+
+
+def perfect_square(num: int) -> bool:
+    """
+    Check if a number is perfect square number or not
+    :param num: the number to be checked
+    :return: True if number is square number, otherwise False
+
+    >>> perfect_square(9)
+    True
+    >>> perfect_square(16)
+    True
+    >>> perfect_square(1)
+    True
+    >>> perfect_square(0)
+    True
+    >>> perfect_square(10)
+    False
+    """
+    return math.sqrt(num) * math.sqrt(num) == num
+
+
+if __name__ == '__main__':
+    import doctest
+
+    doctest.testmod()