Version 2.6 - 9 January 2021
Quantum++ is a modern C++11 general purpose quantum computing library, composed solely of template header files. Quantum++ is written in standard C++11 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 interesting in contributing to this project, feel free to contact me. Alternatively, fork the repository, add your contribution, then finally create a pull request. If I accept the pull request, I will merge your custom branch with the latest development branch. The latter will eventually be merged into a future release version. To contribute, you need to have a solid knowledge of C++ (preferably C++11), 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 - 2021 softwareQ Inc. All rights reserved.
Installation instructions and further documentation
To generate the full official API documentation in both LaTeX and HTML formats run
doxygen on the
Doxyfile file. The tool
dot from the
Graphviz package must be installed (
sudo apt-get install graphviz in Ubuntu/Debian). Running
doxygen will generate the documentation directory
doc containing both the HTML and LaTeX documentation.
The HTML documentation file will be accessible by opening
doc/html/index.html with the browser of your choice.
To generate a PDF file of the documentation, run
latexmk -pdf refman.tex
doc/latex directory or compile the file
doc/latex/refman.tex with your LaTeX compiler. This will create the
doc/latex/refman.pdf documentation file. Consult your favourite LaTeX manual for how to compile/build LaTeX files under your specific operating system.