chore: add nim_test.yml (#20)

* style: format code with nimpretty

* fix: remove some errors

* fix: follow spellSuggest

* chore: add check_all_nim_files.sh

* chore: add `nim_test.yml`

* fix: use proper branch name

* chore: use `config.nims`

* chore: remove unused shell scripts

* chore: do not use `--gc: arc`

* chore: add `nim_test_cyclic.yml`

* chore: move --gc: arc to nim.cfg

* style: add missing blank line at the end

* chore: add `macos-latest` and `windows-latest`

Author: vil02

.github/workflows/nim_test.yml

@@ -0,0 +1,35 @@
+---
+name: nim_test
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  nim_test:
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        nim-version:
+          - '1.6.12'
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: jiro4989/setup-nim-action@v1
+        with:
+          nim-version: ${{matrix.nim-version}}
+
+      - name: Build and test
+        run: |
+          nim test
+...

.github/workflows/nim_test_cyclic.yml

@@ -0,0 +1,36 @@
+---
+name: nim_test_cyclic
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '3 1 * * 1'
+
+jobs:
+  nim_test:
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        nim-version:
+          - 'stable'
+          - 'devel'
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: jiro4989/setup-nim-action@v1
+        with:
+          nim-version: ${{matrix.nim-version}}
+
+      - name: Display nim version
+        run: |
+          nim --version
+
+      - name: Build and test
+        run: |
+          nim test
+...

config.nims

@@ -1,5 +1,3 @@
-# Nim compilation defaults for the whole repository
-#--gc: arc
 if defined(release) or defined(danger):
   --opt: speed
   --passC: "-flto"

dynamic_programming/catalan_numbers.nim

@@ -1,6 +1,6 @@
 # Catalan Numbers
-#[  
-    The Catalan numbers are a sequence of natural numbers that occur in the 
+#[
+    The Catalan numbers are a sequence of natural numbers that occur in the
     most large set of combinatorial problems.
     For example, it describes:
     - the number of ways to parenthesize a product of n factors
@@ -79,10 +79,11 @@ when isMainModule:
   const LowerLimit = 30 # The formulas involving a division overflows above 30
   const UpperLimit = 36 # Other methods overflow above 36
 
-  let expectedResult: seq[Positive] = @[1, 1, 2, 5, 14, 42, 132, 429,
+  let expectedResult: seq[Positive] = @[Positive(1), 1, 2, 5, 14, 42, 132, 429,
                                         1430, 4862, 16796, 58786, 208012,
                                         742900, 2674440, 9694845]
-  const CatalanNumbersList = [1, 1, 2, 5, 14, 42, 132, 429, 1430, 4862, 16796,
+  const CatalanNumbersList: seq[Positive] = @[Positive(1), 1, 2, 5, 14, 42, 132,
+      429, 1430, 4862, 16796,
     58786, 208012, 742900, 2674440, 9694845, 35357670, 129644790, 477638700,
     1767263190, 6564120420, 24466267020, 91482563640, 343059613650,
     1289904147324, 4861946401452, 18367353072152, 69533550916004,
@@ -113,7 +114,7 @@ when isMainModule:
     test "We can compute up to the thirty-seventh Catalan number iteratively":
       let limit = UpperLimit
       let catalanNumbersSeq = catalanNumbers(limit)
-      for index in 0 .. limit:
+      for index in 0 ..< limit:
         check catalanNumbersSeq[index] == CatalanNumbersList[index]
 
     test "The thirty-seventh first Catalan numbers with iterator":

dynamic_programming/viterbi.nim

@@ -30,36 +30,36 @@ func viterbi*[S, O](hmm: HiddenMarkovModel[S], observations: seq[O]): seq[S] =
     for state in 0 ..< len(hmm.states):
       # Compute the argmax for probability of the current state
       var
-        max_prob = -1.0
-        max_prob_state = 0
-      for prior_state in 0 ..< len(hmm.states):
+        maxProb = -1.0
+        maxProbState = 0
+      for priorState in 0 ..< len(hmm.states):
         var
-          prob = probabilities[nObs - 1][prior_state] *
-          hmm.transitionProbability[prior_state][state] *
+          prob = probabilities[nObs - 1][priorState] *
+          hmm.transitionProbability[priorState][state] *
           hmm.emissionProbability[state][obs]
-        if prob > max_prob:
-          max_prob = prob
-          max_prob_state = prior_state
+        if prob > maxProb:
+          maxProb = prob
+          maxProbState = priorState
       # Update probabilities and backpointers
-      probabilities[nObs][state] = max_prob
-      backpointers[nObs][state] = max_prob_state
+      probabilities[nObs][state] = maxProb
+      backpointers[nObs][state] = maxProbState
 
   # Final observation
   var
-    max_prob = -1.0
-    max_prob_state = 0
+    maxProb = -1.0
+    maxProbState = 0
   for state in 0 ..< len(hmm.states):
-    if probabilities[len(observations) - 1][state] > max_prob:
-      max_prob = probabilities[len(observations) - 1][state]
-      max_prob_state = state
+    if probabilities[len(observations) - 1][state] > maxProb:
+      maxProb = probabilities[len(observations) - 1][state]
+      maxProbState = state
 
   result = newSeq[S](len(observations))
-  result[^1] = hmm.states[max_prob_state]
+  result[^1] = hmm.states[maxProbState]
 
   # Backward Pass - Derive the states from the probabilities
   for i in 1 ..< len(observations):
-    result[^(i+1)] = hmm.states[backpointers[^i][max_prob_state]]
-    max_prob_state = backpointers[^i][max_prob_state]
+    result[^(i+1)] = hmm.states[backpointers[^i][maxProbState]]
+    maxProbState = backpointers[^i][maxProbState]
 
 when isMainModule:
   import std/unittest

nim.cfg

@@ -0,0 +1,2 @@
+# Nim compilation defaults for the whole repository
+--gc: arc