__GNU_PARALLEL::_ITERATORPAIR(3cxx)

📦
version 14-20240412 · 18 versions
, in debian trixie, ubuntu noble, ubuntu questing

💖 NAME 💖

Bestie, this is the class page for __gnu_parallel::_IteratorPair< _Iterator1, _Iterator2, _IteratorCategory > from the 3cxx manual. It is literally a pair of iterators, and the usual iterator operations are applied to both child iterators. It inherits from std::pair< _Iterator1, _Iterator2 >.

✨ SYNOPSIS ✨

#include <iterator.h>

It inherits from std::pair< _Iterator1, _Iterator2 >.

🌸 Public Types 🌸

  • typedef std::iterator_traits< _Iterator1 > _TraitsType — the traits type for the first iterator.
  • typedef _TraitsType::difference_type difference_type — the difference type, borrowed from _TraitsType.
  • typedef _Iterator1 first_type — the type of the first member.
  • typedef _IteratorCategory iterator_category — the iterator category.
  • typedef _IteratorPair * pointer — pointer to this _IteratorPair situation.
  • typedef _IteratorPair & reference — reference to this _IteratorPair situation.
  • typedef _Iterator2 second_type — the type of the second member.
  • typedef void value_type — yep, value_type is void.

🎀 Public Member Functions 🎀

  • _IteratorPair (const _Iterator1 &__first, const _Iterator2 &__second) — the constructor, taking const _Iterator1 &__first and const _Iterator2 &__second.
  • operator _Iterator2 () const — conversion operator to _Iterator2.
  • _IteratorPair operator+ (difference_type __delta) const — plus operator with difference_type __delta.
  • _IteratorPair & operator++ () — pre-increment, returning _IteratorPair &.
  • const _IteratorPair operator++ (int) — post-increment, returning const _IteratorPair.
  • difference_type operator- (const _IteratorPair &__other) const — difference operator against const _IteratorPair &__other.
  • _IteratorPair & operator-- () — pre-decrement, returning _IteratorPair &.
  • const _IteratorPair operator-- (int) — post-decrement, returning const _IteratorPair.
  • _IteratorPair & operator= (const _IteratorPair &__other) — assignment from const _IteratorPair &__other.
  • constexpr void swap (pair &__p) noexcept(__and_< __is_nothrow_swappable< _Iterator1 >, __is_nothrow_swappable< _Iterator2 > >::value) — swap the first members and then the second members.

🦋 Public Attributes 🦋

  • _Iterator1 first — the first member.
  • _Iterator2 second — the second member.

(Note that these are not member symbols.)

  • make_pair — a convenience wrapper for creating a pair from two objects.
constexpr pair< typename __decay_and_strip< _Iterator1 >::__type, typename __decay_and_strip< _Iterator2 >::__type > make_pair (_Iterator1 &&__x, _Iterator2 &&__y)
  • swap (related overload) — the pair swap overload, with noexcept(noexcept(__x.swap(__y))) in the signature.
constexpr enable_if< __and_< __is_swappable< _Iterator1 >, __is_swappable< _Iterator2 > >::value >::type swap (pair< _Iterator1, _Iterator2 > &__x, pair< _Iterator1, _Iterator2 > &__y) noexcept(noexcept(__x.swap(__y)))
  • operator== — signature:
constexpr bool operator== (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)

Two pairs of the same type are equal iff their members are equal.

  • operator< — signature:
constexpr bool operator< (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)
  • operator!= — signature:
constexpr bool operator!= (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)

Uses operator== to find the result.

  • operator> — signature:
constexpr bool operator> (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)

Uses operator< to find the result.

  • operator<= — signature:
constexpr bool operator<= (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)

Uses operator< to find the result.

  • operator>= — signature:
constexpr bool operator>= (const pair< _Iterator1, _Iterator2 > &__x, const pair< _Iterator1, _Iterator2 > &__y)

Uses operator< to find the result.

🌟 Detailed Description 🌟

template<typename _Iterator1, typename _Iterator2, typename _IteratorCategory>
class __gnu_parallel::_IteratorPair< _Iterator1, _Iterator2, _IteratorCategory >

A pair of iterators. The usual iterator operations are applied to both child iterators.

🧚 Member Typedef Documentation 🧚

  • typedef _Iterator1 std::pair< _Iterator1 , _Iterator2 >::first_type [inherited] — the type of the first member.
  • typedef _Iterator2 std::pair< _Iterator1 , _Iterator2 >::second_type [inherited] — the type of the second member.

💅 Member Function Documentation 💅

  • constexpr void std::pair< _Iterator1 , _Iterator2 >::swap (pair< _Iterator1, _Iterator2 > & __p) [inline], [constexpr], [noexcept], [inherited] — swap the first members and then the second members.
  • make_pair — a convenience wrapper for creating a pair from two objects.
constexpr pair< typename __decay_and_strip< _Iterator1  >::__type, typename __decay_and_strip< _Iterator2  >::__type > make_pair (_Iterator1  && __x, _Iterator2  && __y) [related]

Parameters: __x is the first object. __y is the second object.

Returns: a newly-constructed pair<> object of the appropriate type.

The C++98 standard says the objects are passed by reference-to-const, but C++03 says they are passed by value (this was LWG issue #181).

Since C++11 they have been passed by forwarding reference and then forwarded to the new members of the pair. To create a pair with a member of reference type, pass a reference_wrapper to this function.

  • operator!= — uses operator== to find the result.
constexpr bool operator!= (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]
  • operator< — defines a lexicographical order for pairs.
constexpr bool operator< (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]

For two pairs of the same type, P is ordered before Q if P.first is less than Q.first, or if P.first and Q.first are equivalent (neither is less than the other) and P.second is less than Q.second.

  • operator<= — uses operator< to find the result.
constexpr bool operator<= (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]
  • operator== — two pairs of the same type are equal iff their members are equal.
constexpr bool operator== (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]
  • operator> — uses operator< to find the result.
constexpr bool operator> (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]
  • operator>= — uses operator< to find the result.
constexpr bool operator>= (const pair< _Iterator1 , _Iterator2  > & __x, const pair< _Iterator1 , _Iterator2  > & __y) [related]
  • swap overload for pairs — calls std::pair::swap().
constexpr enable_if< __and_< __is_swappable< _Iterator1  >, __is_swappable< _Iterator2  > >::value >::type swap (pair< _Iterator1 , _Iterator2  > & __x, pair< _Iterator1 , _Iterator2  > & __y) [related]
Note: this std::swap overload is not declared in C++03 mode, which has performance implications, e.g. see https://gcc.gnu.org/PR38466.

🍓 Member Data Documentation 🍓

  • _Iterator1 std::pair< _Iterator1 , _Iterator2 >::first [inherited] — the first member.
  • _Iterator2 std::pair< _Iterator1 , _Iterator2 >::second [inherited] — the second member.

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

Mwah 💋 — cute little footer sign-off: this page is from libstdc++ (the source/version in the generated footer), and the date is whatever date the generated footer carries — yes, the long title squished the footer into a little 3cxx puddle, but she still ate 💅✨

📦 where this page comes from