QuTree

A tensor tree linear algebra package in C++ designed for quantum dynamics and machine learning applications.

Getting Started

Installation is easy using HomeBrew (on OS X) or LinuxBrew (on Linux):

brew tap sseritan/qu-tree
brew install qu-tree

Developers can get access to the cutting-edge package by using the --HEAD flag to install directly from the HEAD of master. Subsequent builds can be upgraded by using the --fetch-HEAD flag.

brew install --HEAD qu-tree

Subsequent builds can be upgraded by using the --fetch-HEAD flag.

brew upgrade --fetch-HEAD qu-tree

For instructions on how to install from source, check out our documentation.

Using QuTree

After installation, QuTree can be easily used in downstream CMake projects. If installed to non-standard locations, make sure to set QuTree_DIR to the location of QuTreeConfig.cmake.

Example CMakeLists.txt:

cmake_minimum_required(VERSION 3.0)
project(example CXX)

find_package(QuTree REQUIRED)

add_executable(test test.cpp)
target_link_libraries(test QuTree::QuTree)

Example test.cpp:

#include <Core/Tensor.h>
#include <Core/Matrix.h>

int main()
{
TensorShape tdim({2, 3, 4});
Tensorcd A(tdim);
for (size_t i = 0; i < A.shape().totalDimension(); i++) {
    A(i) = i;
}
Matrixcd w = A.DotProduct(A);
w.print();
}

For detailed examples on how to use the library, please see the examples folder or check out our documentation.

Citation

If QuTree is useful to your work, please cite the following paper:

TODO