docs: documentation, ci/cd and apply Black formatter.

Author: praisetompane

.github/workflows/computer_programming.yaml

@@ -7,12 +7,21 @@ on:
     branches: [ main ]
 
 jobs:
-  spell_check:
+  build:
     runs-on: ubuntu-latest
     steps:
-    - name: check out repo
+    - name: Check Repository
       uses: actions/checkout@v4
-    - name: spell check
+    - name: Spell Check
       uses: rojopolis/[email protected]
-      with:                                        
+      with:       
+        task_name: English                                 
         output_file: spellcheck-output.txt
+    - name: Install Pipenv
+      run: python -m pip install pipenv
+    - name: Install Dependencies
+      run: pipenv sync --system -d
+    - name: Style Check
+      run: black --check .
+    - name: Run Tests
+      run: pytest

Dockerfile

@@ -10,5 +10,7 @@ RUN apt-get update \
 RUN apt-get install python3 -y && apt-get install python3-pip -y && apt-get install pipenv -y && ln -s /usr/bin/python3 /usr/bin/python
 RUN apt-get install ghc -y
 
+RUN pipenv sync --system -d
+
 RUN adduser -u 5678 --disabled-password --gecos "" computer_programming && chown -R computer_programming /computer_programming
 USER computer_programming

Pipfile

@@ -4,9 +4,15 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-pyspelling = "==2.10"
+numpy = "*"
+matplotlib = "*"
+graphviz = "*"
 
 [dev-packages]
+pyspelling = "*"
+ipykernel = "*"
+pytest = "*"
+black = "*"
 
 [requires]
 python_version = "3.13"

Pipfile.lock

@@ -1,11 +1,10 @@
 # What is Computer Programming?
