..
    Copyright (c) 2024 R. Cirpons

    Distributed under the terms of the GPL license version 3.

    The full license is in the file LICENSE, distributed with this software.

.. currentmodule:: libsemigroups_pybind11

Helpers functions for low-index congruences
===========================================

This page contains the documentation for various helper functions for
manipulating :any:`Sims1`, :any:`Sims2`, :any:`RepOrc` or :any:`MinimalRepOrc`
objects. All such functions are contained in the submodule
``libsemigroups_pybind11.sims``.

Contents
--------

.. currentmodule:: libsemigroups_pybind11.sims

.. autosummary::
    :signatures: short

    is_maximal_right_congruence
    is_right_congruence
    is_right_congruence_of_dual
    is_two_sided_congruence
    poset
    right_generating_pairs
    two_sided_generating_pairs

Full API
--------

.. automodule:: libsemigroups_pybind11.sims
    :members:
    :imported-members:
    :exclude-members: 
        Sims1, Sims2, SimsRefinerIdeals, SimsRefinerFaithful, RepOrc, MinimalRepOrc