Metadata-Version: 2.1
Name: matrix-decomposition
Version: 1.0
Summary: This library allows to approximate Hermitian (dense and sparse) matrices by positive definite matrices. Furthermore it allows to decompose (factorize) positive definite matrices and solve associated systems of linear equations.
Home-page: https://github.com/jor-/matrix_decomposition
Author: Joscha Reimer
Author-email: jor@informatik.uni-kiel.de
License: AGPLv3+
Keywords: approximation Hermitian dense sparse matrix matrices positive definite decompose factorize decomposition factorization linear equation equations Cholesky
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python
Provides-Extra: decompose_sparse
Requires-Dist: numpy
Requires-Dist: scipy (>=0.19)
Provides-Extra: decompose_sparse
Requires-Dist: scikit-sparse (>=0.4.2); extra == 'decompose_sparse'

====================
MATRIX-DECOMPOSITION
====================

This is *matrix-decomposition*, a library to approximate Hermitian (dense and sparse) matrices by positive definite matrices. Furthermore it allows to decompose (factorize) positive definite matrices and solve associated systems of linear equations.


Release info
============

There are several ways to obtain and install this package.

Conda
-----

.. image:: https://img.shields.io/conda/v/jore/matrix-decomposition.svg
    :target: https://anaconda.org/jore/matrix-decomposition
    :alt: Conda version
.. image:: https://anaconda.org/jore/matrix-decomposition/badges/latest_release_date.svg
    :target: https://anaconda.org/jore/matrix-decomposition
    :alt: Conda last updated
.. image:: https://anaconda.org/jore/matrix-decomposition/badges/platforms.svg
    :target: https://anaconda.org/jore/matrix-decomposition
    :alt: Conda platforms
.. image:: https://anaconda.org/jore/matrix-decomposition/badges/license.svg
    :target: https://anaconda.org/jore/matrix-decomposition
    :alt: Conda licence


To install this package with *conda* run:

    ``conda install -c jore matrix-decomposition``

https://anaconda.org/jore/matrix-decomposition


pip
---

.. image:: https://img.shields.io/pypi/v/matrix-decomposition.svg
    :target: https://pypi.python.org/pypi/matrix-decomposition
    :alt: PyPI version
.. image:: https://img.shields.io/pypi/format/matrix-decomposition.svg
    :target: https://pypi.python.org/pypi/matrix-decomposition
    :alt: PyPI format
.. image:: https://img.shields.io/pypi/l/matrix-decomposition.svg
    :target: https://pypi.python.org/pypi/matrix-decomposition
    :alt: PyPI licence

To install this package with *pip* run:

    ``pip install 'matrix-decomposition'``

https://pypi.python.org/pypi/matrix-decomposition


GitHub
------

.. image:: https://img.shields.io/github/tag/jor-/matrix-decomposition.svg
    :target: https://github.com/jor-/matrix-decomposition
    :alt: GitHub last tag
.. image:: https://img.shields.io/github/license/jor-/matrix-decomposition.svg
    :target: https://github.com/jor-/matrix-decomposition
    :alt: GitHub license

To clone this package with *git* run:

    ``git clone https://github.com/jor-/matrix-decomposition.git``

To install this package after that with *python* run:

    ``cd matrix-decomposition; python setup.py install``

https://github.com/jor-/matrix-decomposition


Documentation
=============

.. image:: https://readthedocs.org/projects/matrix-decomposition/badge/?version=stable
    :target: http://matrix-decomposition.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status

https://matrix-decomposition.readthedocs.io


Test status
===========

.. image:: https://travis-ci.org/jor-/matrix-decomposition.svg?branch=master
    :target: https://travis-ci.org/jor-/matrix-decomposition
    :alt: Build Status
.. image:: https://codecov.io/gh/jor-/matrix-decomposition/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/jor-/matrix-decomposition
    :alt: Code Coverage


Copyright
=========

Copyright (C) 2017-2018  Joscha Reimer jor@informatik.uni-kiel.de

This program 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.

This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.


