stim::lib namespace

Functions

auto check_abi() -> result noexcept

Checks the ABI of the compiled library against the host application.

auto compiler() -> string_view noexcept

Returns the compiler used to build the library.

auto debug_build() -> bool noexcept

Returns true if this build of the library had internal debug logging and assertions enabled.

auto git_branch() -> string_view noexcept

Returns the git branch of the library when it was built.

auto git_commit_description() -> string_view noexcept

Returns the git commit description of the library when it was built.

auto git_commit_hash() -> string_view noexcept

Returns the git commit hash of the library when it was built.

auto handle() -> void* noexcept

Returns the runtime handle of the library (e.g. HMODULE on Windows).

auto header_checksum() -> string_view noexcept

Returns the SHA-256 checksum of stim.h when the library was compiled.

auto logging_categories() -> log_categories noexcept

Returns a mask of the categories of log messages that the library may emit.

auto logging_enabled() -> bool noexcept

Returns true if the library was built with logging.

auto profiler_enabled() -> bool noexcept

Returns true if the library was built with the internal profiler enabled.

auto version() -> string_view noexcept

Returns the library's full version string.

auto version_major() -> unsigned short noexcept

Returns the library's major version number.

auto version_minor() -> unsigned short noexcept

Returns the library's minor version number.

auto version_patch() -> unsigned short noexcept

Returns the library's patch number.

Function documentation

auto abi = stim::lib::check_abi();
if (!abi)
    std::cerr << abi.error();

Library ABI mismatch! simulation_flags had unexpected size, alignment, offset or type traits

std::cout << stim::lib::compiler();

MSVC 19.28.29913

std::cout << stim::lib::git_branch();

develop

std::cout << stim::lib::git_commit_description();

v0.2.0-4-gd841e0d0e1

std::cout << stim::lib::git_commit_hash();

fd40b1922f317926e029bcd3ec64ec5b44dc6955

std::cout << stim::lib::header_checksum();

fc5262d877b9f6b30de4b7aadd9ab47c4a7a865d0abc9ce567cd8c4696b5cf79

std::cout << stim::lib::version();

0.2.0