Quantum++
v1.0.0-beta3
C++11 quantum computing library
|
Build status : Master  Devel 
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, please contact me. 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 - 2017 Vlad Gheorghiu, vgheorgh AT gmail DOT com.
Quantum++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Quantum++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Quantum++. If not, see http://www.gnu.org/licenses/.
$HOME/eigen
$HOME/qpp
/Applications/MATLAB_R2016a.app/extern/include
/Applications/MATLAB_R2016a.app/bin/maci64
The current version of the repository has a ./CMakeLists.txt
configuration file for building examples using CMake. To build an example using CMake, I recommend an out-of-source build, i.e., from the root of the project (where ./include
is located), type
mkdir ./build cd ./build cmake .. make
The commands above build the relase version (default) executable qpp
, from the source file ./examples/minimal.cpp
, without MATLAB support (default), inside the directory ./build
. To build a different configuration, e.g. debug version with MATLAB support, type from the root of the project
cd ./build rm -rf * cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_MATLAB=ON .. make
Or, to disable OpenMP support (enabled by default), type
cd ./build rm -rf * cmake -DWITH_OPENMP=OFF .. make
To change the name of the example file, the location of the Eigen 3 library or the location of MATLAB installation, edit the ./CMakeLists.txt
file. See also ./CMakeLists.txt
for additional options. Do not forget to clean the ./build
directory before a fresh build!
$HOME/qpp/examples/minimal.cpp
$HOME/qpp/examples/minimal
$HOME/qpp/examples
g++ -pedantic -std=c++11 -Wall -Wextra -Weffc++ -fopenmp \ -O3 -DNDEBUG -DEIGEN_NO_DEBUG \ -isystem $HOME/eigen -I $HOME/qpp/include \ minimal.cpp -o minimal
g++ -pedantic -std=c++11 -Wall -Wextra -Weffc++ -fopenmp \ -g3 -DDEBUG \ -isystem $HOME/eigen -I $HOME/qpp/include \ minimal.cpp -o minimal
g++ -pedantic -std=c++11 -Wall -Wextra -Weffc++ -fopenmp \ -O3 -DNDEBUG -DEIGEN_NO_DEBUG \ -isystem $HOME/eigen -I $HOME/qpp/include \ -I/Applications/MATLAB_R2016a.app/extern/include \ -L/Applications/MATLAB_R2016a.app/bin/maci64 \ -lmx -lmat minimal.cpp -o minimal
g++ -pedantic -std=c++11 -Wall -Wextra -Weffc++ -fopenmp \ -g3 -DDEBUG \ -isystem $HOME/eigen -I $HOME/qpp/include \ -I /Applications/MATLAB_R2016a.app/extern/include \ -L /Applications/MATLAB_R2016a.app/bin/maci64 \ -lmx -lmat minimal.cpp -o minimal
Quantum++ was extensively tested via a suite of unit tests constructed with Google Test 1.8.0 (included with the project in ./unit_tests/lib/gtest-1.8.0
). The source code of the unit tests is provided under ./unit_tests/tests
. To build and run the unit tests, I strongly recommend to use CMake version 3.0.0 or later. Assuming you do use CMake, switch to the ./unit_tests
directory, create a build
directory inside it, then from the newly created ./unit_tests/build
type
cmake .. make
The commands above build ./unit_tests/build/tests/qpp_testing
, which you then may run.
The CMake configuration file ./unit_tests/CMakeLists.txt
defines the same building options and default choices as the main ./CMakeLists.txt
of Quantum++. Therefore you can use the same flags as the ones mentioned at the beginning of this document when customizing the build. You should modify ./unit_tests/CMakeLists.txt
accordingly in case your Eigen 3 library or MATLAB include/library files are in a different location than the one assumed in this document.
<cmath>
using the provided patch ./cmath_cygwin.patch
.DYLD_LIBRARY_PATH
is set to point to the MATLAB compiler library location, see the run_OSX_MATLAB
script. Otherwise, you get a runtime error similar to > dyld: Library not loaded: @rpath/libmat.dylib.
DYLD_LIBRARY_PATH
globally may interfere with macports' CMake installation (in case you use CMake from macports). If you use a script, then the environment variable is local to the script and does not interfere with the rest of the system.#!/bin/sh MATLAB=/Applications/MATLAB_R2016a.app export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$MATLAB/bin/maci64 ./build/qpp
-fno-weak
compiler flag. See http://stackoverflow.com/questions/23330641/gnu-gdb-can-not-step-into-template-functions-os-x-mavericks for more details about this problem.