From 68600465cde18f489e49a4d8e69abda2a08405c5 Mon Sep 17 00:00:00 2001 From: Joseph Edwards Date: Mon, 5 Aug 2024 15:18:16 +0100 Subject: [PATCH] Move active node description --- include/libsemigroups/aho-corasick.hpp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/include/libsemigroups/aho-corasick.hpp b/include/libsemigroups/aho-corasick.hpp index 1995d9449..26e1632e0 100644 --- a/include/libsemigroups/aho-corasick.hpp +++ b/include/libsemigroups/aho-corasick.hpp @@ -69,6 +69,13 @@ namespace libsemigroups { //! //! https://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_algorithm //! + //! The implementation of \ref AhoCorasick uses two different types of node; + //! *active* and *inactive*. An active node is a node that is currently a + //! node in the trie. An inactive node is a node that used to be part of the + //! trie, but has since been removed. It may later become active again after + //! being reinitialised, and exists as a way of minimising how frequently + //! memory needs to be allocated and deallocated for nodes. + //! //! Several helper functions are provided in the ``aho_corasick`` namespace. class AhoCorasick { public: @@ -659,7 +666,7 @@ namespace libsemigroups { //! \brief Check if an index corresponds to a node. //! //! This function checks if the given index \p i corresponds to the index of - //! a node. + //! a node; either active or inactive. //! //! \param i the index to validate. //! @@ -673,13 +680,6 @@ namespace libsemigroups { //! \brief Check if an index corresponds to a node currently in the trie //! - //! The implementation of \ref AhoCorasick uses two different types of node; - //! *active* and *inactive*. An active node is a node that is currently a - //! node in the trie. An inactive node is a node that used to be part of the - //! trie, but has since been removed. It may later become active again after - //! being reinitialised, and exists as a way of minimising how frequently - //! memory needs to be allocated and deallocated for nodes. - //! //! This function validates whether the given index \p i corresponds to an //! active node. //!