Merge pull request #8 from Benezivas/develop

Develop

Author: Benezivas

.github/workflows/python-app.yml

@@ -1,7 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: Algorithmic Battle - Problem Files
+name: Algorithmic Battle
 
 on:
   push:
@@ -10,31 +7,61 @@ on:
     branches: [ main, develop ]
 
 jobs:
-  build:
-
+  lint:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.9
+    - name: Set up Python 3.6
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: 3.6
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install flake8 flake8-docstrings
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        git clone https://github.com/Benezivas/algobattle.git
-        cd algobattle && pip install . --user && cd ..
     - name: Lint with flake8
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --exit-zero --select=E9,F63,F7,F82 --show-source --statistics --exclude algobattle
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics \
-        --per-file-ignores="__init__.py:F401,D104 */solver/main.py:D100 */generator/main.py:D100" \
-        --docstring-convention numpy --ignore=D100,D105,D102,W503 --exclude algobattle
-    - name: Test with unittest
+        flake8 . --count --max-complexity=10  --max-line-length=127  \
+        --per-file-ignores="__init__.py:F401,D104 */solver_execution_error/main.py:E999 \
+        */generator_execution_error/main.py:E999 match.py:E221 setup.py:D102,D100 \
+        */verifier.py:D102 */parser.py:D102 tests/*:D102 tests/__init__.py:D104 \
+        scripts/battle:E501,C901" \
+        --docstring-convention numpy --show-source --statistics --ignore=D105,D401,W503
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.6
+    - name: Test using unittests
       run: |
+        git clone https://github.com/Benezivas/algobattle.git
+        cd algobattle && pip install . --user && cd ..
         python -m unittest
+
+  execute:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.6
+    - name: Install dependencies
+      run: |
+        git clone https://github.com/Benezivas/algobattle.git
+        cd algobattle && pip install . --user && cd ..
+    - name: Run short battles with different options as a sanity check
+      run: |
+        $HOME/.local/bin/battle problems/biclique --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/c4subgraphiso --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/clusterediting --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/domset --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/hikers --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/oscm3 --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/pairsum --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/pathpacking --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation
+        $HOME/.local/bin/battle problems/scheduling --verbose --iter_cap=10 --rounds=2 --no_overhead_calculation

.gitignore

@@ -1 +1,2 @@
 **/__pycache__
