rsb_opt_t

Enum rsb_opt_t 

Source
#[repr(u32)]
pub enum rsb_opt_t {
Show 19 variants RSB_IO_WANT_VERBOSE_INIT = 1, RSB_IO_WANT_VERBOSE_EXIT = 2, RSB_IO_WANT_OUTPUT_STREAM = 3, RSB_IO_WANT_SORT_METHOD = 4, RSB_IO_WANT_CACHE_BLOCKING_METHOD = 5, RSB_IO_WANT_SUBDIVISION_MULTIPLIER = 6, RSB_IO_WANT_VERBOSE_ERRORS = 7, RSB_IO_WANT_BOUNDED_BOX_COMPUTATION = 8, RSB_IO_WANT_EXECUTING_THREADS = 9, RSB_IO_WANT_EXTRA_VERBOSE_INTERFACE = 16, RSB_IO_WANT_MEMORY_HIERARCHY_INFO_STRING = 17, RSB_IO_WANT_IS_INITIALIZED_MARKER = 18, RSB_IO_WANT_MEM_ALLOC_CNT = 19, RSB_IO_WANT_MEM_ALLOC_TOT = 20, RSB_IO_WANT_LEAF_LEVEL_MULTIVEC = 21, RSB_IO_WANT_MAX_MEMORY_ALLOCATIONS = 22, RSB_IO_WANT_MAX_MEMORY_ALLOCATED = 23, RSB_IO_WANT_LIBRSB_ETIME = 24, RSB_IO_WANT_VERBOSE_TUNING = 25,
}
Expand description

\ingroup rsb_doc_misc rsb_doc_rsb \brief library option values for \see_lib_init_funcs.

Variants§

§

RSB_IO_WANT_VERBOSE_INIT = 1

#RSB_IO_WANT_VERBOSE_INIT prompts for a verbose initialization of the library: messages will be written to the file descriptor (\c FILE*) pointed by the value pointer when calling \ref rsb_lib_init.

§

RSB_IO_WANT_VERBOSE_EXIT = 2

#RSB_IO_WANT_VERBOSE_EXIT prompts for a verbose finalization of the library: messages will be written to the file descriptor (\c FILE*) pointed by the value pointer when calling \ref rsb_lib_exit.

§

RSB_IO_WANT_OUTPUT_STREAM = 3

Specifies the default output stream. Output (debug info) info will be written to the file descriptor (\c FILE*) pointed by the value pointer.

§

RSB_IO_WANT_SORT_METHOD = 4

Specifies the default sorting method. Specified as a pointed integer (#rsb_int_t) number, in {[0],1}. (internal)

§

RSB_IO_WANT_CACHE_BLOCKING_METHOD = 5

Specifies the default cache blocking method. Specified as a pointed integer (#rsb_int_t) number, in {-1,[0],1}. (internal)

§

RSB_IO_WANT_SUBDIVISION_MULTIPLIER = 6

Specifies a multiplier for finer (if >1.0) or coarser (if <1.0) subdivisions. Specified as a pointed (#rsb_real_t) number, in {..,[1.0],..}. (internal)

§

RSB_IO_WANT_VERBOSE_ERRORS = 7

Prompts for a verbose error reporting: messages will be written to the file descriptor (\c FILE*) pointed by the value pointer. Only meaningful if an interface error verbosity greater than 0 was set at configure time.

§

RSB_IO_WANT_BOUNDED_BOX_COMPUTATION = 8

Prompts for bounded box computation, for a smoother submatrices locking; pointed #rsb_int_t in {0,[1]}. (internal).

§

RSB_IO_WANT_EXECUTING_THREADS = 9

Specifies the number of desired executing threads; pointed #rsb_int_t in {[0],1,..}.

§

RSB_IO_WANT_EXTRA_VERBOSE_INTERFACE = 16

Specifies the level of interface verbosity; if setting, pointed #rsb_int_t values should be in {[0],1,..}. Support may be enabled or disabled at build time via the \c –enable-internals-error-verbosity configure option. If disabled, only getting is supported and yields -1, but setting is not supported and the #RSB_ERR_NO_STREAM_OUTPUT_CONFIGURED_OUT error will be returned.

§

RSB_IO_WANT_MEMORY_HIERARCHY_INFO_STRING = 17

Specifies a custom memory hierarchy info string; pointed \c const #rsb_char_t*; (may point to a NULL string pointer).

§

RSB_IO_WANT_IS_INITIALIZED_MARKER = 18

Used for getting whether the library has been initialized (#RSB_BOOL_TRUE) or not (#RSB_BOOL_FALSE) ; pointed \c const #rsb_bool_t*; (this is NOT for general users).

§

RSB_IO_WANT_MEM_ALLOC_CNT = 19

Used for getting the count of memory allocations performed by librsb employing librsb’s memory allocation wrapper (if disabled, will return zero); pointed \c const \c size_t*; (this is for debugging purposes).

§

RSB_IO_WANT_MEM_ALLOC_TOT = 20

Used for getting the total amount of memory allocated by librsb employing librsb’s memory allocation wrapper (if disabled, will return zero); pointed \c const \c size_t*; (this is for debugging purposes).

§

RSB_IO_WANT_LEAF_LEVEL_MULTIVEC = 21

Specifies whether the default multi-vector ops shall act at a leaf level (default value of 0 is yes). Specified as a pointed integer (#rsb_int_t) number, in {-1,[0]}. (internal)

§

RSB_IO_WANT_MAX_MEMORY_ALLOCATIONS = 22

Specifies an upper limit to the count of allocated memory areas (default value of 0 means no limit). Specified as a pointed \c size_t. \rsb_configure_memwrap

§

RSB_IO_WANT_MAX_MEMORY_ALLOCATED = 23

Specifies an upper limit to the amount of allocated memory (default value of 0 means no limit). Specified as a pointed \c size_t. \rsb_configure_memwrap

§

RSB_IO_WANT_LIBRSB_ETIME = 24

Represents time spent in librsb. Specified as a pointed #rsb_time_t. Only works if statistics collection (\c –enable-librsb-stats) was specified at configure time.

§

RSB_IO_WANT_VERBOSE_TUNING = 25

Auto tuning verbosity level for rsb_tune_spmm/rsb_tune_spsm. If 0, no verbosity; if 1, verbose; if 2, verbose with trace files being dumped.

Trait Implementations§

Source§

impl Clone for rsb_opt_t

Source§

fn clone(&self) -> rsb_opt_t

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for rsb_opt_t

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Hash for rsb_opt_t

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for rsb_opt_t

Source§

fn eq(&self, other: &rsb_opt_t) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for rsb_opt_t

Source§

impl Eq for rsb_opt_t

Source§

impl StructuralPartialEq for rsb_opt_t

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.