Metadata-Version: 2.1
Name: spmat
Version: 0.0.11
Summary: spmat: A collection of tools for special matrices
Home-page: https://github.com/zhengp0/spmat
Author: Peng Zheng
Author-email: zhengp@uw.edu
License: BSD 2-Clause License
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: docs
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-mock; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"

.. image:: https://github.com/zhengp0/spmat/workflows/python-build/badge.svg
    :target: https://github.com/zhengp0/spmat/actions

.. image:: https://badge.fury.io/py/spmat.svg
    :target: https://badge.fury.io/py/spmat

Special Matrices
================

A collection of tools for special matrices.
Currently include:

- ``ILMat``: Identity plus PSD low rank matrix.
- ``DLMat``: Diagonal plus PDS low rank matrix.
- ``BDLMat``: Block ``DLMat``.

Install
-------

To install, you could download this repository and,

.. code-block:: bash

    python setup.py install

Or simply install through ``pip``,

.. code-block:: bash

    pip install spmat
