Merge branch 'master' into 'test/string-conversion'

Author: meysam81

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/CODEOWNERS

@@ -0,0 +1,88 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# More details are here: https://help.github.com/articles/about-codeowners/
+
+# The '*' pattern is global owners.
+
+# Order is important. The last matching pattern has the most precedence.
+
+/.*  @cclauss @dhruvmanila
+
+# /arithmetic_analysis/
+
+# /backtracking/
+
+# /bit_manipulation/
+
+# /blockchain/
+
+# /boolean_algebra/
+
+# /cellular_automata/
+
+# /ciphers/  @cclauss  # TODO: Uncomment this line after Hacktoberfest
+
+# /compression/
+
+# /computer_vision/
+
+# /conversions/  @cclauss  # TODO: Uncomment this line after Hacktoberfest
+
+# /data_structures/  @cclauss  # TODO: Uncomment this line after Hacktoberfest
+
+/digital_image_processing/ @mateuszz0000
+
+# /divide_and_conquer/
+
+/dynamic_programming/ @Kush1101
+
+# /file_transfer/
+
+# /fuzzy_logic/
+
+# /genetic_algorithm/
+
+# /geodesy/
+
+# /graphics/
+
+# /graphs/
+
+# /greedy_method/
+
+# /hashes/
+
+# /images/
+
+# /linear_algebra/
+
+# /machine_learning/
+
+/maths/ @Kush1101
+
+# /matrix/
+
+# /networking_flow/
+
+# /neural_network/
+
+# /other/  @cclauss  # TODO: Uncomment this line after Hacktoberfest
+
+/project_euler/  @dhruvmanila @Kush1101
+
+# /quantum/
+
+# /scheduling/
+
+# /scripts/
+
+# /searches/
+
+/sorts/ @mateuszz0000
+
+# /strings/  @cclauss  # TODO: Uncomment this line after Hacktoberfest
+
+# /traversals/
+
+/web_programming/  @cclauss

.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: "build"
+
+on:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *" # Run everyday
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools six wheel
+          python -m pip install pytest-cov -r requirements.txt
+      - name: Run tests
+        run: pytest --doctest-modules --ignore=project_euler/ --cov-report=term-missing:skip-covered --cov=. .
+      - if: ${{ success() }}
+        run: scripts/build_directory_md.py 2>&1 | tee DIRECTORY.md

.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cache/pre-commit
+            ~/.cache/pip
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+      - uses: actions/setup-python@v2
+      - name: Install pre-commit
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade pre-commit
+      - run: pre-commit run --verbose --all-files --show-diff-on-failure

.github/workflows/project_euler.yml

@@ -0,0 +1,31 @@
+on:
+  pull_request:
+    # only check if a file is changed within the project_euler directory and related files
+    paths:
+      - 'project_euler/**'
+      - '.github/workflows/project_euler.yml'
+      - 'scripts/validate_solutions.py'
+
+name: 'Project Euler'
+
+jobs:
+  project-euler:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install pytest and pytest-cov
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade pytest pytest-cov
+      - run: pytest --doctest-modules --cov-report=term-missing:skip-covered --cov=project_euler/ project_euler/
+  validate-solutions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install pytest
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade pytest
+      - run: pytest scripts/validate_solutions.py

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: check-executables-have-shebangs
+      - id: check-yaml
+      - id: end-of-file-fixer
+        types: [python]
+      - id: trailing-whitespace
+        exclude: |
+          (?x)^(
+            data_structures/heap/binomial_heap.py
+          )$
+      - id: requirements-txt-fixer
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.5.3
+    hooks:
+      - id: isort
+        args:
+          - --profile=black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8
+        args:
+          - --ignore=E203,W503
+          - --max-complexity=25
+          - --max-line-length=88
+#     FIXME: fix mypy errors and then uncomment this
+#    - repo: https://github.com/pre-commit/mirrors-mypy
+#      rev: v0.782
+#      hooks:
+#        - id: mypy
+#          args:
+#            - --ignore-missing-imports
+  - repo: https://github.com/codespell-project/codespell
+    rev: v1.17.1
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=ans,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: |
+          (?x)^(
+              other/dictionary.txt |
+              other/words |
+              project_euler/problem_022/p022_names.txt
+          )$
+  - repo: local
+    hooks:
+      - id: validate-filenames
+        name: Validate filenames
+        entry: ./scripts/validate_filenames.py
+        language: script
+        pass_filenames: false

