Skip to content

Commit

Permalink
Add even more docs to Sims
Browse files Browse the repository at this point in the history
  • Loading branch information
reiniscirpons committed Apr 10, 2024
1 parent 00f46c9 commit b678faa
Show file tree
Hide file tree
Showing 3 changed files with 223 additions and 138 deletions.
13 changes: 8 additions & 5 deletions docs/Congruences.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ The full license is in the file LICENSE, distributed with this
software.
-->

This file contains documentation for the functionality in ``libsemigroups``
related to congruences of semigroups and monoids.
This file contains documentation for the functionality in `libsemigroups`
related to congruences of semigroups and monoids. The following classes are implemented in `libsemigroups`:

* \ref libsemigroups::SimsSettings "SimsSettings"
* \ref libsemigroups::Sims1 "Sims1"
* \ref libsemigroups::Sims2 "Sims2"
- \ref libsemigroups::SimsSettings "SimsSettings" - for setting the presentation and various runtime parameters of the Sims low index algorithm.
- \ref libsemigroups::Sims1 "Sims1" - for computing finite index right congruences of a finitely presented semigroup or monoid.
- \ref libsemigroups::Sims2 "Sims2" - for computing finite index two-sided congruences of a finitely presented semigroup or monoid.
- \ref libsemigroups::RepOrc "RepOrc" - for computing small degree transformation representations of a finite semigroup or monoid.
- \ref libsemigroups::MinimalRepOrc "MinimalRepOrc" - for computing the minimal degree of a transformation representation arising from a right congruences of a finite semigroup or monoid.
- \ref libsemigroups::SimsStats "SimsStats" - for keeping track of various statistics arising during the runtime of the low index algorithm.
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2381,7 +2381,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = PARSED_BY_DOXYGEN
PREDEFINED = PARSED_BY_DOXYGEN DOXYGEN_SHOULD_SKIP_THIS

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
Loading

0 comments on commit b678faa

Please sign in to comment.