Merge branch 'master' into master

Author: dhruvmanila

.github/workflows/build.yml

@@ -20,7 +20,22 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip setuptools six wheel
-          python -m pip install pytest-cov -r requirements.txt
+          python -m pip install mypy pytest-cov -r requirements.txt
+      # FIXME: #4052 fix mypy errors in other directories and add them here
+      - run: mypy --ignore-missing-imports
+           backtracking
+           bit_manipulation
+           blockchain
+           boolean_algebra
+           cellular_automata
+           computer_vision
+           fractals
+           fuzzy_logic
+           genetic_algorithm
+           geodesy
+           knapsack
+           networking_flow
+           scheduling sorts
       - name: Run tests
         run: pytest --doctest-modules --ignore=project_euler/ --ignore=scripts/ --cov-report=term-missing:skip-covered --cov=. .
       - if: ${{ success() }}

.github/workflows/pre-commit.yml

@@ -14,6 +14,7 @@ jobs:
             ~/.cache/pip
           key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
       - uses: actions/setup-python@v2
+      - uses: psf/black@stable
       - name: Install pre-commit
         run: |
           python -m pip install --upgrade pip

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v3.4.0
     hooks:
       - id: check-executables-have-shebangs
       - id: check-yaml
@@ -13,17 +13,17 @@ repos:
           )$
       - id: requirements-txt-fixer
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 20.8b1
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: 5.5.3
+    rev: 5.7.0
     hooks:
       - id: isort
         args:
           - --profile=black
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.3
+    rev: 3.9.0
     hooks:
       - id: flake8
         args:
@@ -38,11 +38,11 @@ repos:
 #          args:
 #            - --ignore-missing-imports
   - repo: https://github.com/codespell-project/codespell
-    rev: v1.17.1
+    rev: v2.0.0
     hooks:
       - id: codespell
         args:
-          - --ignore-words-list=ans,fo,followings,hist,iff,mater,secant,som,tim
+          - --ignore-words-list=ans,crate,fo,followings,hist,iff,mater,secant,som,tim
           - --skip="./.*,./other/dictionary.txt,./other/words,./project_euler/problem_022/p022_names.txt"
           - --quiet-level=2
         exclude: |

CONTRIBUTING.md

