Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph-Edwards committed Oct 2, 2024
1 parent 484d7f8 commit be78f53
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions include/libsemigroups/ukkonen.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ namespace libsemigroups {
//!
//! If the word corresponding to \p first and \p last is one of the words
//! that the suffix tree contains (the words added to the suffix tree via
//! `add_word` or `add_word_no_checks`, then this function returns the
//! `add_word` or `add_word_no_checks`), then this function returns the
//! index of that word. If the word corresponding to \p first and \p last
//! is not one of the words that the suffix tree represents, then \ref
//! UNDEFINED is returned.
Expand Down Expand Up @@ -1424,7 +1424,6 @@ namespace libsemigroups {
//! \complexity
//! Linear in the distance between `first` and `last`.
//!
//!
//! \warning This function does no checks on its arguments whatsoever. In
//! particular, if the word corresponding to \p first and \p last contains
//! any of the unique letters appended to the end of any existing word in
Expand Down Expand Up @@ -1644,10 +1643,10 @@ namespace libsemigroups {
//! \brief Find the length of the maximal prefix of a word occurring in two
//! different places in a word in a suffix tree.
//!
//! Returns length of the maximal length prefix of the word corresponding
//! to \p first and \p last that occurs in at least \f$2\f$ different
//! (possibly overlapping) places in the words contained in \p u. If no
//! such prefix exists, then `0` is returned.
//! Returns the length of the maximal length prefix of the word
//! corresponding to \p first and \p last that occurs in at least \f$2\f$
//! different (possibly overlapping) places in the words contained in \p u.
//! If no such prefix exists, then `0` is returned.
//!
//! \tparam Iterator the type of the 2nd and 3rd parameters.
//! \param u the Ukkonen object.
Expand Down Expand Up @@ -1997,10 +1996,10 @@ namespace libsemigroups {
//! \brief Find the length of the maximal suffix of a word occurring in two
//! different places in a word in a suffix tree.
//!
//! Returns length of the maximal length prefix of the word corresponding
//! to \p first and \p last that occurs in at least \f$2\f$ different
//! (possibly overlapping) places in the words contained in \p u. If no
//! such prefix exists, then `0` is returned.
//! Returns the length of the maximal length prefix of the word
//! corresponding to \p first and \p last that occurs in at least \f$2\f$
//! different (possibly overlapping) places in the words contained in \p u.
//! If no such prefix exists, then `0` is returned.
//!
//! \tparam Iterator the type of the 2nd and 3rd parameters.
//! \param u the Ukkonen object.
Expand Down Expand Up @@ -2362,6 +2361,10 @@ namespace libsemigroups {
//! This function returns a \ref Dot object representing the suffix tree
//! defined by \p u.
//!
//! Internally, all words added to the suffix tree are stored as a single
//! string delimited by unique letters. The edge labels present in this \ref
//! Dot object correspond intervals of letters in that delimited string.
//!
//! \param u the Ukkonen object.
//!
//! \returns A \ref Dot object.
Expand Down

0 comments on commit be78f53

Please sign in to comment.