RsbLib(3)

📦
version 1.3.0.3 · 4 versions
, in ubuntu stonking

💖 RsbLib(3) — the librsb init/finalize glow-up 💖

okay bestie, settle in, because this is the RsbLib page from the Library Functions Manual and it's literally the class that turns librsb on and off. main character energy for your whole program tbh.

✨ NAME ✨

RsbLib — the class that initializes and finalizes librsb state. she's the on/off switch, the vibe gatekeeper, the whole thing 💅

🌸 SYNOPSIS 🌸

#include <rsb.hpp>

🎀 Public Member Functions 🎀

  • RSBP_RVT Err_t set_opt_str (const rsb_char_t *opnp, const rsb_char_t *opvp)
  • RSBP_RVT Err_t set_opt (enum rsb_opt_t iof, const void *iop)
  • RSBP_RVT Err_t get_opt (enum rsb_opt_t iof, void *iop) const
  • rsb_string_t get_opt (enum rsb_opt_t iof) const
  • RSBP_RVT Err_t set_num_threads (rsb_int_t nt)
  • rsb_int_t get_num_threads (void) const
  • RSBP_RVT Err_t reinit (struct rsb_initopts *iop)
  • RSBP_DEPRECATED RsbLib (bool verbose)
  • RsbLib (void)
  • size_t meminfo (void)
  • ~RsbLib (void)

🦋 Detailed Description 🦋

Class initializing/finalizing librsb state. 💖

Before you go making any RsbMatrix objects, make sure you've initialized librsb by creating one single RsbLib object. no cap. and similarly, RsbMatrix objects shall leave scope after the RsbLib object has been deallocated. the vibes must be in that order, fr fr 🫶

Several librsb options can be queried or changed via, like, get_opt(), set_opt(), get_num_threads(), set_num_threads(). so many knobs and she lets you touch them all ✨

🌈 Constructor & Destructor Documentation 🌈

💜 RSBP_DEPRECATED RsbLib::RsbLib (bool verbose) [inline]

Initialize librsb. ✨

See also: rsb_lib_reinit().

💜 RsbLib::RsbLib (void ) [inline]

Initialize librsb. ✨

See also: rsb_lib_reinit().

💜 RsbLib::~RsbLib (void ) [inline]

Destructor: finalize librsb. 😭

This is being invoked at the end of the scope of a RsbLib object — typically at the application's end. it's the goodbye hug, the closing credits, the lights going down 🕯️

⭐ Member Function Documentation ⭐

🍓 rsb_int_t RsbLib::get_num_threads (void ) const [inline]

Indirect interface to rsb_lib_get_opt.

🍓 rsb_string_t RsbLib::get_opt (enum rsb_opt_t iof) const [inline]

Interface to rsb_lib_get_opt.

⚠️ Warning: only RSB_IO_WANT_MEMORY_HIERARCHY_INFO_STRING is supported for now. bestie, don't try to be clever with other values, she said what she said 💀

🍓 RSBP_RVT Err_t RsbLib::get_opt (enum rsb_opt_t iof, void * iop) const [inline]

Interface to rsb_lib_get_opt.

🍓 size_t RsbLib::meminfo (void ) [inline]

Provide memory debug info from librsb and return the usage amount. Only effective if librsb was configured accordingly 👀

On error, throw an exception. so like, be ready for drama 😭

🍓 RSBP_RVT Err_t RsbLib::reinit (struct rsb_initopts * iop) [inline]

Interface to rsb_lib_reinit().

🍓 RSBP_RVT Err_t RsbLib::set_num_threads (rsb_int_t nt) [inline]

Indirect interface to rsb_lib_set_opt.

🍓 RSBP_RVT Err_t RsbLib::set_opt (enum rsb_opt_t iof, const void * iop) [inline]

Interface to rsb_lib_set_opt.

🍓 RSBP_RVT Err_t RsbLib::set_opt_str (const rsb_char_t * opnp, const rsb_char_t * opvp) [inline]

Interface to rsb_lib_set_opt_str.

👑 Author 👑

Generated automatically by Doxygen for librsb from the source code. 🤖✨

and that's the whole page, bestie! 🎀 sign-off time: this is from librsb, version 1.3.0.3, and the page itself is RsbLib(3) — go forth and initialize responsibly, ily 💖🦋🌸

📦 where this page comes from