SC_AVLSET_ITERATOR(3)

πŸ“¦
version 2.3.1 Β· 4 versions
, in fedora 43, ubuntu noble

πŸ’– NAME πŸ’–

sc::AVLSet< K >::iterator β€” bestie, you've landed in the Library Functions Manual (section 3), and this is the iterator that lives inside the sc::AVLSet< K > template. It's a whole vibe of its own, so let's get into it. πŸ¦‹


✨ SYNOPSIS ✨

πŸŽ€ Public Member Functions πŸŽ€

Ok so here's the full roster, no cuts, no skips, exactly as written:

iterator (const EAVLMMap< K, AVLMapNode< K, int > > *m, const
    AVLMapNode< K, int > *n)
iterator (const eavl_typename AVLSet< K >::iterator &i)
void operator++ ()
void operator++ (int)
int operator== (const eavl_typename AVLSet< K >::iterator &i) const
int operator!= (const eavl_typename AVLSet< K >::iterator &i) const
void operator= (const eavl_typename AVLSet< K >::iterator &i)
const K & key () const
const K & operator* () const

Now let's go one by one, because every single one of these is here and every single one of these gets its moment πŸ’…:

  • iterator (const EAVLMMap< K, AVLMapNode< K, int > > *m, const AVLMapNode< K, int > *n) β€” the constructor that takes two pointers: an EAVLMMap< K, AVLMapNode< K, int > > * called m, and an AVLMapNode< K, int > * called n. That's the whole signature, fr fr.
  • iterator (const eavl_typename AVLSet< K >::iterator &i) β€” the copy-ish constructor, taking a reference to an eavl_typename AVLSet< K >::iterator named i.
  • void operator++ () β€” the pre-increment. No args, returns void. That's it, that's the whole thing.
  • void operator++ (int) β€” the post-increment, the one with the mystery int in the parens. Also returns void, bestie.
  • int operator== (const eavl_typename AVLSet< K >::iterator &i) const β€” the equality comparison against another eavl_typename AVLSet< K >::iterator named i. It's const, and it hands you back an int.
  • int operator!= (const eavl_typename AVLSet< K >::iterator &i) const β€” same energy, but it's the not-equal one. Also const, also returns int, also takes that eavl_typename AVLSet< K >::iterator &i.
  • void operator= (const eavl_typename AVLSet< K >::iterator &i) β€” the assignment operator, takes the eavl_typename AVLSet< K >::iterator &i reference, returns void.
  • const K & key () const β€” no arguments, it's const, and it gives you back a const K &.
  • const K & operator* () const β€” the dereference operator. No arguments, const, and it also returns a const K &.
Not me listing all nine of these with the exact types intact 😭 β€” that's the assignment, and we do not skip a single one on this page. Periodt.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. Iconic behaviour from a doc generator, honestly. 🌈


And that's the whole page, bestie β€” no notes, no crumbs left behind. 🫢 This lil' legend comes to you courtesy of MPQC, Version 2.3.1, so big ups to the source code for making it happen. Go forth and iterate. 🧚✨

πŸ“¦ where this page comes from