SetSeparationSystemBase
=======================

.. currentmodule:: tangles.separations

.. autoclass:: SetSeparationSystemBase




   .. rubric:: Methods

   .. toctree::
      :hidden:

      tangles.separations.SetSeparationSystemBase.__getitem__
      tangles.separations.SetSeparationSystemBase.add_corner
      tangles.separations.SetSeparationSystemBase.add_seps
      tangles.separations.SetSeparationSystemBase.all_sep_ids
      tangles.separations.SetSeparationSystemBase.assemble_meta_info
      tangles.separations.SetSeparationSystemBase.compute_infimum
      tangles.separations.SetSeparationSystemBase.count_big_side
      tangles.separations.SetSeparationSystemBase.crossing_seps
      tangles.separations.SetSeparationSystemBase.get_corners
      tangles.separations.SetSeparationSystemBase.get_sep_ids
      tangles.separations.SetSeparationSystemBase.is_le
      tangles.separations.SetSeparationSystemBase.is_nested
      tangles.separations.SetSeparationSystemBase.metadata_matrix
      tangles.separations.SetSeparationSystemBase.separation_metadata
      tangles.separations.SetSeparationSystemBase.side_counts
      tangles.separations.SetSeparationSystemBase.with_array
      tangles.separations.SetSeparationSystemBase.with_sparse_array

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

      * - :func:`__getitem__`
        - Access the data of the separation or separations
      * - :func:`add_corner`
        - Calculate the infimum of two oriented separations from the separation system and add this infimum as a
      * - :func:`add_seps`
        - Add separations to the separation system
      * - :func:`all_sep_ids`
        - Returns
      * - :func:`assemble_meta_info`
        - If the user has entered custom meta info for a separation, then that is prioritised before everything else
      * - :func:`compute_infimum`
        - Calculate the infimum of a list of separation ids and orientations
      * - :func:`count_big_side`
        - Count the number of data points on the big (positive) side of the given separation
      * - :func:`crossing_seps`
        - Generator to get all crossing separations from the list of separations
      * - :func:`get_corners`
        - Calculate the four corners of two separations in the separation system
      * - :func:`get_sep_ids`
        - If the separations are already contained inside of the separation system then return the
      * - :func:`is_le`
        - Check if separation :math:`a` specified by `sep_id_a` is less than or equal to separation :math:`b` specified by `sep_id_b`,
      * - :func:`is_nested`
        - Checks whether two separations are nested
      * - :func:`metadata_matrix`
        - Explain the meaning of a separation, generated by repeatedly taking corners of separations,
      * - :func:`separation_metadata`
        - Returns the metadata of the separation `sep_id`
      * - :func:`side_counts`
        - Count the number of data points on each side of the separation
      * - :func:`with_array`
        - Create a new SetSeparationSystem from a separation matrix
      * - :func:`with_sparse_array`
        - Create a new SetSeparationSystem from a sparse separation matrix