Skip to content

Commit

Permalink
Add helper namespace to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph-Edwards committed Oct 29, 2024
1 parent c28028c commit 66f737c
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions include/libsemigroups/schreier-sims.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -942,11 +942,16 @@ namespace libsemigroups {
}
};

//! \ingroup schreier_sims_group
//! \brief Namespace for SchreierSims helper functions.
//!
//! This namespace contains helper functions for the SchreierSims class.
namespace schreier_sims {

//! Find the intersection of two permutation groups.
//! \brief Find the intersection of two permutation groups.
//!
//! Modifies the first parameter \p T to be the Schreier-Sims object
//! This function finds the intersection of two permutation groups. It
//! modifies the first parameter \p T to be the Schreier-Sims object
//! corresponding to the intersection of \p S1 and \p S2.
//!
//! \tparam N the largest point not fixed by the permutations in the
Expand All @@ -957,9 +962,7 @@ namespace libsemigroups {
//! \param S2 the second group of the intersection.
//!
//! \throws LibsemigroupsException if \p T is not empty.
//!
// TODO(later) example

// TODO (from RC):
// 1. Implement orbit refinement heuristic for intersection.
// 2. Make the Screier-Sims object during runtime, since we compute the
Expand All @@ -969,7 +972,6 @@ namespace libsemigroups {
//
// TODO (from JDM):
// * use the no_checks mem fns of SchreierSims now that they exist

template <size_t N>
void intersection(SchreierSims<N>& T,
SchreierSims<N>& S1,
Expand Down

0 comments on commit 66f737c

Please sign in to comment.