A modern C++ quantum computing library
Quantum++ is a modern C++ general purpose quantum computing library, composed solely of template header files. Quantum++ is written in standard C++17 and has very low external dependencies, using only the Eigen 3 linear algebra header-only template library and, if available, the OpenMP multi-processing library.
Quantum++ is not restricted to qubit systems or specific quantum 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.
To report any bugs or ask for additional features/enhancements, please submit an issue with an appropriate label.
If you are interested in contributing to this project, feel free to contact us. Alternatively, fork the repository, create a custom branch, add your contribution, then finally create a pull request. If we accept the pull request, we will merge your custom branch with the latest main/development branch. The latter will eventually be merged into a future release version. To contribute, it is preferable to have a solid knowledge of modern C++ (preferably C++17 or later), including templates and the standard library, a basic knowledge of quantum computing and linear algebra, and working experience with Eigen 3.
For additional Eigen 3 documentation see http://eigen.tuxfamily.org/dox/. For a simple Eigen 3 quick ASCII reference see http://eigen.tuxfamily.org/dox/AsciiQuickReference.txt.
Copyright (c) 2013 - 2022 softwareQ Inc. All rights reserved.
Quantum++ is distributed under the MIT license. Please see the
Doxyfilefile. The tool
Graphvizpackage must be installed (
sudo apt-get install graphvizon Ubuntu/Debian Linux, or
brew install graphvizon macOS). Running
doxygenwill generate the documentation directory
doccontaining both the HTML and LaTeX documentation.
The HTML documentation file will be accessible by opening
doc/html/index.htmlwith the browser of your choice. To generate a PDF file of the documentation, run
latexmk -pdf refman.tex
doc/latexdirectory or compile the file
doc/latex/refman.texwith your LaTeX compiler. This will create the
doc/latex/refman.pdfdocumentation file. Consult your favourite LaTeX manual for how to compile/build LaTeX files under your specific operating system.
pyqpp is a Python wrapper for Quantum++. pyqpp can be installed using
pip install git+https://github.com/softwareQinc/qppFor more details, please see pyqpp/README.md.