Skip to content

Commit

Permalink
Make typedefs brief
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph-Edwards committed Aug 6, 2024
1 parent f7cbdd3 commit d161685
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions include/libsemigroups/types.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ namespace libsemigroups {
//!
//! This file contains functionality for various types used in
//! ``libsemigroups``.

//! \ingroup types_group
//!
//! @{

Expand Down Expand Up @@ -90,13 +88,13 @@ namespace libsemigroups {
std::conditional_t<N >= 0x100, uint16_t, uint8_t>>>;
};

//! Type for the index of a generator of a semigroup.
//! \brief Type for the index of a generator of a semigroup.
using letter_type = size_t;

//! Type for a word over the generators of a semigroup.
//! \brief Type for a word over the generators of a semigroup.
using word_type = std::vector<letter_type>;

//! Type for a pair of word_type (a *relation*) of a semigroup.
//! \brief Type for a pair of word_type (a *relation*) of a semigroup.
using relation_type = std::pair<word_type, word_type>;

//! @}
Expand Down

0 comments on commit d161685

Please sign in to comment.