__GNU_PARALLEL::ITERATOR_PAIR(3)

πŸ“¦ version 4.4.0, in nixpkgs unstable

πŸ’– NAME πŸ’–

Hey bestie! πŸ’– You're reading __gnu_para...erator_pair(3) from the Library Functions Manual β€” yes, that truncated-looking header is literally the vibe. This page is all about __gnu_parallel::iterator_pair: a pair of iterators where the usual iterator operations are applied to both child iterators. No cap. ✨

✨ SYNOPSIS ✨

Okay so here's the inheritance tea: it inherits from pair< Iterator1, Iterator2 >. 🫢

🌸 Public Types 🌸

These are the public typedefs, exactly as written, bestie:

  • difference_type β€” typedef traits_type::difference_type difference_type
  • first_type β€” typedef Iterator1 first_type
  • iterator_category β€” typedef IteratorCategory iterator_category
  • pointer β€” typedef type * pointer
  • reference β€” typedef type & reference
  • second_type β€” typedef Iterator2 second_type
  • traits_type β€” typedef std::iterator_traits< Iterator1 > traits_type
  • value_type β€” typedef void value_type

πŸŽ€ Public Member Functions πŸŽ€

The whole member-function roster, and yes, every signature is copy-pasted exactly with love:

  • iterator_pair (const Iterator1 &first, const Iterator2 &second) β€” the constructor, taking first and second as const refs.
  • operator Iterator2 () const β€” a conversion operator to Iterator2.
  • type operator+ (difference_type delta) const β€” the plus operator, taking delta.
  • const type operator++ (int) β€” the post-increment operator, returning const type.
  • type & operator++ () β€” the pre-increment operator, returning type &.
  • difference_type operator- (const type &other) const β€” the minus operator, taking other.
  • const type operator-- (int) β€” the post-decrement operator, returning const type.
  • type & operator-- () β€” the pre-decrement operator, returning type &.
  • type & operator= (const type &other) β€” the assignment operator, taking other.
  • void swap (pair &&__p) β€” the swap function, taking __p.

πŸ¦‹ Public Attributes πŸ¦‹

  • Iterator1 first β€” public attribute first, living its best life.
  • Iterator2 second β€” public attribute second, also iconic.

πŸ“– Detailed Description πŸ“–

Here's the template moment, bestie:

template<typename Iterator1, typename Iterator2, typename IteratorCategory>
class __gnu_parallel::iterator_pair< Iterator1, Iterator2, IteratorCategory >

A pair of iterators. The usual iterator operations are applied to both child iterators. That's the whole point, and it ate. πŸ’…

Definition at line 44 of file iterator.h.

🧚 Member Typedef Documentation 🧚

  • typedef Iterator1 std::pair< Iterator1 , Iterator2 >::first_type [inherited] β€” first_type is the first bound type. Definition at line 69 of file stl_pair.h.
  • typedef Iterator2 std::pair< Iterator1 , Iterator2 >::second_type [inherited] β€” second_type is the second bound type. Definition at line 70 of file stl_pair.h.

πŸ“ Member Data Documentation πŸ“

  • Iterator1 std::pair< Iterator1 , Iterator2 >::first [inherited] β€” first is a copy of the first object. Definition at line 72 of file stl_pair.h.
  • Iterator2 std::pair< Iterator1 , Iterator2 >::second [inherited] β€” second is a copy of the second object. Definition at line 73 of file stl_pair.h.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for libstdc++ from the source code. So yeah, the robots wrote it, and they understood the assignment. πŸ€–βœ¨


Okay bestie, that's the whole page! Footer energy: source/version libstdc++, date 21 Apr 2009, and the footer tag is __gnu_para...erator_pair(3). πŸ’…πŸŽ€

πŸ“¦ where this page comes from