Skip to content

Commit

Permalink
forest: add missing return types (libsemigroups#579)
Browse files Browse the repository at this point in the history
  • Loading branch information
james-d-mitchell authored Aug 6, 2024
1 parent d0295b2 commit cbd22a8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/libsemigroups/forest.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,8 @@ namespace libsemigroups {
//! \param parent the parent node.
//! \param gen the label of the edge from \p parent to \p node.
//!
//! \returns A reference to `*this`.
//!
//! \throws LibsemigroupsException if \p node or \p parent exceeds
//! number_of_nodes().
//!
Expand Down Expand Up @@ -354,6 +356,8 @@ namespace libsemigroups {
//!
//! \param i the node.
//!
//! \returns The word labelling the path from a root node to \p i.
//!
//! \warning No checks are performed on the arguments of this function.
[[nodiscard]] word_type path_to_root_no_checks(node_type i) const {
word_type w;
Expand Down Expand Up @@ -385,6 +389,8 @@ namespace libsemigroups {
//!
//! \param i the node.
//!
//! \returns The word labelling the path from a root node to \p i.
//!
//! \throws LibsemigroupsException if \p i is greater than or equal to \ref
//! number_of_nodes.
[[nodiscard]] word_type path_to_root(node_type i) const {
Expand Down

0 comments on commit cbd22a8

Please sign in to comment.