@@ -155,6 +155,8 @@ We want your work to be readable by others; therefore, we encourage you to note
       return a + b
   ```
 
+  Instructions on how to install mypy can be found [here](https://github.com/python/mypy). Please use the command `mypy --ignore-missing-imports .` to test all files or `mypy --ignore-missing-imports path/to/file.py` to test a specific file.
+
 - [__List comprehensions and generators__](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions) are preferred over the use of `lambda`, `map`, `filter`, `reduce` but the important thing is to demonstrate the power of Python in code that is easy to read and maintain.
 
 - Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.

DIRECTORY.md

@@ -29,7 +29,10 @@
   * [Binary Count Setbits](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_count_setbits.py)
   * [Binary Count Trailing Zeros](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_count_trailing_zeros.py)
   * [Binary Or Operator](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_or_operator.py)
+  * [Binary Shifts](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_shifts.py)
+  * [Binary Twos Complement](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_twos_complement.py)
   * [Binary Xor Operator](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/binary_xor_operator.py)
+  * [Count Number Of One Bits](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/count_number_of_one_bits.py)
   * [Reverse Bits](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/reverse_bits.py)
   * [Single Bit Manipulation Operations](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/single_bit_manipulation_operations.py)
 
@@ -276,6 +279,8 @@
 
 ## Graphics
   * [Bezier Curve](https://github.com/TheAlgorithms/Python/blob/master/graphics/bezier_curve.py)
+  * [Koch Snowflake](https://github.com/TheAlgorithms/Python/blob/master/graphics/koch_snowflake.py)
+  * [Mandelbrot](https://github.com/TheAlgorithms/Python/blob/master/graphics/mandelbrot.py)
   * [Vector3 For 2D Rendering](https://github.com/TheAlgorithms/Python/blob/master/graphics/vector3_for_2d_rendering.py)
 
 ## Graphs
@@ -468,6 +473,8 @@
   * [Runge Kutta](https://github.com/TheAlgorithms/Python/blob/master/maths/runge_kutta.py)
   * [Segmented Sieve](https://github.com/TheAlgorithms/Python/blob/master/maths/segmented_sieve.py)
   * Series
+    * [Arithmetic Mean](https://github.com/TheAlgorithms/Python/blob/master/maths/series/arithmetic_mean.py)
+    * [Geometric Mean](https://github.com/TheAlgorithms/Python/blob/master/maths/series/geometric_mean.py)
     * [Geometric Series](https://github.com/TheAlgorithms/Python/blob/master/maths/series/geometric_series.py)
     * [Harmonic Series](https://github.com/TheAlgorithms/Python/blob/master/maths/series/harmonic_series.py)
     * [P Series](https://github.com/TheAlgorithms/Python/blob/master/maths/series/p_series.py)
@@ -523,6 +530,7 @@
   * [Frequency Finder](https://github.com/TheAlgorithms/Python/blob/master/other/frequency_finder.py)
   * [Game Of Life](https://github.com/TheAlgorithms/Python/blob/master/other/game_of_life.py)
   * [Gauss Easter](https://github.com/TheAlgorithms/Python/blob/master/other/gauss_easter.py)
+  * [Graham Scan](https://github.com/TheAlgorithms/Python/blob/master/other/graham_scan.py)
   * [Greedy](https://github.com/TheAlgorithms/Python/blob/master/other/greedy.py)
   * [Integeration By Simpson Approx](https://github.com/TheAlgorithms/Python/blob/master/other/integeration_by_simpson_approx.py)
   * [Largest Subarray Sum](https://github.com/TheAlgorithms/Python/blob/master/other/largest_subarray_sum.py)
@@ -755,6 +763,8 @@
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_102/sol1.py)
   * Problem 107
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_107/sol1.py)
+  * Problem 109
+    * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_109/sol1.py)
   * Problem 112
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_112/sol1.py)
   * Problem 113
@@ -763,6 +773,8 @@
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_119/sol1.py)
   * Problem 120
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_120/sol1.py)
+  * Problem 121
+    * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_121/sol1.py)
   * Problem 123
     * [Sol1](https://github.com/TheAlgorithms/Python/blob/master/project_euler/problem_123/sol1.py)
   * Problem 125
@@ -843,6 +855,7 @@
   * [Merge Insertion Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/merge_insertion_sort.py)
   * [Merge Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/merge_sort.py)
   * [Natural Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/natural_sort.py)
+  * [Odd Even Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/odd_even_sort.py)
   * [Odd Even Transposition Parallel](https://github.com/TheAlgorithms/Python/blob/master/sorts/odd_even_transposition_parallel.py)
   * [Odd Even Transposition Single Threaded](https://github.com/TheAlgorithms/Python/blob/master/sorts/odd_even_transposition_single_threaded.py)
   * [Pancake Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/pancake_sort.py)
@@ -859,6 +872,7 @@
   * [Recursive Quick Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/recursive_quick_sort.py)
   * [Selection Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/selection_sort.py)
   * [Shell Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/shell_sort.py)
+  * [Slowsort](https://github.com/TheAlgorithms/Python/blob/master/sorts/slowsort.py)
   * [Stooge Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/stooge_sort.py)
   * [Strand Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/strand_sort.py)
   * [Tim Sort](https://github.com/TheAlgorithms/Python/blob/master/sorts/tim_sort.py)

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 The Algorithms
+Copyright (c) 2016-2021 The Algorithms
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bit_manipulation/binary_shifts.py

@@ -0,0 +1,111 @@
+# Information on binary shifts:
+# https://docs.python.org/3/library/stdtypes.html#bitwise-operations-on-integer-types
+# https://www.interviewcake.com/concept/java/bit-shift
+
+
+def logical_left_shift(number: int, shift_amount: int) -> str:
+    """
+    Take in 2 positive integers.
+    'number' is the integer to be logically left shifted 'shift_amount' times.
+    i.e. (number << shift_amount)
+    Return the shifted binary representation.
+
+    >>> logical_left_shift(0, 1)
+    '0b00'
+    >>> logical_left_shift(1, 1)
+    '0b10'
+    >>> logical_left_shift(1, 5)
+    '0b100000'
+    >>> logical_left_shift(17, 2)
+    '0b1000100'
+    >>> logical_left_shift(1983, 4)
+    '0b111101111110000'
+    >>> logical_left_shift(1, -1)
+    Traceback (most recent call last):
+        ...
+    ValueError: both inputs must be positive integers
+    """
+    if number < 0 or shift_amount < 0:
+        raise ValueError("both inputs must be positive integers")
+
+    binary_number = str(bin(number))
+    binary_number += "0" * shift_amount
+    return binary_number
+
+
+def logical_right_shift(number: int, shift_amount: int) -> str:
+    """
+    Take in positive 2 integers.
+    'number' is the integer to be logically right shifted 'shift_amount' times.
+    i.e. (number >>> shift_amount)
+    Return the shifted binary representation.
+
+    >>> logical_right_shift(0, 1)
+    '0b0'
+    >>> logical_right_shift(1, 1)
+    '0b0'
+    >>> logical_right_shift(1, 5)
+    '0b0'
+    >>> logical_right_shift(17, 2)
+    '0b100'
+    >>> logical_right_shift(1983, 4)
+    '0b1111011'
+    >>> logical_right_shift(1, -1)
+    Traceback (most recent call last):
+        ...
+    ValueError: both inputs must be positive integers
+    """
+    if number < 0 or shift_amount < 0:
+        raise ValueError("both inputs must be positive integers")
+
+    binary_number = str(bin(number))[2:]
+    if shift_amount >= len(binary_number):
+        return "0b0"
+    shifted_binary_number = binary_number[: len(binary_number) - shift_amount]
+    return "0b" + shifted_binary_number
+
+
+def arithmetic_right_shift(number: int, shift_amount: int) -> str:
+    """
+    Take in 2 integers.
+    'number' is the integer to be arithmetically right shifted 'shift_amount' times.
+    i.e. (number >> shift_amount)
+    Return the shifted binary representation.
+
+    >>> arithmetic_right_shift(0, 1)
+    '0b00'
+    >>> arithmetic_right_shift(1, 1)
+    '0b00'
+    >>> arithmetic_right_shift(-1, 1)
+    '0b11'
+    >>> arithmetic_right_shift(17, 2)
+    '0b000100'
+    >>> arithmetic_right_shift(-17, 2)
+    '0b111011'
+    >>> arithmetic_right_shift(-1983, 4)
+    '0b111110000100'
+    """
+    if number >= 0:  # Get binary representation of positive number
+        binary_number = "0" + str(bin(number)).strip("-")[2:]
+    else:  # Get binary (2's complement) representation of negative number
+        binary_number_length = len(bin(number)[3:])  # Find 2's complement of number
+        binary_number = bin(abs(number) - (1 << binary_number_length))[3:]
+        binary_number = (
+            ("1" + "0" * (binary_number_length - len(binary_number)) + binary_number)
+            if number < 0
+            else "0"
+        )
+
+    if shift_amount >= len(binary_number):
+        return "0b" + binary_number[0] * len(binary_number)
+    return (
+        "0b"
+        + binary_number[0] * shift_amount
+        + binary_number[: len(binary_number) - shift_amount]
+    )
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

bit_manipulation/binary_twos_complement.py

@@ -0,0 +1,43 @@
+# Information on 2's complement: https://en.wikipedia.org/wiki/Two%27s_complement
+
+
+def twos_complement(number: int) -> str:
+    """
+    Take in a negative integer 'number'.
+    Return the two's complement representation of 'number'.
+
+    >>> twos_complement(0)
+    '0b0'
+    >>> twos_complement(-1)
+    '0b11'
+    >>> twos_complement(-5)
+    '0b1011'
+    >>> twos_complement(-17)
+    '0b101111'
+    >>> twos_complement(-207)
+    '0b100110001'
+    >>> twos_complement(1)
+    Traceback (most recent call last):
+        ...
+    ValueError: input must be a negative integer
+    """
+    if number > 0:
+        raise ValueError("input must be a negative integer")
+    binary_number_length = len(bin(number)[3:])
+    twos_complement_number = bin(abs(number) - (1 << binary_number_length))[3:]
+    twos_complement_number = (
+        (
+            "1"
+            + "0" * (binary_number_length - len(twos_complement_number))
+            + twos_complement_number
+        )
+        if number < 0
+        else "0"
+    )
+    return "0b" + twos_complement_number
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

bit_manipulation/count_number_of_one_bits.py

@@ -0,0 +1,34 @@
+def get_set_bits_count(number: int) -> int:
+    """
+    Count the number of set bits in a 32 bit integer
+    >>> get_set_bits_count(25)
+    3
+    >>> get_set_bits_count(37)
+    3
+    >>> get_set_bits_count(21)
+    3
+    >>> get_set_bits_count(58)
+    4
+    >>> get_set_bits_count(0)
+    0
+    >>> get_set_bits_count(256)
+    1
+    >>> get_set_bits_count(-1)
+    Traceback (most recent call last):
+        ...
+    ValueError: the value of input must be positive
+    """
+    if number < 0:
+        raise ValueError("the value of input must be positive")
+    result = 0
+    while number:
+        if number % 2 == 1:
+            result += 1
+        number = number >> 1
+    return result
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()