xerus
a general purpose tensor library
xerus.h
Go to the documentation of this file.
1 // Xerus - A General Purpose Tensor Library
2 // Copyright (C) 2014-2017 Benjamin Huber and Sebastian Wolf.
3 //
4 // Xerus is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU Affero General Public License as published
6 // by the Free Software Foundation, either version 3 of the License,
7 // or (at your option) any later version.
8 //
9 // Xerus is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU Affero General Public License for more details.
13 //
14 // You should have received a copy of the GNU Affero General Public License
15 // along with Xerus. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // For further information on Xerus visit https://libXerus.org
18 // or contact us at contact@libXerus.org.
19 
25 // NOTE must not be "pragma once" as that keyword is not supported in precompiled headers
26 #ifndef XERUS_H
27 #define XERUS_H
28 
29  #define MISC_NAMESPACE xerus
30 
31  // The misc stuff needed by xerus
32  #include "xerus/misc.h"
33 
34  // File which sets the custom log levels
35  #include "xerus/tensorLogger.h"
36 
37  // All the xerus headers
38  #include "xerus/blasLapackWrapper.h"
39  #include "xerus/index.h"
42  #include "xerus/indexedTensor.h"
44  #include "xerus/indexedTensorList.h"
45  #include "xerus/tensor.h"
46  #include "xerus/cholmod_wrapper.h"
50  #include "xerus/tensorNetwork.h"
52  #include "xerus/ttNetwork.h"
53  #include "xerus/ttStack.h"
54  #include "xerus/performanceData.h"
55  #include "xerus/measurments.h"
56  #include "xerus/algorithms/als.h"
58  #include "xerus/algorithms/cg.h"
60  #include "xerus/algorithms/adf.h"
61  #include "xerus/algorithms/uqAdf.h"
62  #include "xerus/algorithms/iht.h"
64 
65  #include "xerus/examples/specificLowRankTensors.h"
66 
67 #endif
Header file for the TT largest entry algorithm.
Header file for the blas and lapack wrapper functions.
Default include file for the misc (ie. non-tensor) functionality.
Header file for the TTNetwork class (and thus TTTensor and TTOperator).
Header file for the Index class.
Header file for the IndexedTensorReadOnly class.
Header file for the IndexedTensorMoveable class.
Header file for the steepest descent algorithms.
Header file defining lists of indexed tensors.
Header file for the TTStack class.
Header file for the classes defining factorisations of Tensors.
Header file for the ALS algorithm and its variants.
Header file for the different measurment classes.
Header file for the ADF algorithm and its variants.
Header file for the Tensor class.
Header file for the ADF algorithm and its variants.
Header file that defines the logging behaviour of the internal debug log-levels used in the library...
Header file for the decomposition ALS algorithm. This is likely temporary.
Header file for the IHT algorithm and its variants.
Header file for sparse matrix times dense matrix wrapper functions.
Header file for the class managing the contraction heuristics.
Header file for suitesparse wrapper functions.
Header file for the IndexedTensorWritable class.
Header file for the PerformanceData class.
Header file for the TensorNetwork class.
Header file for the CG algorithm.
Header file for the IndexedTensor class.