Conditional statements (#178)

* Initial stab at conditionals

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Removed trailing whitespaces in qasm files

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Changed qasm IfStmt to use cond_if

* Conditionals now work. Small changes to execute and QCircuitIterator.

* fix QBaseEngine

* fix to execute_circuit_steps_once_, all unit tests pass.

* made iterator_type a value, not a reference

* formatting

* removed LOGs

* Update qengine.hpp

* Fix to conditionals, added conditionals to pyqpp.

* made measured_d_ a stack in qcircuit.hpp

* formatting

* Update qcircuit.hpp

* Update qcircuit_conditional_step.hpp

* Added WHILE and ENDWHILE, extra exception checks

* minor update

* Update qpp.hpp

* Changes to QCircuitConditionalStep

* while_pos_ to outer_while_pos_

* updated (c) notice

Updated (c) notice

* update

* Added conditional_if/while examples

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Preparing for Version 6.0

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Updated README.md

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Minor update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Fixed typo

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Added Windows CI

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Member var zero-init

Signed-off-by: Vlad Gheorghiu <[email protected]>

* fixing Windows CI

Signed-off-by: Vlad Gheorghiu <[email protected]>

* fixing Windows CI

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Finished fixing Windows CI

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Minor stylystic updates to pyqpp

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Spacing

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Minor stylistic update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Updated CODE_OF_CONDUCT.md

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Fix

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Yet more fixes, all tests pass

Signed-off-by: Vlad Gheorghiu <[email protected]>

* More fixes

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Preparing v6.0

Signed-off-by: Vlad Gheorghiu <[email protected]>

* typo

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Preparing for v6.0

Signed-off-by: Vlad Gheorghiu <[email protected]>

* Update qbase_engine.hpp

* Version 6.0

Signed-off-by: Vlad Gheorghiu <[email protected]>

---------

Signed-off-by: Vlad Gheorghiu <[email protected]>
Co-authored-by: a3moses <[email protected]>

Author: vsoftco

.github/workflows/cmake.yml

@@ -13,8 +13,7 @@ jobs:
   build:
     strategy:
       matrix:
-        # os: [ubuntu-latest, macos-latest, windows-latest]
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -70,7 +69,7 @@ jobs:
         run: |
           python3 -mvenv venv
           if [ "$RUNNER_OS" == "Windows" ]; then
-            venv\Scripts\Activate
+            venv/Scripts/Activate
           else
             source venv/bin/activate
           fi

.gitignore

@@ -74,3 +74,4 @@ cmake_install.cmake
 CMakeCache.txt
 CMakeFiles/
 pyqpp.egg-info/
+/uv.lock

CHANGES.md

@@ -1,4 +1,4 @@
-# Pre-release
+# Version 6.0 - 14 April 2025
 
 - Breaking change: renamed ["qpp/qpp.h"] to ["qpp/qpp.hpp"]
 - New feature: implemented support for post-selection in
@@ -22,6 +22,22 @@
 - Added
   [["examples/circuits/post_selection.cpp"](https://github.com/softwareQinc/qpp/blob/main/examples/circuits/post_selection.cpp)]
   example
+- New feature: implemented support for conditional statements in
+  ["qpp/classes/qcircuit.hpp"]
+- Implemented `qpp::QCircuit::`
+  - `QCircuit& cond_if()` - conditional IF statement
+  - `QCircuit& cond_else()` - conditional ELSE statement
+  - `QCircuit& cond_while()` - conditional WHILE statement
+  - `QCircuit& cond_end()` - conditional END block delimiter
+  - `bool has_conditionals() const noexcept` - true if and only if the circuit contains
+    conditional statements
+  - `bool validate_conditionals() const` - true if an only if the conditional
+    statements are valid (e.g., matching `cond_end()` to `cond_if()` etc.
+- Added
+  [["examples/circuits/conditional_if.cpp"](https://github.com/softwareQinc/qpp/blob/main/examples/circuits/conditional_if.cpp)]
+  and
+  [["examples/circuits/conditional_while.cpp"](https://github.com/softwareQinc/qpp/blob/main/examples/circuits/conditional_while.cpp)]
+  examples
 - Refactored `qpp::QCircuit::GateStep/MeasurementStep/NOPStep` into separate
   files ["qpp/internal/classes/qcircuit_gate_step.hpp"],
   ["qpp/internal/classes/qcircuit_measurement_step.hpp"], and
@@ -43,13 +59,17 @@
   - `qpp::QEngineT<>::get_non_measured()` ->
     `qpp::QEngineT<>::get_non_measured_d()`
   - `qpp::QEngineT<>::was_measured()` -> `qpp::QEngineT<>::was_measured_d()`
-- Bugfix in qpp::internal::canonical_form(), the re-ordering is now stable, so
-  qpp::QCircuit measurement probabilities are not displayed in reversed order
-  w.r.t. target
+- Bugfix in `qpp::internal::canonical_form()`, the re-ordering is now stable,
+  so `qpp::QCircuit` measurement probabilities are not displayed in reversed
+  order w.r.t. target
 - Simplified MATLAB detection via CMake `find_package()` function. Users should
   only use `-DQPP_MATLAB=ON` when building with MATLAB support, all other
   MATLAB-related CMake flags have been removed.
-- Added `read_from_string` to `qasm.hpp` and an associated pyqpp wrapper
+- Bugfix in `qpp::adjoint(QCircuit)`
+- Added `cond_func_t` type alias in ["qpp/types.hpp"] for boolean predicates of
+  the form `std::vector<idx> -> bool`
+- Added `qpp::read_from_string()` to ["qpp/qasm/qasm.hpp"] and an associated
+  pyqpp wrapper function
 
 # Version 5.1 - 1 March 2024
 

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15)
-set(QPP_VERSION_NUM 5.1)
+set(QPP_VERSION_NUM 6.0)
 set(QPP_VERSION_STR "${QPP_VERSION_NUM}")
 project(
   qpp
@@ -105,8 +105,10 @@ install(FILES "${CMAKE_SOURCE_DIR}/cmake/qpp_MATLAB.cmake"
 
 # Uninstall
 # https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
-# UNIX/Linux: sudo cmake --build build --target uninstall Windows:    cmake
-# --build build --target uninstall
+#
+# UNIX/Linux: sudo cmake --build build --target uninstall
+
+# Windows: cmake --build build --target uninstall
 if(NOT TARGET uninstall)
   configure_file(
     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/qpp_uninstall.cmake.in"

CODE_OF_CONDUCT.md

@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual identity
-and orientation.
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -22,17 +22,17 @@ community include:
 - Giving and gracefully accepting constructive feedback
 - Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 - Trolling, insulting or derogatory comments, and personal or political attacks
 - Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 - Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
@@ -52,7 +52,7 @@ decisions when appropriate.
 
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
+Examples of representing our community include using an official email address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
@@ -81,15 +81,15 @@ behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
@@ -108,24 +108,24 @@ Violating these terms may lead to a permanent ban.
 standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
 Community Impact Guidelines were inspired by
 [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
-at [https://www.contributor-covenant.org/translations][translations].
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org
-[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = Quantum++
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v5.1
+PROJECT_NUMBER         = v6.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 - 2024 softwareQ Inc. All rights reserved.
+Copyright (c) 2017 - 2025 softwareQ Inc. All rights reserved.
 
 MIT License
 

README.md

@@ -1,6 +1,6 @@
 # Quantum++
 
-## Version 5.1 - 1 March 2024
+## Version 6.0 - 14 April 2025
 
 [![GitHub actions](https://github.com/softwareqinc/qpp/actions/workflows/cmake.yml/badge.svg)](https://github.com/softwareQinc/qpp/actions)
 
@@ -19,10 +19,7 @@ multiprocessing library.
 information processing tasks, being capable of simulating arbitrary quantum
 processes. The main design factors taken in consideration were the ease of use,
 high portability, and high performance. The library's simulation capabilities
-are only restricted by the amount of available physical memory. On a typical
-machine (Intel i5 8Gb RAM) **Quantum++** can successfully simulate the
-evolution of 25 qubits in a pure state or of 12 qubits in a mixed state
-reasonably fast.
+are only restricted by the amount of available physical memory.
 
 To report any bugs or ask for additional features/enhancements, please
 [submit an issue](https://github.com/softwareQinc/qpp/issues) with an
@@ -43,7 +40,7 @@ see <https://eigen.tuxfamily.org/dox/>. For a simple
 [Eigen 3](https://eigen.tuxfamily.org) quick ASCII reference see
 <https://eigen.tuxfamily.org/dox/AsciiQuickReference.txt>.
 
-Copyright (c) 2017 - 2024 softwareQ Inc. All rights reserved.
+Copyright (c) 2017 - 2025 softwareQ Inc. All rights reserved.
 
 ---
 

VERSION.txt

@@ -1 +1 @@
-Version 5.1 - 1 March 2024
+Version 6.0 - 14 April 2025

cmake/qpp_dependencies.cmake

@@ -1,5 +1,5 @@
-# Quantum++ additional dependencies Do not modify unless you know what you're
-# doing
+# Quantum++ additional dependencies
+# Do not modify unless you know what you're doing
 
 # Custom index type. If none selected, a default one is selected by
 # include/types.hpp (usually std::size_t).
@@ -112,7 +112,7 @@ if(${QPP_OPENMP})
   find_package(OpenMP)
   if(OpenMP_CXX_FOUND)
     if(OpenMP_CXX_VERSION_MAJOR GREATER_EQUAL 3)
-      # inject definition (as #define) in the source files
+      # Inject definition (as #define) in the source files
       add_compile_definitions(QPP_OPENMP)
       # OpenMP linking dependencies to be injected in the main CMakeLists.txt
       set(QPP_OPENMP_LINK_DEPS OpenMP::OpenMP_CXX)
@@ -123,18 +123,20 @@ requires OpenMP 3.0 or later")
   endif()
 endif()
 
-# Disable support for thread_local storage duration specifier when using
-# AppleClang as libc++ doesn't yet support it if (${CMAKE_CXX_COMPILER_ID}
-# STREQUAL "AppleClang") #### inject definition (as #define) in the source files
-# add_definitions(-DNO_THREAD_LOCAL_) message(WARNING "Detected compiler:
-# ${CMAKE_CXX_COMPILER_ID} \ ${CMAKE_CXX_COMPILER_VERSION}. thread_local not
-# supported.") endif ()
+# # Disable support for thread_local storage duration specifier when using
+# # AppleClang as libc++ doesn't yet support it
+# if (${CMAKE_CXX_COMPILER_ID} STREQUAL "AppleClang")
+#   # Inject definition (as #define) in the source files
+#   add_definitions(-DNO_THREAD_LOCAL_)
+#   message(WARNING "Detected compiler:  ${CMAKE_CXX_COMPILER_ID} \
+#   ${CMAKE_CXX_COMPILER_VERSION}. thread_local not # supported.") 
+# endif ()
 
 # Windows issues with Microsoft Visual Studio
 if(MSVC)
   # Disable spurious Eigen warnings with MSVC (warning STL4007)
   add_compile_definitions(_SILENCE_CXX17_ADAPTOR_TYPEDEFS_DEPRECATION_WARNING)
-  add_compile_options(-bigobj)
+  add_compile_options(/bigobj)
 endif()
 
 # MinGW or Cygwin have issues with object files that are too large
@@ -154,11 +156,12 @@ endif()
 
 # GCC additional debug settings
 if(${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
-  # if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") ## use the "no-weak" debugging
-  # flag only when debugging under OS X, ## as gdb cannot step in template
-  # functions when debugging code ## produced by g++ ## see
-  # https://stackoverflow.com/questions/23330641/gnu-gdb-can-not-step-into-template-functions-os-x-mavericks
-  # set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fno-weak") endif ()
+  # if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+  #   # Use the "no-weak" debugging flag only when debugging under OS X, as gdb
+  #   # cannot step in template functions when debugging code produced by g++, see
+  #   # https://stackoverflow.com/questions/23330641/gnu-gdb-can-not-step-into-template-functions-os-x-mavericks
+  #   set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fno-weak")
+  # endif ()
   set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Og -D_GLIBCXX_DEBUG")
 endif()