Commit 248cbfdf authored by Philipp  Trunschke's avatar Philipp Trunschke

update copyright & remove useless comments

parent 2dc58cdd
Pipeline #910 passed with stages
in 8 minutes and 50 seconds
......@@ -5,18 +5,18 @@ subtitle: "a general purpose tensor library"
---
# Xerus
**master:** <a href="https://git.hemio.de/xerus/xerus/commits/master"><img alt="build status" src="https://git.hemio.de/xerus/xerus/badges/master/build.svg" /></a>
<a href="https://git.hemio.de/xerus/xerus/commits/master"><img alt="coverage report" src="https://git.hemio.de/xerus/xerus/badges/master/coverage.svg" /></a>
**master:** <a href="https://git.hemio.de/xerus/xerus/commits/master"><img alt="build status" src="https://git.hemio.de/xerus/xerus/badges/master/build.svg" /></a>
<a href="https://git.hemio.de/xerus/xerus/commits/master"><img alt="coverage report" src="https://git.hemio.de/xerus/xerus/badges/master/coverage.svg" /></a>
<a href="https://git.hemio.de/xerus/xerus/commits/master">
__breakFix1
{% include version.svp %}
__breakFix2
**development:** <a href="https://git.hemio.de/xerus/xerus/commits/development"><img alt="build status" src="https://git.hemio.de/xerus/xerus/badges/development/build.svg" /></a>
**development:** <a href="https://git.hemio.de/xerus/xerus/commits/development"><img alt="build status" src="https://git.hemio.de/xerus/xerus/badges/development/build.svg" /></a>
<a href="https://git.hemio.de/xerus/xerus/commits/development"><img alt="coverage report" src="https://git.hemio.de/xerus/xerus/badges/development/coverage.svg" /></a>
The `xerus` library is a general purpose library for numerical calculations with higher order tensors, Tensor-Train Decompositions / Matrix Product States and general Tensor Networks.
The focus of development was the simple usability and adaptibility to any setting that requires higher order tensors or decompositions thereof.
The focus of development was the simple usability and adaptibility to any setting that requires higher order tensors or decompositions thereof.
The key features include:
* Modern code and concepts incorporating many features of the `C++11` standard.
......@@ -31,7 +31,7 @@ The key features include:
## Getting Started
`xerus` can be obtained via [git](https://git.hemio.de/xerus/xerus) or as an archived download via the same link.
`xerus` can be obtained via [git](https://git.hemio.de/xerus/xerus) or as an archived download via the same link.
To build and install the library you might want to check our the [Building xerus](/building_xerus) guide.
Where to go from there depends on what you want to do with `xerus` and how you learn. You can quickly get a feeling for the library
......@@ -50,13 +50,13 @@ Should you have any problems with the library do not hesitate to contact us at [
The `xerus` library is published under the AGPL v3.0. With proper attribution you are thus allowed to freely use and modify the source code but if you distribute your software including the `xerus`
library (or you provide a service based on this library) you have to provide the full source code under a compatible licence. For more information see the [AGPL](http://www.gnu.org/licenses/agpl-3.0.html).
If this library proved useful in your scientific research we would be grateful for any contributions to the source code and citations. As there is no related article yet, a corresponding bibtex
If this library proved useful in your scientific research we would be grateful for any contributions to the source code and citations. As there is no related article yet, a corresponding bibtex
entry might look as follows
~~~
@Misc{xerus,
author = {Huber, Benjamin and Wolf, Sebastian},
title = {Xerus - A General Purpose Tensor Library},
howpublished = {\url{https://libxerus.org/}},
year = {2014--2017}
year = {2014--2018}
}
~~~
// Xerus - A General Purpose Tensor Library
// Copyright (C) 2014-2017 Benjamin Huber and Sebastian Wolf.
//
// Copyright (C) 2014-2018 Benjamin Huber and Sebastian Wolf.
//
// Xerus is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
//
// Xerus 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 Affero General Public License for more details.
//
//
// You should have received a copy of the GNU Affero General Public License
// along with Xerus. If not, see <http://www.gnu.org/licenses/>.
//
// For further information on Xerus visit https://libXerus.org
// For further information on Xerus visit https://libXerus.org
// or contact us at contact@libXerus.org.
/**
......@@ -26,31 +26,31 @@
// TODO get_copy() wrapper in python correct manner
BOOST_PYTHON_MODULE(xerus) {
using namespace xerus;
import_array(); // for numpy
bool show_user_defined = true;
bool show_signatures = false;
docstring_options doc_options(show_user_defined, show_signatures);
// xerus version
scope().attr("VERSION_MAJOR") = VERSION_MAJOR;
scope().attr("VERSION_MINOR") = VERSION_MINOR;
scope().attr("VERSION_REVISION") = VERSION_REVISION;
scope().attr("VERSION_COMMIT") = VERSION_COMMIT;
VECTOR_TO_PY(size_t, "IntegerVector");
VECTOR_TO_PY(double, "DoubleVector");
expose_indexedTensors();
expose_factorizations();
expose_tensor();
expose_tensorNetwork();
expose_ttnetwork();
expose_leastSquaresAlgorithms();
expose_recoveryAlgorithms();
expose_misc();
using namespace xerus;
import_array(); // for numpy
bool show_user_defined = true;
bool show_signatures = false;
docstring_options doc_options(show_user_defined, show_signatures);
// xerus version
scope().attr("VERSION_MAJOR") = VERSION_MAJOR;
scope().attr("VERSION_MINOR") = VERSION_MINOR;
scope().attr("VERSION_REVISION") = VERSION_REVISION;
scope().attr("VERSION_COMMIT") = VERSION_COMMIT;
VECTOR_TO_PY(size_t, "IntegerVector");
VECTOR_TO_PY(double, "DoubleVector");
expose_indexedTensors();
expose_factorizations();
expose_tensor();
expose_tensorNetwork();
expose_ttnetwork();
expose_leastSquaresAlgorithms();
expose_recoveryAlgorithms();
expose_misc();
}
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment