Iterators¶
This page contains information about the member functions of the FroidurePin class related to iterators.
-
const_iterator libsemigroups::FroidurePin::begin() const¶
Returns a const iterator pointing to the first element (ordered by discovery).
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator.
-
const_iterator libsemigroups::FroidurePin::cbegin() const¶
Returns a const iterator pointing to the first element (ordered by discovery).
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator.
-
const_iterator_idempotents libsemigroups::FroidurePin::cbegin_idempotents()¶
Returns a const iterator pointing at the first idempotent.
If the returned iterator is incremented, then it points to the second idempotent in the semigroup (if it exists), and every subsequent increment points to the next idempotent.
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator_idempotents.
-
const_iterator_sorted libsemigroups::FroidurePin::cbegin_sorted()¶
Returns a const iterator pointing to the first element (sorted by Less).
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator_sorted.
-
const_iterator libsemigroups::FroidurePin::cend() const¶
Returns a const iterator pointing to one past the last known element.
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
end.
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator.
-
const_iterator_idempotents libsemigroups::FroidurePin::cend_idempotents()¶
Returns a const iterator pointing one past the last idempotent.
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator_idempotents.
-
const_iterator_sorted libsemigroups::FroidurePin::cend_sorted()¶
Returns a const iterator pointing one past the last element (sorted by Less).
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator_sorted.
-
const_reverse_iterator libsemigroups::FroidurePin::crbegin() const¶
Returns a const reverse iterator pointing to the last known element.
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_reverse_iterator.
-
const_reverse_iterator_sorted libsemigroups::FroidurePin::crbegin_sorted()¶
Returns a const iterator pointing to the last element (sorted by Less).
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_reverse_iterator_sorted.
-
const_reverse_iterator libsemigroups::FroidurePin::crend() const¶
Returns a const reverse iterator pointing one before the first element.
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_reverse_iterator.
-
const_reverse_iterator_sorted libsemigroups::FroidurePin::crend_sorted()¶
Returns a const reverse iterator pointing one before the first element (sorted by Less).
- Parameters
(None)
Note
This function triggers a full enumeration.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_reverse_iterator_sorted.
-
const_iterator libsemigroups::FroidurePin::end() const¶
Returns a const iterator pointing one past the last known element.
This function does not trigger any enumeration, and the returned iterators may be invalidated by any call to a non-const function of the FroidurePin class.
See also
cend.
- Parameters
(None)
- Complexity
Constant.
- Throws
(None) – This function guarantees not to throw a LibsemigroupsException.
- Returns
A value of type const_iterator.