arithmetic_analysis/__init__.py

@@ -0,0 +1,52 @@
+# https://www.tutorialspoint.com/python3/bitwise_operators_example.htm
+
+
+def binary_and(a: int, b: int):
+    """
+    Take in 2 integers, convert them to binary,
+    return a binary number that is the
+    result of a binary and operation on the integers provided.
+
+    >>> binary_and(25, 32)
+    '0b000000'
+    >>> binary_and(37, 50)
+    '0b100000'
+    >>> binary_and(21, 30)
+    '0b10100'
+    >>> binary_and(58, 73)
+    '0b0001000'
+    >>> binary_and(0, 255)
+    '0b00000000'
+    >>> binary_and(256, 256)
+    '0b100000000'
+    >>> binary_and(0, -1)
+    Traceback (most recent call last):
+        ...
+    ValueError: the value of both input must be positive
+    >>> binary_and(0, 1.1)
+    Traceback (most recent call last):
+        ...
+    TypeError: 'float' object cannot be interpreted as an integer
+    >>> binary_and("0", "1")
+    Traceback (most recent call last):
+        ...
+    TypeError: '<' not supported between instances of 'str' and 'int'
+    """
+    if a < 0 or b < 0:
+        raise ValueError("the value of both input must be positive")
+
+    a_binary = str(bin(a))[2:]  # remove the leading "0b"
+    b_binary = str(bin(b))[2:]  # remove the leading "0b"
+
+    max_len = max(len(a_binary), len(b_binary))
+
+    return "0b" + "".join(
+        str(int(char_a == "1" and char_b == "1"))
+        for char_a, char_b in zip(a_binary.zfill(max_len), b_binary.zfill(max_len))
+    )
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

arithmetic_analysis/image_data/__init__.py

@@ -0,0 +1,41 @@
+def binary_count_setbits(a: int) -> int:
+    """
+    Take in 1 integer, return a number that is
+    the number of 1's in binary representation of that number.
+
+    >>> binary_count_setbits(25)
+    3
+    >>> binary_count_setbits(36)
+    2
+    >>> binary_count_setbits(16)
+    1
+    >>> binary_count_setbits(58)
+    4
+    >>> binary_count_setbits(4294967295)
+    32
+    >>> binary_count_setbits(0)
+    0
+    >>> binary_count_setbits(-10)
+    Traceback (most recent call last):
+        ...
+    ValueError: Input value must be a positive integer
+    >>> binary_count_setbits(0.8)
+    Traceback (most recent call last):
+        ...
+    TypeError: Input value must be a 'int' type
+    >>> binary_count_setbits("0")
+    Traceback (most recent call last):
+        ...
+    TypeError: '<' not supported between instances of 'str' and 'int'
+    """
+    if a < 0:
+        raise ValueError("Input value must be a positive integer")
+    elif isinstance(a, float):
+        raise TypeError("Input value must be a 'int' type")
+    return bin(a).count("1")
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

backtracking/__init__.py

@@ -0,0 +1,44 @@
+from math import log2
+
+
+def binary_count_trailing_zeros(a: int) -> int:
+    """
+    Take in 1 integer, return a number that is
+    the number of trailing zeros in binary representation of that number.
+
+    >>> binary_count_trailing_zeros(25)
+    0
+    >>> binary_count_trailing_zeros(36)
+    2
+    >>> binary_count_trailing_zeros(16)
+    4
+    >>> binary_count_trailing_zeros(58)
+    1
+    >>> binary_count_trailing_zeros(4294967296)
+    32
+    >>> binary_count_trailing_zeros(0)
+    0
+    >>> binary_count_trailing_zeros(-10)
+    Traceback (most recent call last):
+        ...
+    ValueError: Input value must be a positive integer
+    >>> binary_count_trailing_zeros(0.8)
+    Traceback (most recent call last):
+        ...
+    TypeError: Input value must be a 'int' type
+    >>> binary_count_trailing_zeros("0")
+    Traceback (most recent call last):
+        ...
+    TypeError: '<' not supported between instances of 'str' and 'int'
+    """
+    if a < 0:
+        raise ValueError("Input value must be a positive integer")
+    elif isinstance(a, float):
+        raise TypeError("Input value must be a 'int' type")
+    return 0 if (a == 0) else int(log2(a & -a))
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()