API
===

.. _label-full-hmatrix:

full
----
.. doxygenfunction:: full(hmatrix<T> const &Ah)
    :project: castor

.. _label-gmres-hmatrix:

gmres
-----
.. doxygenfunction:: gmres(hmatrix<T> const &Ah, matrix<T> const &B, double tol, std::size_t maxit, hmatrix<T> const &Lh, hmatrix<T> const &Uh, matrix<T> const &X0 = matrix<T>())
    :project: castor
.. doxygenfunction:: gmres(hmatrix<T> const &Ah, matrix<T> const &B, double tol, std::size_t maxit, hmatrix<T> const &Ahm1, matrix<T> const &X0 = matrix<T>())
    :project: castor
.. doxygenfunction:: gmres(hmatrix<T> const &Ah, matrix<T> const &B, double tol = 1e-6, std::size_t maxit = 10, std::function<matrix<T>(matrix<T> const&)> const &Am1 = std::function<matrix<T>(matrix<T> const&)>(), matrix<T> const &X0 = matrix<T>())
    :project: castor

.. _label-inv-hmatrix:

inv
---
.. doxygenfunction:: inv(hmatrix<T> const &Ah)
    :project: castor


.. _label-linsolve-hmatrix:

linsolve
--------
.. doxygenfunction:: linsolve(hmatrix<T> const &Ah, matrix<T> const &B)
    :project: castor


.. _label-lu-hmatrix:

lu
--
.. doxygenfunction:: lu(hmatrix<T> const &Ah, double tol = 0)
    :project: castor


.. _label-mtimes-hmatrix:

mtimes
------
.. doxygenfunction:: mtimes(hmatrix<T> const &Ah, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: mtimes(matrix<T> const &A, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: mtimes(hmatrix<T> const &Ah, matrix<T> const &B)
    :project: castor


.. _label-size_hmatrix:

size
----
.. doxygenfunction:: size(hmatrix<T> const &Ah)
    :project: castor

See :ref:`label-length`, :ref:`label-numel`.

.. _label-spydata:

spydata
-------
.. doxygenfunction:: spydata(hmatrix<T> const &Ah)
    :project: castor

.. _label-tgeabm-hmatrix:

tgeabm
------
.. doxygenfunction:: tgeabm(T alpha, matrix<T> const &A, matrix<T> const &B, T beta, hmatrix<T> &Ch)
    :project: castor


.. _label-tgemm-hmatrix:

tgemm
-----
.. doxygenfunction:: tgemm(T alpha, hmatrix<T> const &Ah, hmatrix<T> const &Bh, T beta, hmatrix<T> &Ch)
    :project: castor


.. _label-transpose-hmatrix:

transpose
---------
.. doxygenfunction:: transpose(hmatrix<T> const &Ah)
    :project: castor


.. _label-operators-hmatrix:

operators
---------

.. _label-operator<<-hmatrix:

operator<<
++++++++++

.. doxygenfunction:: operator<<(std::ostream &flux, hmatrix<T> const &Ah)
    :project: castor


.. _label-operator+-hmatrix:

operator+
++++++++++

.. doxygenfunction:: operator+(T a, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator+(hmatrix<T> const &Ah, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator+(hmatrix<T> const &Ah, T b)
    :project: castor


.. _label-operator--hmatrix:

operator-
++++++++++

.. doxygenfunction:: operator-(T a, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator-(hmatrix<T> const &Ah, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator-(hmatrix<T> const &Ah, T b)
    :project: castor
.. doxygenfunction:: operator-(hmatrix<T> const &Ah)
    :project: castor


.. _label-operator*-hmatrix:

operator*
++++++++++

.. doxygenfunction:: operator*(T a, hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator*(hmatrix<T> const &Ah, T b)
    :project: castor


.. _label-operator/-hmatrix:

operator/
++++++++++

.. doxygenfunction:: operator/(hmatrix<T> const &Ah, T b)
    :project: castor


.. _label-operator+=-hmatrix:

operator+=
++++++++++
.. doxygenfunction:: operator+=(hmatrix<T> const &Bh)
    :project: castor
.. doxygenfunction:: operator+=(T b)
    :project: castor



.. _label-operator*=-hmatrix:

operator*=
++++++++++
.. doxygenfunction:: operator*=(T b)
    :project: castor