__GNU_CXX::HASH_SET(3)

💖 __gnu_cxx::hash_set< _Value, _HashFcn, _EqualKey, _Alloc > 💖

okay bestie, welcome to the Library Functions Manual, section 3 — this is the libstdc++ corner of the universe, and today's main character is a class that is, and I quote, an SGI extension. Buckle up, it's giving retro-but-make-it-cute. 🦋

---

✨ NAME ✨

__gnu_cxx::hash_set< _Value, _HashFcn, _EqualKey, _Alloc > — yeah that's the whole name, it's a mouthful, I know, but she's iconic and she's a hash set. 💅

---

🌸 SYNOPSIS 🌸

First things first, no cap:

#include <hash_set>

🌈 Public Types

These are the type aliases she's serving, verbatim, don't touch:

typedef _Ht::allocator_type allocator_type
typedef _Ht::const_iterator const_iterator
typedef _Alloc_traits::const_pointer const_pointer
typedef _Alloc_traits::const_reference const_reference
typedef _Ht::difference_type difference_type
typedef _Ht::hasher hasher
typedef _Ht::const_iterator iterator
typedef _Ht::key_equal key_equal
typedef _Ht::key_type key_type
typedef _Alloc_traits::pointer pointer
typedef _Alloc_traits::reference reference
typedef _Ht::size_type size_type
typedef _Ht::value_type value_type

bestie, look at how iterator is declared: typedef _Ht::const_iterator iterator. Yeah. That's what it says. 👀

💅 Public Member Functions

The whole roster, exactly as she comes, nothing cut:

template<class _InputIterator> hash_set (_InputIterator __f, _InputIterator __l)
template<class _InputIterator> hash_set (_InputIterator __f, _InputIterator __l, size_type __n)
template<class _InputIterator> hash_set (_InputIterator __f, _InputIterator __l, size_type __n, const hasher &__hf)
template<class _InputIterator> hash_set (_InputIterator __f, _InputIterator __l, size_type __n, const hasher &__hf, const key_equal &__eql, const allocator_type &__a=allocator_type())
hash_set (size_type __n)
hash_set (size_type __n, const hasher &__hf)
hash_set (size_type __n, const hasher &__hf, const key_equal &__eql, const allocator_type &__a=allocator_type())
iterator begin () const
size_type bucket_count () const
void clear ()
size_type count (const key_type &__key) const
size_type elems_in_bucket (size_type __n) const
bool empty () const
iterator end () const
pair< iterator, iterator > equal_range (const key_type &__key) const
size_type erase (const key_type &__key)
void erase (iterator __f, iterator __l)
void erase (iterator __it)
iterator find (const key_type &__key) const
allocator_type get_allocator () const
hasher hash_funct () const
template<class _InputIterator> void insert (_InputIterator __f, _InputIterator __l)
pair< iterator, bool > insert (const value_type &__obj)
pair< iterator, bool > insert_noresize (const value_type &__obj)
key_equal key_eq () const
size_type max_bucket_count () const
size_type max_size () const
void resize (size_type __hint)
size_type size () const
void swap (hash_set &__hs)

🫶 Friends

Exactly one (1) friend, and she returns a bool:

template<class _Val, class _HF, class _EqK, class _Al> bool operator== (const hash_set< _Val, _HF, _EqK, _Al > &, const hash_set< _Val, _HF, _EqK, _Al > &)

---

🦋 Detailed Description 🦋

Here's the actual shape of the class, template params and all:

template<class _Value, class _HashFcn = hash<_Value>, class _EqualKey = equal_to<_Value>, class _Alloc = allocator<_Value>>
class __gnu_cxx::hash_set< _Value, _HashFcn, _EqualKey, _Alloc >

And then the lore, fr fr:

This is an SGI extension.

📌 Todo

Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

(Yeah. The docs literally say the docs need docs. We love a self-aware queen. 😭)

---

👑 Author 👑

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

---

And that's the whole page, bestie, you ate. 🌸 This one lives in libstdc++'s Library Functions Manual, section 3 — no date on this one, she's timeless, iykyk. ✨🫶💖