tangles.util.matrix_order
=========================

.. currentmodule:: tangles.util.matrix_order

.. automodule:: tangles.util.matrix_order


   .. rubric:: Classes

   .. toctree::
      :hidden:

      tangles.util.matrix_order.MatrixOrderSVD

   .. list-table::
      :widths: 50 50

      * - :class:`MatrixOrderSVD`
        - Class representing function objects computing approximations of covariance order functions by using singular value decomposition


   .. rubric:: Functions

   .. toctree::
      :hidden:

      tangles.util.matrix_order.covariance_order
      tangles.util.matrix_order.linear_similarity_from_dist_matrix
      tangles.util.matrix_order.linear_similarity_from_distances
      tangles.util.matrix_order.logdet_order
      tangles.util.matrix_order.matrix_order
      tangles.util.matrix_order.o_five
      tangles.util.matrix_order.o_seven

   .. list-table::
      :widths: 50 50

      * - :func:`covariance_order`
        - Order function defined by the matrix :math:`A^T A`, where :math:`A` is the adjacency matrix of a graph
      * - :func:`linear_similarity_from_dist_matrix`
        - Turns a distance matrix into a similarity matrix by linearly inverting the distances up to some maximum distance (margin)
      * - :func:`linear_similarity_from_distances`
        - Turns a matrix of positions into a matrix of similarities (simply based on distances)
      * - :func:`logdet_order`
        - Order function defined by :math:`|f| = log( det( M_A )) + log( det( M_B ))` where :math:`f` is the bipartition indicator
      * - :func:`matrix_order`
        - A general order function defined by a quadratic matrix
      * - :func:`o_five`
        - (O5) from the tangles book
      * - :func:`o_seven`
        - (O7) from the tangles book