Iterators¶
This page contains information about iterators for accessing certain attributes of the CongruenceInterface
class.
-
inline const_iterator libsemigroups::CongruenceInterface::cbegin_generating_pairs() const noexcept¶
Returns a const iterator pointing to the first generating pair.
- Complexity
Constant.
- Parameters
(None)
- Throws
(None) – This function is
noexcept
and is guaranteed never to throw.- Returns
A const_iterator pointing to a relation_type.
-
inline non_trivial_class_iterator libsemigroups::CongruenceInterface::cbegin_ntc()¶
Returns a const iterator pointing to the first non-singleton class.
- Complexity
See warnings.
- Parameters
(None)
Warning
The problem of determining the return value of this function is undecidable in general, and this function may never terminate.
- Throws
LibsemigroupsException – if has_parent_froidure_pin() returns
false
.- Returns
A non_trivial_class_iterator pointing to a std::vector<word_type>.
-
inline const_iterator libsemigroups::CongruenceInterface::cend_generating_pairs() const noexcept¶
Returns a const iterator pointing one-after-the-end of the last generating pair.
- Complexity
Constant.
- Parameters
(None)
- Throws
(None) – This function is
noexcept
and is guaranteed never to throw.- Returns
A const_iterator pointing to a relation_type.
-
inline non_trivial_class_iterator libsemigroups::CongruenceInterface::cend_ntc()¶
Returns a const iterator pointing one-past-the-end of the last non-singleton class.
- Complexity
See warnings.
- Parameters
(None)
Warning
The problem of determining the return value of this function is undecidable in general, and this function may never terminate.
- Throws
LibsemigroupsException – if has_parent_froidure_pin() returns
false
.- Returns
A non_trivial_class_iterator pointing to a std::vector<word_type>.