logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

RsbLib - Class initializing/finalizing librsb state.

Author

       Generated automatically by Doxygen for librsb from the source code.

librsb                                           Version 1.3.0.2                                       RsbLib(3)

Constructor & Destructor Documentation

RSBP_DEPRECATEDRsbLib::RsbLib(boolverbose)[inline]
       Initialize librsb.

       Seealsorsb_lib_reinit().

   RsbLib::RsbLib(void)[inline]
       Initialize librsb.

       Seealsorsb_lib_reinit().

   RsbLib::~RsbLib(void)[inline]
       Destructor: finalize librsb.

       This is being invoked at the end of the scope of a RsbLibobject:typicallyatapplication'send.

Detailed Description

       Class initializing/finalizing librsb state.

       Before creating any RsbMatrixobjects,makesureyouhaveinitializedlibrsbbycreatingonesingleRsbLibobject.Similarly,RsbMatrixobjectshallleavescopeaftertheRsbLibobjecthasbeendeallocated.

       Several librsb options can be queried or changed via e.g. get_opt(), set_opt(), get_num_threads(),
       set_num_threads().

Member Function Documentation

rsb_int_tRsbLib::get_num_threads(void)const[inline]
       Indirect interface to rsb_lib_get_opt.

   rsb_string_tRsbLib::get_opt(enumrsb_opt_tiof)const[inline]
       Interface to rsb_lib_get_opt.

       Warning
           Only RSB_IO_WANT_MEMORY_HIERARCHY_INFO_STRING is supported for now.

   RSBP_RVTErr_tRsbLib::get_opt(enumrsb_opt_tiof,void*iop)const[inline]
       Interface to rsb_lib_get_opt.

   size_tRsbLib::meminfo(void)[inline]
       Provide memory debug info from librsb and return usage amount. Only effective if librsb configured
       accordingly.

       On error, throw an exception.

   RSBP_RVTErr_tRsbLib::reinit(structrsb_initopts*iop)[inline]
       Interface to rsb_lib_reinit().

   RSBP_RVTErr_tRsbLib::set_num_threads(rsb_int_tnt)[inline]
       Indirect interface to rsb_lib_set_opt.

   RSBP_RVTErr_tRsbLib::set_opt(enumrsb_opt_tiof,constvoid*iop)[inline]
       Interface to rsb_lib_set_opt.

   RSBP_RVTErr_tRsbLib::set_opt_str(constrsb_char_t*opnp,constrsb_char_t*opvp)[inline]
       Interface to rsb_lib_set_opt_str.

Name

       RsbLib - Class initializing/finalizing librsb state.

Synopsis

       #include <rsb.hpp>

   PublicMemberFunctionsRSBP_RVTErr_tset_opt_str (constrsb_char_t *opnp, constrsb_char_t *opvp)
       RSBP_RVTErr_tset_opt (enumrsb_opt_tiof, constvoid *iop)
       RSBP_RVTErr_tget_opt (enumrsb_opt_tiof, void *iop) constrsb_string_tget_opt (enumrsb_opt_tiof) constRSBP_RVTErr_tset_num_threads (rsb_int_tnt)
       rsb_int_tget_num_threads (void) constRSBP_RVTErr_treinit (structrsb_initopts *iop)
       RSBP_DEPRECATEDRsbLib (boolverbose)
       RsbLib (void)
       size_tmeminfo (void)
       ~RsbLib (void)

See Also