+.vscode/*

README.md

@@ -1,6 +1,17 @@
 # Algorithmic Battle: Problems
 Collection of problems to be used in the [algobattle](https://github.com/Benezivas/algobattle) project.
 
+This repository contains several problem tasks that you may use for your
+students. Each problem directory contains a `README.md` describing the problem
+and the I/O that the generator and solver use. The `generator` and `solver`
+directories contain dummy solvers that output instances which are technically
+legal, but rather unexiting.
+
+The simplest problem is currently the `pairsum` problem, which is well suited
+as a primer task at the start of the lab. For this task, a simple randomized generator and solver are 
+implemented which you may use to see how the program behaves when the
+solver runs into a timeout at some instance size.
+
 # Setup and Usage
 Clone the [algobattle](https://github.com/Benezivas/algobattle) repository:
 ```

problems/biclique/generator/main.py

@@ -1,12 +1,9 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-fout.write("e 1 2\n")
-fout.write("e 1 3\n")
-fout.write("e 1 4\n")
-fout.write("s set1 1\n")
-fout.write("s set2 2\n")
-fout.write("s set2 3\n")
-fout.write("s set2 4\n")
-fout.close()
+"""Simple dummy generator for the BiClique problem, outputting a static instance."""
+with open("output", "w") as output:
+    output.write("e 1 2\n")
+    output.write("e 1 3\n")
+    output.write("e 1 4\n")
+    output.write("s set1 1\n")
+    output.write("s set2 2\n")
+    output.write("s set2 3\n")
+    output.write("s set2 4\n")

problems/biclique/problem.py

@@ -1,3 +1,4 @@
+"""The Biclique problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/biclique/solver/main.py

@@ -1,9 +1,6 @@
-fin = open("input")
-line = fin.readline()
-
-fout = open("output", "w")
-fout.write("s set1 1\n")
-fout.write("s set2 2\n")
-fout.write("s set2 3\n")
-fout.write("s set2 4\n")
-fout.close()
+"""Simple dummy solver for the BiClique problem, outputting a static solution."""
+with open("output", "w") as output:
+    output.write("s set1 1\n")
+    output.write("s set2 2\n")
+    output.write("s set2 3\n")
+    output.write("s set2 4\n")

problems/c4subgraphiso/generator/main.py

@@ -1,10 +1,7 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-fout.write("s 1 2 3 4\n")
-fout.write("e 4 1\n")
-fout.write("e 1 2\n")
-fout.write("e 2 3\n")
-fout.write("e 3 4\n")
-fout.close()
+"""Simple dummy generator for the C4SubGraphIso problem, outputting a static instance."""
+with open("output", "w") as output:
+    output.write("s 1 2 3 4\n")
+    output.write("e 4 1\n")
+    output.write("e 1 2\n")
+    output.write("e 2 3\n")
+    output.write("e 3 4\n")

problems/c4subgraphiso/problem.py

@@ -1,3 +1,4 @@
+"""The C4subgraphiso problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/c4subgraphiso/solver/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-line = fin.readline()
-
-fout = open("output", "w")
-fout.write("s 1 2 3 4\n")
-fout.close()
+"""Simple dummy solver for the C4SubGraphIso problem, outputting a static solution."""
+with open("output", "w") as output:
+    output.write("s 1 2 3 4\n")

problems/c4subgraphiso/verifier.py

@@ -24,6 +24,20 @@ def verify_semantics_of_solution(self, solution, instance_size: int, solution_ty
         return True
 
     def square_in_instance(self, square, instance):
+        """Check if a given square is part of the given instance.
+
+        Parameters
+        ----------
+        square : tuple
+            A tuple of the form (i,j,k,l) which are sequentially connected to form a square.
+        instance : list
+            A list of tuples of edges, each edge {i, j} is given as ('e', 'i', 'j').
+
+        Returns
+        -------
+        bool
+            True if the square is part of the instance, False otherwise.
+        """
         if (not (('e', square[0], square[1]) in instance or ('e', square[1], square[0]) in instance)
                 or not (('e', square[1], square[2]) in instance or ('e', square[2], square[1]) in instance)
                 or not (('e', square[2], square[3]) in instance or ('e', square[3], square[2]) in instance)

problems/clusterediting/generator/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-fout.write("e 1 2\ne 3 2\ne 1 4\ns del 1 4\ns add 1 3")
-fout.close()
+"""Simple dummy generator for the ClusterEditing problem, outputting a static instance."""
+with open("output", "w") as output:
+    output.write("e 1 2\ne 3 2\ne 1 4\ns del 1 4\ns add 1 3")

problems/clusterediting/problem.py

@@ -1,3 +1,4 @@
+"""The Clusterediting problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/clusterediting/solver/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-line = fin.readline()
-
-fout = open("output", "w")
-fout.write("s add 1 3\ns del 1 4")
-fout.close()
+"""Simple dummy solver for the ClusterEditing problem, outputting a static solution."""
+with open("output", "w") as output:
+    output.write("s add 1 3\ns del 1 4")

problems/domset/generator/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-fout.write("s 1\ns 4\ne 1 2\ne 2 3\ne 3 4\ne 4 5\ne 5 6\ne 6 1\ne 2 6\ne 3 5")
-fout.close()
+"""Simple dummy generator for the DomSet problem, outputting a static instance."""
+with open("output", "w") as output:
+    output.write("s 1\ns 4\ne 1 2\ne 2 3\ne 3 4\ne 4 5\ne 5 6\ne 6 1\ne 2 6\ne 3 5")

problems/domset/problem.py

@@ -1,3 +1,4 @@
+"""The DomSet problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/domset/solver/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-line = fin.readline()
-
-fout = open("output", "w")
-fout.write("s 1\ns 4")
-fout.close()
+"""Simple dummy solver for the DomSet problem, outputting a static solution."""
+with open("output", "w") as output:
+    output.write("s 1\ns 4")

problems/hikers/generator/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-fout.write("s 1 1\ns 4 1\ns 5 1\ns 3 2\nh 1 1 3\nh 2 10 12\nh 3 1 1\nh 4 2 5\nh 5 3 3")
-fout.close()
+"""Simple dummy generator for the Hikers problem, outputting a static instance."""
+with open("output", "w") as output:
+    output.write("s 1 1\ns 4 1\ns 5 1\ns 3 2\nh 1 1 3\nh 2 10 12\nh 3 1 1\nh 4 2 5\nh 5 3 3")

problems/hikers/problem.py

@@ -1,3 +1,4 @@
+"""The Hikers problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/hikers/solver/main.py

@@ -1,6 +1,3 @@
-fin = open("input")
-line = fin.readline()
-
-fout = open("output", "w")
-fout.write("s 3 1\ns 1 2\ns 4 2\ns 5 2")
-fout.close()
+"""Simple dummy solver for the Hikers problem, outputting a static solution."""
+with open("output", "w") as output:
+    output.write("s 3 1\ns 1 2\ns 4 2\ns 5 2")

problems/oscm3/generator/main.py

@@ -1,10 +1,10 @@
-fin = open("input")
-fout = open("output", "w")
-n = int(fin.readline())
-
-for i in range(n):
-    fout.write("n {}\n".format(i))
-fout.write("s ")
-for i in range(n):
-    fout.write("{} ".format(i))
-fout.close()
+"""Simple dummy generator for the OSCM3 problem, outputting a trivial instance."""
+n = 0
+with open("input", "r") as input:
+    n = int(input.readline())
+with open("output", "w") as output:
+    for i in range(n):
+        output.write("n {}\n".format(i))
+    output.write("s ")
+    for i in range(n):
+        output.write("{} ".format(i))

problems/oscm3/parser.py

@@ -22,6 +22,21 @@ def split_into_instance_and_solution(self, raw_input):
         return raw_instance, raw_solution
 
     def is_instance_line_clean(self, line, instance_size):
+        """Checks whether a given line of the instance is of the required form.
+
+        Parameters
+        ----------
+        line : tuple
+            The line to be checked. Expected to be of the form ('n', 'i', 'j', 'k', 'l')
+            where the last three entries are optional. Consult the README for more information.
+        instance_size : int
+            The size of the instance.
+
+        Returns
+        -------
+        bool
+            True if the line is well-formatted, False otherwise.
+        """
         clean = True
         included_nodes = set()
         for entry in line[2:]:

problems/oscm3/problem.py

@@ -1,3 +1,4 @@
+"""The OSCM3 problem class."""
 import logging
 
 from algobattle.problem import Problem

problems/oscm3/solver/main.py

@@ -1,11 +1,11 @@
-with open("input") as fin:
-    lines = []
-    for line in fin:
+"""Simple dummy solver for the OSCM3 problem, outputting a trivial solution."""
+lines = []
+with open("input", "r") as input:
+    for line in input:
         lines.append(line)
 n = len(lines)
 
-fout = open("output", "w")
-fout.write("s ")
-for i in range(n):
-    fout.write("{} ".format(i))
-fout.close()
+with open("output", "w") as output:
+    output.write("s ")
+    for i in range(n):
+        output.write("{} ".format(i))