Crate librsb_sys

Expand description

FFI interface for librsb.

§Usage

In order to conditionally generate bindings and documents, it is suggested to use the following snipplet in Cargo.toml.

[dependencies]
librsb-sys = "X.Y.Z"  # Fill the version here

[features]
codegen = ["librsb-sys/codegen"]
doc-only = ["librsb-sys/doc-only"]

[package.metadata.docs.rs]
features = ["doc-only"]

§Cargo Features

codegen

Generate FFI bindings from header files.
doc-only

Disable binding generation and linking.

§Environment Variables

The librsb-sys reads the following environment variables.

LIBRSB_PATH

The prefix path of the installed librsb library. It defaults to /usr if not set.
LIBRSB_INCLUDE

The directory to search for C header files. It defaults to $LIBRSB_PATH/include if not set.
LIBRSB_LIBRARY

The directory to search for library files. It defaults to $LIBRSB_PATH/lib if not set.

Structs§

blas_handle_type: The following are not fully implemented. Usable with #BLAS_usgp.
blas_sparse_matrix: the sparse matrix descriptor type
rsb_err_t: A type specific for error flags. Should be >= 4 bytes.
rsb_initopts: @brief A structure specifying library (initialization) options, to be used with the \ref rsb_lib_reinit() function. \n
rsb_mtx_t
rsb_trans_t: The type for specifying transposition (See \ref matrix_transposition_flags_section)
rsb_type_t: A type for specifying numerical type codes (See \ref matrix_type_symbols_section for a list of valid values).

Enums§

blas_base_type: Index base (valid at matrix build/modify time).
blas_cmach_type: Unused/Unsupported.
blas_conj_type: Unused/Unsupported.
blas_diag_type: Specifies (#BLAS_ussp) or inquiries (#BLAS_usgp) whether the diagonal of a matrix is (implicitly) unitary or not.
blas_field_type: Numerical field type; can be used with #BLAS_usgp to inquiry about a matrix numerical type (1 will be returned in case of success, 0 in case of failure).
blas_jrot_type: Unused/Unsupported.
blas_norm_type: Unused/Unsupported.
blas_order_type: Used to specify a dense array’s elements layout.
blas_prec_type: Unused/Unsupported.
blas_rsb_ext_type: Properties suitable to be used with #BLAS_ussp/#BLAS_usgp. All of these are not in the Sparse BLAS standard.
blas_side_type: Unused/Unsupported.
blas_size_type: Quantities that can be obtained via #BLAS_usgp.
blas_sort_type: Unused/Unsupported.
blas_sparsity_optimization_type: The following are usable with #BLAS_usgp only.
blas_symmetry_type: Symmetry properties. If not specified otherwise, valid for the both of #BLAS_ussp and #BLAS_usgp.
blas_trans_type: Used to specify a transposition operator to a matrix operand.
blas_uplo_type: Specifies (#BLAS_ussp) or inquiries (#BLAS_usgp) upper or lower triangularity of a matrix.
rsb_elopf_t: \ingroup rsb_doc_misc rsb_doc_rsb \brief Flags for specifying a particular elemental/row-wise operation with #rsb_mtx_upd_vals().
rsb_extff_t: \ingroup rsb_doc_misc rsb_doc_rsb \brief Extraction filter flags, to be used with #rsb_mtx_get_nrm()/#rsb_mtx_get_vec().
rsb_mif_t: \ingroup rsb_doc_misc rsb_doc_rsb \brief Flags for getting matrix information via #rsb_mtx_get_info()/#rsb_mtx_get_info_str().
rsb_opt_t: \ingroup rsb_doc_misc rsb_doc_rsb \brief library option values for \see_lib_init_funcs.

Constants§

Functions§

Type Aliases§

rsb_blk_idx_t: \name Type definitions \anchor definitions_section
rsb_bool_t: A boolean type.
rsb_char_t: A type for character strings.
rsb_coo_idx_t: The coordinate arrays index type.
rsb_flags_t: A type for specifying matrix assembly or coordinate conversions option flags. Should be >= 4 bytes. See \ref flags_section for possible values.
rsb_int_t: An integer type declaration for interface functions. Should always be ‘int’.
rsb_marf_t
rsb_nnz_idx_t: The nnz counter index type.
rsb_precf_t
rsb_real_t: A floating point numerical type.
rsb_time_t: A floating point numerical type for time measurements with #rsb_time().
size_t

Crate librsb_sys

Crate librsb_sys Copy item path

§Usage

§Cargo Features

§Environment Variables

Structs§

Enums§

Constants§

Functions§

Type Aliases§

Crate librsb_sys