-
 ![build status](https://github.com/praisetompane/computer_programming/actions/workflows/computer_programming.yaml/badge.svg) <br>
 
 ## Objectives
 - Attempts to define a unified scientific discipline of computer programming independent of programming language implementations.
 
-## Definitions:
+## Definitions
 - def computer programming: the act of extending or changing a system's functionality (Haridi and Van Roy, 2004:xv).
   - formal: ???
     - in words: ???
@@ -104,14 +103,12 @@ pyspelling -c spellcheck.yaml
 ```
 
 
-## References:
-  - Van Roy P, Haridi S. 2004. Concepts, Techniques and Models of Computer Programming. The MIT Press.
-  - Sipser, M. 2012. Introduction to the Theory of Computation. 3rd ed. Cengage Learning.
-
-# Legend:
-
-**Q**: Question for later research
+## References
+- Van Roy P, Haridi S. 2004. Concepts, Techniques and Models of Computer Programming. The MIT Press.
+- Sipser, M. 2012. Introduction to the Theory of Computation. 3rd ed. Cengage Learning.
 
+# Legend
+**Q**: Question for later research <br>
 **MYINC**: My Insight/Conjecture [Could Be Unoriginal/False and Likely Is]
 
 **Disclaimer**: This is an ongoing and incomplete project to unpack these concepts and serves as my distributed memory.

README.md

@@ -1,52 +1,52 @@
 """
-    Context:
-        Given:
-            method isSubstring
-                checks if one word is a substring of another
-
-    Definitions:
-        rotation = letters moved n places left/right
-            split string into two parts
-                x,y
-                rotated  string = yx
-                original string = xy
-            --------------------------------------
-                s1 = abcd
-                s2 = cdab
-
-                s1
-                    x = ab
-                    y = cd
-                    yx = cdab = s2
-
-        is not:
-            shuffling letters into arbitary positions
-            
-    Objective:
-        Given two strings
-            s1 and s2
-
-        Write Algorithm to check
-            if s2 is a 
-                rotation
-                    of s1
-            
-    Assumptions:
-        s1 and s2 are same length
-    Constraints:
-        Only 1 call to isSubstring
-
-    Algorithm flow:
-        Using definition of rotation
-            yxyx contains xy
-            cdabcd contains abcd
-
-        Flow:
-            s2contact = concat s2 and s2
-            check if s1 isSubstring of s2contact
-    Possible Solutions
-    
-    Example(s):
+Context:
+    Given:
+        method isSubstring
+            checks if one word is a substring of another
+
+Definitions:
+    rotation = letters moved n places left/right
+        split string into two parts
+            x,y
+            rotated  string = yx
+            original string = xy
+        --------------------------------------
+            s1 = abcd
+            s2 = cdab
+
+            s1
+                x = ab
+                y = cd
+                yx = cdab = s2
+
+    is not:
+        shuffling letters into arbitary positions
+
+Objective:
+    Given two strings
+        s1 and s2
+
+    Write Algorithm to check
+        if s2 is a
+            rotation
+                of s1
+
+Assumptions:
+    s1 and s2 are same length
+Constraints:
+    Only 1 call to isSubstring
+
+Algorithm flow:
+    Using definition of rotation
+        yxyx contains xy
+        cdabcd contains abcd
+
+    Flow:
+        s2contact = concat s2 and s2
+        check if s1 isSubstring of s2contact
+Possible Solutions
+
+Example(s):
 
 
 """
@@ -59,10 +59,10 @@ def is_substring(search_string, source_string):
     return is_substring(s1, s2 + s2)
 
 
-assert (string_rotation("waterbottle", "erbottlewat"))  # True
-assert (string_rotation("abcd", "cdab"))  # True
-assert (not string_rotation("abcd", "cdaob"))  # False
-assert (not string_rotation("abcd", ""))  # False
+assert string_rotation("waterbottle", "erbottlewat")  # True
+assert string_rotation("abcd", "cdab")  # True
+assert not string_rotation("abcd", "cdaob")  # False
+assert not string_rotation("abcd", "")  # False
 print("completed successfully")
 
 """

programs_per_computational_model/0_declarative/arrays_and_strings/1.9.1. string-rotation.py

@@ -1,42 +1,42 @@
 """
-    Context: 
-        Given:
-            five positive integers
-            
-    Objective:
-        find:
-            minimum sum of four of the integers
-            maximum sum of four of the integers
-        print the min and max
-            on one line, space separated
-        
-    Example:
-        [1,3,5,7,9]
-        min_sum = 1 + 3 + 5 + 7
-        max_xum = 3 + 5 + 7 + 9
-          
-    Assumptions():?
-        Is array always sorted? No mention, there assume it's not
-        output can 32 bit integer
-        
-    Constraints:
-        1 <= arr[i] <= 10^9 : array value range 
-        require 64 bit integer
-        
-    Flow:
-        sort array
-        array_size = 5
-        min_sum = sum(arr[:array_size])
-        max_sum = sum(arr[2:])
-        print(min_sum max_sum)
-    
-    Performance 
-        N = size of array
-        S = O(NlogN): sorting time
-        MIS = O(N - 1) = 𝑂(𝑁) : minimum sum
-        MAS = O(N - 1) = 𝑂(𝑁) : maximum sum
-
-        𝑂(𝑁𝑙𝑜𝑔𝑁 + 𝑁)
+Context:
+    Given:
+        five positive integers
+
+Objective:
+    find:
+        minimum sum of four of the integers
+        maximum sum of four of the integers
+    print the min and max
+        on one line, space separated
+
+Example:
+    [1,3,5,7,9]
+    min_sum = 1 + 3 + 5 + 7
+    max_xum = 3 + 5 + 7 + 9
+
+Assumptions():?
+    Is array always sorted? No mention, there assume it's not
+    output can 32 bit integer
+
+Constraints:
+    1 <= arr[i] <= 10^9 : array value range
+    require 64 bit integer
+
+Flow:
+    sort array
+    array_size = 5
+    min_sum = sum(arr[:array_size])
+    max_sum = sum(arr[2:])
+    print(min_sum max_sum)
+
+Performance
+    N = size of array
+    S = O(NlogN): sorting time
+    MIS = O(N - 1) = 𝑂(𝑁) : minimum sum
+    MAS = O(N - 1) = 𝑂(𝑁) : maximum sum
+
+    𝑂(𝑁𝑙𝑜𝑔𝑁 + 𝑁)
 """
 
 

programs_per_computational_model/0_declarative/arrays_and_strings/min_max_sum.py

@@ -4,12 +4,17 @@
     def pangram: a string that contains every letter of the alphabet
 """
 
+
 def is_subset(s):
-    universe = set(s.lower()) # not necessary, this is for set use explicitness
+    universe = set(s.lower())  # not necessary, this is for set use explicitness
     fixed_domain = set(string.ascii_lowercase)
-    if(fixed_domain.issubset(universe)):
+    if fixed_domain.issubset(universe):
         return "pangram"
     return "not pangram"
 
-assert(is_subset("We promptly judged antique ivory buckles for the next prize") == "pangram")
-assert(is_subset("We promptly judged antique ivory buckles") == "not pangram")
+
+assert (
+    is_subset("We promptly judged antique ivory buckles for the next prize")
+    == "pangram"
+)
+assert is_subset("We promptly judged antique ivory buckles") == "not pangram"

programs_per_computational_model/0_declarative/arrays_and_strings/pangram.py

@@ -1,10 +1,10 @@
 """
-    abstract function to return subset of values
-    in interval [start_point, end_point]
+abstract function to return subset of values
+in interval [start_point, end_point]
 
-    members of values collection must have:
-        - well defined ordering
-            ∴ > , <, >=, >=, = definitions
+members of values collection must have:
+    - well defined ordering
+        ∴ > , <, >=, >=, = definitions
 """
 
 

programs_per_computational_model/0_declarative/arrays_and_strings/values_in_range.py

@@ -1,8 +1,9 @@
 def date_on_256th_day(year):
     def is_leap_year(year: int):
-        if((year % 400 == 0) or (year % 100 != 0) and (year % 4 == 0)):
+        if (year % 400 == 0) or (year % 100 != 0) and (year % 4 == 0):
             return True
-        else: return False
+        else:
+            return False
 
     def calculate_day(year):
         if is_leap_year(year):
@@ -14,7 +15,8 @@ def calculate_day(year):
 
     return f"{day}.09.{year}"
 
-#NB: incomplete
+
+# NB: incomplete
 print(date_on_256th_day(1800))
 """
 References:

programs_per_computational_model/0_declarative/numbers/256th_day_of_year.py

@@ -1,6 +1,6 @@
 """
-    Assumptions:
-        The string uses 128 ASCII character set
+Assumptions:
+    The string uses 128 ASCII character set
 """
 
 

programs_per_computational_model/3_stateful/arrays_and_strings/1.1.1.StringUniqueCharacters-Solution1.py

@@ -1,6 +1,6 @@
 """
-    Assumptions:
-        The string uses 128 ASCII character set
+Assumptions:
+    The string uses 128 ASCII character set
 """
 
 

programs_per_computational_model/3_stateful/arrays_and_strings/1.1.1.StringUniqueCharacters-Solution2.py

@@ -1,10 +1,10 @@
 """
-        For two strings to be permutations of each other, they must contain the same:
-            - characters 
-                    characters include all possible characters in Unicode char set (whitespace etc)
-            - number of characters
-        Constraints:
-            - case senstivity matters
+For two strings to be permutations of each other, they must contain the same:
+    - characters
+            characters include all possible characters in Unicode char set (whitespace etc)
+    - number of characters
+Constraints:
+    - case senstivity matters
 """
 
 

programs_per_computational_model/3_stateful/arrays_and_strings/1.1.2.StringPermutation-Solution1.py

@@ -1,12 +1,12 @@
 """
-        For two strings to be permutations of each other, they must contain the same:
-            - characters 
-                    characters include all possible characters in Unicode char set (whitespace etc)
-            - number of characters
-        Constraints:
-            - case senstivity matters
-        Assumptions:
-            - Strings will be ASCII encoded = 128 characters
+For two strings to be permutations of each other, they must contain the same:
+    - characters
+            characters include all possible characters in Unicode char set (whitespace etc)
+    - number of characters
+Constraints:
+    - case senstivity matters
+Assumptions:
+    - Strings will be ASCII encoded = 128 characters
 
 """