__GNU_PARALLEL::_RESTRICTEDBOUNDEDCONCURRENTQUEUE(3)

🌸 __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp > 💖

okay bestie, buckle up, because this one lives in the Library Functions Manual and it is such a mood. it's a template class from the __gnu_parallel crew, and it's giving "lock-free but with rules" energy. let's get into it ✨

---

✨ NAME ✨

__gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp > — a double-ended queue of bounded size, allowing lock-free atomic access.

so like, here's the tea 🫖: push_front() and pop_front() must not be called concurrently to each other, while pop_back() can be called concurrently at all times. and empty(), size(), and top() are intentionally not provided — calling them would not make sense in a concurrent setting. periodt. 💅

---

🦋 SYNOPSIS 🦋

#include <queue.h>

🌈 Public Member Functions 🌈

• _RestrictedBoundedConcurrentQueue(_SequenceIndex __max_size) — the Constructor. Not to be called concurrent, of course. 💀
• ~_RestrictedBoundedConcurrentQueue() — the Destructor. Not to be called concurrent, of course. same vibe, same warning 🙈
• bool pop_back(_Tp &__t) — Pops one element from the queue at the front end. Must not be called concurrently with pop_front().
• bool pop_front(_Tp &__t) — Pops one element from the queue at the front end. Must not be called concurrently with pop_front().
• void push_front(const _Tp &__t) — Pushes one element into the queue at the front end. Must not be called concurrently with pop_front().

---

👑 Detailed Description 👑

template<typename _Tp>
class __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >

Double-ended queue of bounded size, allowing lock-free atomic access. push_front() and pop_front() must not be called concurrently to each other, while pop_back() can be called concurrently at all times. empty(), size(), and top() are intentionally not provided. Calling them would not make sense in a concurrent setting. no cap, that's the whole design philosophy fr fr 🧚

Parameters

• _Tp — Contained element type. ✨

---

🎀 Constructor & Destructor Documentation 🎀

_RestrictedBoundedConcurrentQueue(_SequenceIndex __max_size) [inline]

template<typename _Tp>
__gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >::_RestrictedBoundedConcurrentQueue(_SequenceIndex __max_size)

Constructor. Not to be called concurrent, of course. 😭

Parameters

• __max_size — Maximal number of elements to be contained.

References __gnu_parallel::__encode2().

~_RestrictedBoundedConcurrentQueue() [inline]

template<typename _Tp>
__gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >::~_RestrictedBoundedConcurrentQueue()

Destructor. Not to be called concurrent, of course. 🙈

---

💜 Member Function Documentation 💜

pop_back [inline]

template<typename _Tp>
bool __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >::pop_back(_Tp & __t)

Pops one element from the queue at the front end. Must not be called concurrently with pop_front().

References __gnu_parallel::__compare_and_swap(), __gnu_parallel::__decode2(), and __gnu_parallel::__encode2().

pop_front [inline]

template<typename _Tp>
bool __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >::pop_front(_Tp & __t)

Pops one element from the queue at the front end. Must not be called concurrently with pop_front().

References __gnu_parallel::__compare_and_swap(), __gnu_parallel::__decode2(), and __gnu_parallel::__encode2().

push_front [inline]

template<typename _Tp>
void __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp >::push_front(const _Tp & __t)

Pushes one element into the queue at the front end. Must not be called concurrently with pop_front().

References __gnu_parallel::__decode2(), __gnu_parallel::__encode2(), and __gnu_parallel::__fetch_and_add().

---

🌟 Author 🌟

Generated automatically by Doxygen for libstdc++ from the source code. the robots did this one, not me 💅

---

⭐ little reminder bestie: push_front() and pop_front() are not concurrent-with-each-other safe, and empty(), size(), top() straight up don't exist here. respect the rules and she'll slay for you. 💖

and that's the whole page!! sourced from libstdc++, straight out of the Library Functions Manual, __gnu_para...eue< _Tp >(3) — ily, go write some lock-free code responsibly 🫶✨🦋🌸