feat: implement iterative hypercomplex multiplication (#52)

Author: AngryMaciek

.github/workflows/docs.yml

@@ -1,14 +1,11 @@
 name: docs
 
-on:
-  push:
-    branches:
-      - master
+on: [push]
 
 jobs:
 
   gh-pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     env:
       test-directory: .test/docs
 

.github/workflows/draft-pdf.yml

@@ -5,7 +5,7 @@ on: [push]
 jobs:
 
   paper:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     name: Paper Draft
 
     steps:

.github/workflows/include.yml

@@ -1,19 +1,13 @@
 name: Include
 
-on:
-  push:
-    branches:
-      - "*"
-  pull_request:
-    branches:
-      - master
+on: [push]
 
 jobs:
   Include:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-12, ubuntu-20.04]
+        os: [macos-12, ubuntu-22.04]
     env:
       working-directory: .test/include
 

.github/workflows/install.yml

@@ -1,19 +1,13 @@
 name: Install
 
-on:
-  push:
-    branches:
-      - "*"
-  pull_request:
-    branches:
-      - master
+on: [push]
 
 jobs:
   Install:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-12, ubuntu-20.04]
+        os: [macos-12, ubuntu-22.04]
     env:
       test-directory: .test/install
       lib-directory: "hypercomplex"

.github/workflows/lint.yml

@@ -1,16 +1,10 @@
 name: cpplint
 
-on:
-  push:
-    branches:
-      - "*"
-  pull_request:
-    branches:
-      - master
+on: [push]
 
 jobs:
   cpplint:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
 

.github/workflows/unit.yml

@@ -1,20 +1,14 @@
 name: Catch2
 
-on:
-  push:
-    branches:
-      - "*"
-  pull_request:
-    branches:
-      - master
+on: [push]
 
 jobs:
 
   platform-compatibility:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-12, ubuntu-20.04]
+        os: [macos-12, ubuntu-22.04]
       fail-fast: false
     env:
       working-directory: .test/unit
@@ -47,10 +41,10 @@ jobs:
 
       - name: Execute Test Program
         working-directory: ${{env.working-directory}}
-        run: ./test ~[local] -d yes -w NoAssertions --use-colour yes --benchmark-samples 100 --benchmark-resamples 100000
+        run: ./test -d yes -w NoAssertions --use-colour yes --benchmark-samples 100 --benchmark-resamples 100000
 
   code-coverage:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     env:
       working-directory: .test/unit
 
@@ -72,15 +66,15 @@ jobs:
         run: cp -r ../../hypercomplex hypercomplex
 
       - name: Display compiler version
-        run: g++ --version
+        run: clang++ --version
 
       - name: Compile Test Program
         working-directory: ${{env.working-directory}}
-        run: g++ -O0 -fprofile-arcs -ftest-coverage -Wall --std=c++17 --coverage -o test test.cpp -lmpfr -lgmp
+        run: g++ -O0 -fprofile-arcs -ftest-coverage -fno-elide-constructors -Wall --std=c++17 --coverage -o test test.cpp -lmpfr -lgmp
 
       - name: Execute Test Program
         working-directory: ${{env.working-directory}}
-        run: ./test ~[local]
+        run: ./test
 
       - name: Generate Coverage Report
         working-directory: ${{env.working-directory}}
@@ -98,7 +92,7 @@ jobs:
           verbose: true
 
   memcheck:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     env:
       working-directory: .test/unit
 
@@ -129,6 +123,6 @@ jobs:
       - name: Analyze Test Program Execution
         working-directory: ${{env.working-directory}}
         run: |
-          valgrind --leak-check=full --show-leak-kinds=all --track-origins=yes --verbose --log-file=valgrind.txt ./test ~[local]
+          valgrind --leak-check=full --show-leak-kinds=all --track-origins=yes --verbose --log-file=valgrind.txt ./test ~[benchmark]
           cat valgrind.txt
           grep -q -w "All heap blocks were freed -- no leaks are possible" "valgrind.txt"

.gitpod.dockerfile

@@ -9,7 +9,8 @@ FROM ubuntu:latest
 #   workspace user (`gitpod`) is non-root and won't be able to install
 #   and use `sudo` to install any other tools in a live workspace.
 RUN apt-get update && apt-get install -yq \
-    git git-lfs sudo g++ make libmpfr-dev \
+    git git-lfs sudo g++ make valgrind libmpfr-dev python3 python3-pip doxygen \
+    && pip install cpplint \
     && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/*
 
 # Create the gitpod user. UID must be 33333.

.test/docs/test.cpp

@@ -86,6 +86,7 @@ int main(void){
     const unsigned int fig1a_MaxDeg = 6; // N = 7
     const int64_t fig1a_p = 2;
     const int64_t fig1a_q = 1151;
+    Hypercomplex<Polynomial<fig1a_MaxDeg>, fig1a_dim>::init();
     // Public Key
     Polynomial<fig1a_MaxDeg> F1a_coefficients[fig1a_dim];
     F1a_coefficients[1][0] = 0;
@@ -218,13 +219,15 @@ int main(void){
     );
     CenteredLift(&M1a, fig1a_p);
     assert( D1a == M1a );
+    Hypercomplex<Polynomial<fig1a_MaxDeg>, fig1a_dim>::clear();
     //
     // PUBLICATION: QR code
     //
     const unsigned int fig1b_dim = 32;
     const unsigned int fig1b_MaxDeg = 28; // N = 29
     const int64_t fig1b_p = 3;
     const int64_t fig1b_q = 1723;
+    Hypercomplex<Polynomial<fig1b_MaxDeg>, fig1b_dim>::init();
     // Public Key
     Polynomial<fig1b_MaxDeg> F1b_coefficients[fig1b_dim];
     F1b_coefficients[1][0] = 1;
@@ -311,13 +314,15 @@ int main(void){
     );
     CenteredLift(&M1b, fig1b_p);
     assert( D1b == M1b );
+    Hypercomplex<Polynomial<fig1b_MaxDeg>, fig1b_dim>::clear();
     //
     // PUBLICATION: MEME
     //
     const unsigned int fig1c_dim = 128;
     const unsigned int fig1c_MaxDeg = 126; // N = 127
     const int64_t fig1c_p = 17;
     const int64_t fig1c_q = 16777213;
+    Hypercomplex<Polynomial<fig1c_MaxDeg>, fig1c_dim>::init();
     // Public Key
     Polynomial<fig1c_MaxDeg> F1c_coefficients[fig1c_dim];
     F1c_coefficients[1][0] = 1;
@@ -350,7 +355,6 @@ int main(void){
         F1c, G1c, fig1c_q
     );
     // Encryption
-    int64_t nyanarr[fig1c_dim][fig1c_MaxDeg+1];
     Polynomial<fig1c_MaxDeg> M1c_coefficients[fig1c_dim];
     std::ifstream inputfile("nyan.txt");    
     for (unsigned int i=0; i < fig1c_dim; i++) {
@@ -381,6 +385,7 @@ int main(void){
     );
     CenteredLift(&M1c, fig1c_p);
     assert( D1c == M1c );
+    Hypercomplex<Polynomial<fig1c_MaxDeg>, fig1c_dim>::clear();
     //
     return 0;
 }