SbHeap(3)

💖 SbHeap(3) 💖

okay bestie, pull up a chair, we're doing the SbHeap page from section 3 of the manual — it lives in the library functions manual and it's literally the generic heap class. yes. a heap. the data structure. she's iconic, she's generic, and she's about to be your new obsession. 🫶

---

✨ NAME ✨

SbHeap — the SbHeap class is a generic heap class. that's it, that's the whole vibe. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/SbHeap.h>

🎀 Public Member Functions 🎀

SbHeap (const SbHeapFuncs &SbHeapFuncs, const int initsize=1024)
~SbHeap ()
void emptyHeap (void)
int size (void) const
int add (void *obj)
void remove (const int pos)
void remove (void *obj)
void * extractMin ()
void * getMin ()
void * operator[] (const int idx)
void newWeight (void *obj, int hpos=-1)
SbBool buildHeap (SbBool(*progresscb)(float percentage, void
    *data)=NULL, void *data=NULL)
SbBool traverseHeap (SbBool(*func)(void *, void *), void *userdata)
    const

---

🦋 Detailed Description 🦋

the SbHeap class is a generic heap class. no cap, that's the whole pitch. ✨

FIXME: write doc

(yes bestie the docs really do say that. not me reading the source and finding a to-do note 😭 she's a work in progress and honestly? relatable.)

Note: SbHeap is an extension versus the Open Inventor API. so if you're out here comparing her to vanilla Open Inventor, know that she's extra. she's built different. periodt. 👑

---

💜 Constructor & Destructor Documentation 💜

🌟 SbHeap::SbHeap (const SbHeapFuncs & hFuncs, const int initsize = 1024)

Constructor time!! 🎉 hFuncs is the plug — it specifies the functions for modifying and returning information about the heap object. meanwhile initsize specifies the initial number of allocated elements.

the way that this array will automatically grow when necessary… like she's got your back, she scales. but lowkey, if you already know approximately how many elements the heap will contain, you should totally supply this to avoid some reallocs. future you will thank present you. 🫶

🌟 SbHeap::~SbHeap (void )

Destructor. she's done, she's logging off, cleanup complete. bye bestie 👋

---

🌈 Member Function Documentation 🌈

💅 void SbHeap::emptyHeap (void )

Removes all the elements from the heap. full reset. clean slate. it's giving fresh start energy. ✨

💅 int SbHeap::size (void ) const

Returns the number of elements in the heap. how many girls are in the group chat, basically. 🔢

💅 int SbHeap::add (void * obj)

Adds an element to the heap. and it returns the element's heap position — so you know exactly where she landed. iconic behaviour, honestly. 💖

💅 void SbHeap::remove (const int idx)

Removes an element from the heap. by index. bye diva 💀

💅 void SbHeap::remove (void * obj)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. so like, same girl, different door. 🚪

💅 void * SbHeap::extractMin (void )

Returns and removes the first element in the heap — or NULL if the heap is empty. she's leaving and taking the title with her. main character exit. 🚪✨

💅 void * SbHeap::getMin (void )

Returns the first element in the heap — or NULL if the heap is empty. she's still here, you're just looking respectfully. 👀

💅 void * SbHeap::operator[] (const int idx)

Returns the heap element at index idx in the heap. peek-a-boo, here's your element. 🎀

💅 void SbHeap::newWeight (void * obj, int hpos = -1)

Fixes the heap if necessary when the element at hpos has changed weight. glow-up detected, must re-sort. 💫

if you already know the element's heap position, you can supply it in hpos — save yourself the lookup, queen. 👑

💅 SbBool SbHeap::buildHeap (SbBool(* progresscb )(float percentage, void *data) = NULL, void * data = NULL)

Builds heap out of randomly ordered data-structure. chaotic pile of data in, actual heap out. it's giving organizational makeover montage. 🧚

💅 SbBool SbHeap::traverseHeap (SbBool(* func )(void *, void *), void * userdata) const

Traverses each heap element, and calls func for each element. every single one gets a little visit. so thorough, so attentive, we love a methodical queen. 🌸

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. so like, not a human author, a robot did her makeup. and she ate. 💅

---

reminder bestie: SbHeap is an extension versus the Open Inventor API — so don't go looking for her in the OG spec, she's Coin's bonus round. 💖

---

and that's the whole page, bestie!! 🫶 this was Coin, Version 3.1.3, and you just read SbHeap(3) — section 3 of the library functions manual, fr fr. go build a heap and slay. 🌈💜✨