Cvc5OptionInfo
This struct encapsulates all the information associated with a configuration
option. It can be retrieved via
cvc5_get_option_info()
and allows to query any configuration information associated with an option.
The kind of an option info object is defined as enum
Cvc5OptionInfoKind
. Encapsulated values can be queried depending on
the kind.
-
enum
Cvc5OptionInfoKind
-
Values:
-
enumerator
CVC5_OPTION_INFO_VOID
-
The empty option info, does not hold value information.
-
enumerator
CVC5_OPTION_INFO_BOOL
-
Information for option with boolean option value.
-
enumerator
CVC5_OPTION_INFO_STR
-
Information for option with string option value.
-
enumerator
CVC5_OPTION_INFO_INT64
-
Information for option with int64 option value.
-
enumerator
CVC5_OPTION_INFO_UINT64
-
Information for option with uint64 option value.
-
enumerator
CVC5_OPTION_INFO_DOUBLE
-
Information for option with double value.
-
enumerator
CVC5_OPTION_INFO_MODES
-
Information for option with option modes.
-
enumerator
CVC5_OPTION_INFO_VOID
-
typedef
struct
Cvc5OptionInfo
Cvc5OptionInfo
-
A cvc5 option info.
-
struct
Cvc5OptionInfo
-
Holds information about a specific option, including its name, its aliases, whether the option was explicitly set by the user, and information concerning its value. It can be obtained via
cvc5_get_option_info()
and allows for a more detailed inspection of options thancvc5_get_option()
. Union memberinfo
holds any of the following alternatives:-
Neither of the following if the option holds no value (or the value has no native type). In that case, the kind of the option will be denoted as #CVC5_OPTION_INFO_VOID.
-
Struct
BoolInfo
if the option is of typebool
. It holds the current value and the default value of the option. Option kind is denoted as #CVC5_OPTION_INFO_BOOL. -
Struct
StringInfo
if the option is of typeconst char*
. It holds the current value and the default value of the option. Option kind is denoted as #CVC5_OPTION_INFO_STR. -
Struct
IntInfo
if the option is of typeint64_t
. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_INT64. -
Struct
UIntInfo
if the option is of typeuint64_t
. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_UINT64. -
Struct
DoubleInfo
if the option is of typedouble
. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_DOUBLE. -
Struct
ModeInfo
if the option has modes. It holds the current and default valuesof the option, as well as a list of valid modes. Option kind is denoted as #CVC5_OPTION_INFO_MODES.
Public Members
-
Cvc5OptionInfoKind
kind
-
The kind of the option info.
-
const
char
*
name
-
The option name
-
size_t
num_aliases
-
The number of option name aliases
-
const
char
*
*
aliases
-
The option name aliases
-
bool
is_set_by_user
-
True if the option was explicitly set by the user
-
bool
is_expert
-
True if the option is an expert option
-
bool
is_regular
-
True if the option is a regular option
-
void
*
d_cpp_info
-
The associated C++ info. For internal use, only.
-
struct
BoolInfo
-
Information for boolean option values.
-
struct
DoubleInfo
-
Information for double values.
-
struct
IntInfo
-
Information for int64 values.
-
struct
ModeInfo
-
Information for mode option values.
-
struct
StringInfo
-
Information for string option values.
-
struct
UIntInfo
-
Information for uint64 values.
-
Warning
doxygengroup: Cannot find group “c_cvc5optioninfo” in doxygen xml output for project “cvc5_c” from directory: /home/runner/work/cvc5/cvc5/build-shared/docs/api/c/doxygen/xml