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.

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 than cvc5_get_option(). Union member info 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 type bool. 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 type const 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 type int64_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 type uint64_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 type double. 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.

Note

A typedef alias with the same name is also available for convenience.

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

size_t num_no_supports

The number of unsupported features

const char **no_supports

The unsupported features

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

Warning

This field is deprecated and replaced by category. It will be removed in a future release.

bool is_regular

True if the option is a regular option

Warning

This field is deprecated and replaced by category. It will be removed in a future release.

Cvc5OptionCategory category

The category of this option.

void *d_cpp_info

The associated C++ info. For internal use, only.

struct BoolInfo

Information for boolean option values.

Public Members

bool dflt

The default value.

bool cur

The current value.

struct DoubleInfo

Information for double values.

Public Members

double dflt

The default value.

double cur

The current value.

double min

The minimum value.

double max

The maximum value.

bool has_min

True if option has a minimum value.

bool has_max

True if option has a maximum value.

struct IntInfo

Information for int64 values.

Public Members

int64_t dflt

The default value.

int64_t cur

The current value.

int64_t min

The minimum value.

int64_t max

The maximum value.

bool has_min

True if option has a minimum value.

bool has_max

True if option has a maximum value.

struct ModeInfo

Information for mode option values.

Public Members

const char *dflt

The default value.

const char *cur

The current value.

size_t num_modes

The number of possible modes.

const char **modes

The possible modes.

struct StringInfo

Information for string option values.

Public Members

const char *dflt

The default value.

const char *cur

The current value.

struct UIntInfo

Information for uint64 values.

Public Members

uint64_t dflt

The default value.

uint64_t cur

The current value.

uint64_t min

The minimum value.

uint64_t max

The maximum value.

bool has_min

True if option has a minimum value.

bool has_max

True if option has a maximum value.

const char *cvc5_option_info_to_string(const Cvc5OptionInfo *info)

Get a string representation of a given option info.

Note

The returned char* pointer is only valid until the next call to this function.

Parameters:

info – The option info.

Returns:

The string representation.