Update to newest QFR Submodule Version (#10)

* 🎨 add clang-format to QMAP
* 💚 adjusting code coverage statistics gathering
* ⬆️ update QFR submodule
* 🔖 bumping version number
* 🐛 fix MANIFEST.in
* 📄 updating license

Author: burgholzer

.clang-format

@@ -0,0 +1,82 @@
+# Generated from CLion C/C++ Code Style settings
+BasedOnStyle:                              LLVM
+AccessModifierOffset:                      -4
+AlignAfterOpenBracket:                     Align
+AlignConsecutiveAssignments:               Consecutive
+AlignConsecutiveDeclarations:              Consecutive
+AlignEscapedNewlines:                      Left
+AlignOperands:                             AlignAfterOperator
+AlignTrailingComments:                     true
+AllowAllArgumentsOnNextLine:               true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine:             Empty
+AllowShortCaseLabelsOnASingleLine:         true
+AllowShortEnumsOnASingleLine:              true
+AllowShortFunctionsOnASingleLine:          Inline
+AllowShortIfStatementsOnASingleLine:       WithoutElse
+AllowShortLambdasOnASingleLine:            All
+AllowShortLoopsOnASingleLine:              true
+AlwaysBreakAfterReturnType:                None
+AlwaysBreakTemplateDeclarations:           Yes
+BreakBeforeBraces:                         Custom
+BraceWrapping:
+  AfterCaseLabel:        false
+  AfterClass:            false
+  AfterControlStatement: Never
+  AfterEnum:             false
+  AfterFunction:         false
+  AfterNamespace:        false
+  AfterUnion:            false
+  BeforeCatch:           false
+  BeforeElse:            false
+  IndentBraces:          false
+  SplitEmptyFunction:    false
+  SplitEmptyRecord:      false
+BreakBeforeBinaryOperators:                None
+BreakBeforeTernaryOperators:               false
+BreakConstructorInitializers:              AfterColon
+BreakInheritanceList:                      AfterColon
+ColumnLimit:                               0
+CompactNamespaces:                         false
+ContinuationIndentWidth:                   8
+Cpp11BracedListStyle:                      true
+DeriveLineEnding:                          true
+EmptyLineBeforeAccessModifier:             LogicalBlock
+IncludeBlocks:                             Regroup
+IndentCaseBlocks:                          false
+IndentCaseLabels:                          true
+IndentPPDirectives:                        BeforeHash
+IndentWidth:                               4
+KeepEmptyLinesAtTheStartOfBlocks:          false
+Language:                                  Cpp
+MaxEmptyLinesToKeep:                       1
+NamespaceIndentation:                      All
+ObjCSpaceAfterProperty:                    false
+ObjCSpaceBeforeProtocolList:               true
+PointerAlignment:                          Left
+ReflowComments:                            false
+SortIncludes:                              true
+SpaceAfterCStyleCast:                      false
+SpaceAfterLogicalNot:                      false
+SpaceAfterTemplateKeyword:                 false
+SpaceBeforeAssignmentOperators:            true
+SpaceBeforeCaseColon:                      false
+SpaceBeforeCpp11BracedList:                false
+SpaceBeforeCtorInitializerColon:           false
+SpaceBeforeInheritanceColon:               false
+SpaceBeforeParens:                         ControlStatements
+SpaceBeforeRangeBasedForLoopColon:         false
+SpaceBeforeSquareBrackets:                 false
+SpaceInEmptyBlock:                         false
+SpaceInEmptyParentheses:                   false
+SpacesBeforeTrailingComments:              1
+SpacesInAngles:                            false
+SpacesInConditionalStatement:              false
+SpacesInCStyleCastParentheses:             false
+SpacesInContainerLiterals:                 false
+SpacesInParentheses:                       false
+SpacesInSquareBrackets:                    false
+Standard:                                  c++17
+TabWidth:                                  4
+UseTab:                                    Never

.github/codecov.yml

@@ -0,0 +1,16 @@
+ignore:
+  - "extern/**/*"
+  - "apps/*"
+  - "test/*.cpp"
+  - "jkq/**/*"
+
+coverage:
+  range:     60..90
+  precision: 1
+  status:
+    project:
+      default:
+        threshold: 0.5%
+    patch:
+      default:
+        threshold: 1%

.github/workflows/ci.yml

@@ -17,6 +17,18 @@ env:
   Z3_GIT_TAG: z3-4.8.10
 
 jobs:
+  codestyle:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: DoozyX/clang-format-lint-action@v0.12
+        with:
+          source:             'apps include src test jkq/qmap'
+          extensions:         'h,hpp,c,cpp'
+          clangFormatVersion: 12
+
   ubuntu-ci:
     runs-on: ubuntu-latest
 

.github/workflows/deploy.yml

@@ -11,14 +11,16 @@ on:
 
 env:
   CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
-  CIBW_BEFORE_ALL_LINUX: >
-     /opt/python/cp38-cp38/bin/python -m pip install z3-solver;
-  CIBW_ENVIRONMENT_LINUX: "LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/python/cp38-cp38/lib/python3.8/site-packages/z3/lib Z3_ROOT=/opt/python/cp38-cp38/lib/python3.8/site-packages/z3 Z3_DIR=/opt/python/cp38-cp38/lib/python3.8/site-packages/z3"
-  CIBW_BUILD: cp3?-*
-  CIBW_SKIP: "*-win32 *-manylinux_i686 cp35-*"
-  CIBW_BUILD_VERBOSITY: 3
-  CIBW_TEST_COMMAND: "python -c \"from jkq import qmap\""
-  Z3_GIT_TAG: z3-4.8.10
+  CIBW_BEFORE_ALL_LINUX:       >
+                               /opt/python/cp38-cp38/bin/python -m pip install z3-solver;
+  CIBW_ENVIRONMENT_LINUX:      "LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/python/cp38-cp38/lib/python3.8/site-packages/z3/lib Z3_ROOT=/opt/python/cp38-cp38/lib/python3.8/site-packages/z3 Z3_DIR=/opt/python/cp38-cp38/lib/python3.8/site-packages/z3"
+  CIBW_BUILD:                  cp3?-*
+  #  CIBW_ARCHS_MACOS:            "x86_64 arm64"
+  #  CIBW_TEST_SKIP:              "*_arm64"
+  CIBW_SKIP:                   "*-win32 *-manylinux_i686"
+  CIBW_BUILD_VERBOSITY:        3
+  CIBW_TEST_COMMAND:           "python -c \"from jkq import qmap\""
+  Z3_GIT_TAG:                  z3-4.8.10
 
 jobs:
   build_manylinux_wheels:
@@ -32,9 +34,9 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - name: Build wheels
-        uses: pypa/cibuildwheel@v1.11.1
+        uses: pypa/cibuildwheel@v2.1.1
       - uses: actions/upload-artifact@v2
         with:
           path: ./wheelhouse/*.whl
@@ -50,11 +52,11 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - name: Install Z3
         run:  brew install z3
       - name: Build wheels
-        uses: pypa/cibuildwheel@v1.11.1
+        uses: pypa/cibuildwheel@v2.1.1
       - uses: actions/upload-artifact@v2
         with:
           path: ./wheelhouse/*.whl
@@ -70,7 +72,7 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - uses: ilammy/msvc-dev-cmd@v1
       - name: Cache Z3
         id:   cache-z3
@@ -90,7 +92,7 @@ jobs:
         working-directory: ${{github.workspace}}/z3/build
         run: cmake --build . --config Release --target INSTALL;
       - name: Build wheels
-        uses: pypa/cibuildwheel@v1.11.1
+        uses: pypa/cibuildwheel@v2.1.1
       - uses: actions/upload-artifact@v2
         with:
           path: ./wheelhouse/*.whl
@@ -105,7 +107,7 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - name: Install Z3
         run: brew install z3
       - name: Build sdist

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.14...3.19)
 
 project(qmap
         LANGUAGES CXX
-        VERSION 1.3.2
+        VERSION 1.4.0
         DESCRIPTION "QMAP  - A JKQ library for mapping of quantum circuits to quantum architectures"
         )
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Alwin Zulehner, Stefan Hillmich, Lukas Burgholzer, Hartwig Bauer, Alexandru Paler, and Robert Wille
+Copyright (c) 2021 Alwin Zulehner, Stefan Hillmich, Lukas Burgholzer, Hartwig Bauer, Alexandru Paler, and Robert Wille
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -15,7 +15,6 @@ graft extern/qfr/src
 graft extern/qfr/include
 graft extern/qfr/jkq/qfr
 include extern/qfr/extern/dd_package/CMakeLists.txt
-graft extern/qfr/extern/dd_package/src
 graft extern/qfr/extern/dd_package/include
 graft extern/qfr/extern/json
 graft extern/qfr/extern/pybind11

apps/exact_app.cpp

@@ -3,15 +3,16 @@
  * See file README.md or go to https://iic.jku.at/eda/research/ibm_qx_mapping/ for more information.
  */
 
+#include "exact/ExactMapper.hpp"
+
+#include <boost/program_options.hpp>
 #include <iostream>
 #include <locale>
-#include <boost/program_options.hpp>
-
-#include "exact/ExactMapper.hpp"
 
 int main(int argc, char** argv) {
     namespace po = boost::program_options;
     po::options_description description("JKQ QMAP exact mapper by https://iic.jku.at/eda/quantum -- Options");
+    // clang-format off
     description.add_options()
             ("help,h", "produce help message")
             ("in", po::value<std::string>()->required(), "File to read from")
@@ -22,6 +23,7 @@ int main(int argc, char** argv) {
             ("ps", "print statistics")
             ("verbose", "Increase verbosity and output additional information to stderr")
             ;
+    // clang-format on
     po::variables_map vm;
     try {
         po::store(po::parse_command_line(argc, argv, description), vm);
@@ -30,63 +32,62 @@ int main(int argc, char** argv) {
             return 0;
         }
         po::notify(vm);
-    } catch (const po::error &e) {
+    } catch (const po::error& e) {
         std::cerr << "[ERROR] " << e.what() << "! Try option '--help' for available commandline options.\n";
         std::exit(1);
     }
 
-
-    const std::string circuit = vm["in"].as<std::string>();
-	qc::QuantumComputation qc{};
-	try {
-		qc.import(circuit);
-	} catch (std::exception const& e) {
-		std::stringstream ss{};
-		ss << "Could not import circuit: " << e.what();
-		std::cerr << ss.str() << std::endl;
-		std::exit(1);
-	}
+    const std::string      circuit = vm["in"].as<std::string>();
+    qc::QuantumComputation qc{};
+    try {
+        qc.import(circuit);
+    } catch (std::exception const& e) {
+        std::stringstream ss{};
+        ss << "Could not import circuit: " << e.what();
+        std::cerr << ss.str() << std::endl;
+        std::exit(1);
+    }
     const std::string cm = vm["arch"].as<std::string>();
-	Architecture arch{};
-	try {
-		arch.loadCouplingMap(cm);
-	} catch (std::exception const& e) {
-		std::stringstream ss{};
-		ss << "Could not import coupling map: " << e.what();
-		std::cerr << ss.str() << std::endl;
-		std::exit(1);
-	}
+    Architecture      arch{};
+    try {
+        arch.loadCouplingMap(cm);
+    } catch (std::exception const& e) {
+        std::stringstream ss{};
+        ss << "Could not import coupling map: " << e.what();
+        std::cerr << ss.str() << std::endl;
+        std::exit(1);
+    }
 
-	if (vm.count("calibration")) {
-		const std::string cal = vm["calibration"].as<std::string>();
-		try {
-			arch.loadCalibrationData(cal);
-		} catch (std::exception const& e) {
-			std::stringstream ss{};
-			ss << "Could not import calibration data: " << e.what();
-			std::cerr << ss.str() << std::endl;
-			std::exit(1);
-		}
-	}
+    if (vm.count("calibration")) {
+        const std::string cal = vm["calibration"].as<std::string>();
+        try {
+            arch.loadCalibrationData(cal);
+        } catch (std::exception const& e) {
+            std::stringstream ss{};
+            ss << "Could not import calibration data: " << e.what();
+            std::cerr << ss.str() << std::endl;
+            std::exit(1);
+        }
+    }
 
-	ExactMapper mapper(qc, arch);
+    ExactMapper mapper(qc, arch);
 
     MappingSettings ms{};
     ms.initialLayoutStrategy = InitialLayoutStrategy::None;
-	if (vm.count("layering")) {
-		std::string layering = vm["layering"].as<std::string>();
-		if (layering == "individual") {
-			ms.layeringStrategy = LayeringStrategy::IndividualGates;
-		} else if (layering == "disjoint") {
-			ms.layeringStrategy = LayeringStrategy::DisjointQubits;
-		} else if (layering == "odd") {
-			ms.layeringStrategy = LayeringStrategy::OddGates;
-		} else if (layering == "triangle") {
-			ms.layeringStrategy = LayeringStrategy::QubitTriangle;
-		} else {
-			ms.layeringStrategy = LayeringStrategy::None;
-		}
-	}
+    if (vm.count("layering")) {
+        std::string layering = vm["layering"].as<std::string>();
+        if (layering == "individual") {
+            ms.layeringStrategy = LayeringStrategy::IndividualGates;
+        } else if (layering == "disjoint") {
+            ms.layeringStrategy = LayeringStrategy::DisjointQubits;
+        } else if (layering == "odd") {
+            ms.layeringStrategy = LayeringStrategy::OddGates;
+        } else if (layering == "triangle") {
+            ms.layeringStrategy = LayeringStrategy::QubitTriangle;
+        } else {
+            ms.layeringStrategy = LayeringStrategy::None;
+        }
+    }
     ms.verbose = vm.count("verbose") > 0;
     mapper.map(ms);