Skip to content

Commit e89bb37

Browse files
waywardmonkeysNikolajBjorner
waywardmonkeys
authored and
NikolajBjorner
committed
More see also content in C API docs.
1 parent 375c0ff commit e89bb37

File tree

3 files changed

+89
-5
lines changed

3 files changed

+89
-5
lines changed

‎src/api/z3_api.h

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1456,6 +1456,9 @@ extern "C" {
14561456
Z3_global_param_set('pp.decimal', 'true')
14571457
will set the parameter "decimal" in the module "pp" to true.
14581458
1459+
\sa Z3_global_param_get
1460+
\sa Z3_global_param_reset_all
1461+
14591462
def_API('Z3_global_param_set', VOID, (_in(STRING), _in(STRING)))
14601463
*/
14611464
void Z3_API Z3_global_param_set(Z3_string param_id, Z3_string param_value);
@@ -1465,6 +1468,7 @@ extern "C" {
14651468
\brief Restore the value of all global (and module) parameters.
14661469
This command will not affect already created objects (such as tactics and solvers).
14671470
1471+
\sa Z3_global_param_get
14681472
\sa Z3_global_param_set
14691473
14701474
def_API('Z3_global_param_reset_all', VOID, ())
@@ -1476,6 +1480,7 @@ extern "C" {
14761480
14771481
Returns \c false if the parameter value does not exist.
14781482
1483+
\sa Z3_global_param_reset_all
14791484
\sa Z3_global_param_set
14801485
14811486
\remark This function cannot be invoked simultaneously from different threads without synchronization.
@@ -1997,6 +2002,10 @@ extern "C" {
19972002
sort reference is 0, then the value in sort_refs should be an index referring to
19982003
one of the recursive datatypes that is declared.
19992004
2005+
\sa Z3_del_constructor
2006+
\sa Z3_mk_constructor_list
2007+
\sa Z3_query_constructor
2008+
20002009
def_API('Z3_mk_constructor', CONSTRUCTOR, (_in(CONTEXT), _in(SYMBOL), _in(SYMBOL), _in(UINT), _in_array(3, SYMBOL), _in_array(3, SORT), _in_array(3, UINT)))
20012010
*/
20022011
Z3_constructor Z3_API Z3_mk_constructor(Z3_context c,
@@ -2014,6 +2023,8 @@ extern "C" {
20142023
\param c logical context.
20152024
\param constr constructor.
20162025
2026+
\sa Z3_mk_constructor
2027+
20172028
def_API('Z3_del_constructor', VOID, (_in(CONTEXT), _in(CONSTRUCTOR)))
20182029
*/
20192030
void Z3_API Z3_del_constructor(Z3_context c, Z3_constructor constr);
@@ -2027,6 +2038,10 @@ extern "C" {
20272038
\param num_constructors number of constructors passed in.
20282039
\param constructors array of constructor containers.
20292040
2041+
\sa Z3_mk_constructor
2042+
\sa Z3_mk_constructor_list
2043+
\sa Z3_mk_datatypes
2044+
20302045
def_API('Z3_mk_datatype', SORT, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _inout_array(2, CONSTRUCTOR)))
20312046
*/
20322047
Z3_sort Z3_API Z3_mk_datatype(Z3_context c,
@@ -2041,6 +2056,9 @@ extern "C" {
20412056
\param num_constructors number of constructors in list.
20422057
\param constructors list of constructors.
20432058
2059+
\sa Z3_del_constructor_list
2060+
\sa Z3_mk_constructor
2061+
20442062
def_API('Z3_mk_constructor_list', CONSTRUCTOR_LIST, (_in(CONTEXT), _in(UINT), _in_array(1, CONSTRUCTOR)))
20452063
*/
20462064
Z3_constructor_list Z3_API Z3_mk_constructor_list(Z3_context c,
@@ -2055,6 +2073,8 @@ extern "C" {
20552073
\param c logical context.
20562074
\param clist constructor list container.
20572075
2076+
\sa Z3_mk_constructor_list
2077+
20582078
def_API('Z3_del_constructor_list', VOID, (_in(CONTEXT), _in(CONSTRUCTOR_LIST)))
20592079
*/
20602080
void Z3_API Z3_del_constructor_list(Z3_context c, Z3_constructor_list clist);
@@ -2068,6 +2088,10 @@ extern "C" {
20682088
\param sorts array of datatype sorts.
20692089
\param constructor_lists list of constructors, one list per sort.
20702090
2091+
\sa Z3_mk_constructor
2092+
\sa Z3_mk_constructor_list
2093+
\sa Z3_mk_datatype
2094+
20712095
def_API('Z3_mk_datatypes', VOID, (_in(CONTEXT), _in(UINT), _in_array(1, SYMBOL), _out_array(1, SORT), _inout_array(1, CONSTRUCTOR_LIST)))
20722096
*/
20732097
void Z3_API Z3_mk_datatypes(Z3_context c,
@@ -2086,6 +2110,8 @@ extern "C" {
20862110
\param tester constructor test function declaration, allocated by user.
20872111
\param accessors array of accessor function declarations allocated by user. The array must contain num_fields elements.
20882112
2113+
\sa Z3_mk_constructor
2114+
20892115
def_API('Z3_query_constructor', VOID, (_in(CONTEXT), _in(CONSTRUCTOR), _in(UINT), _out(FUNC_DECL), _out(FUNC_DECL), _out_array(2, FUNC_DECL)))
20902116
*/
20912117
void Z3_API Z3_query_constructor(Z3_context c,
@@ -2114,6 +2140,8 @@ extern "C" {
21142140
application.
21152141
21162142
\sa Z3_mk_app
2143+
\sa Z3_mk_fresh_func_decl
2144+
\sa Z3_mk_rec_func_decl
21172145
21182146
def_API('Z3_mk_func_decl', FUNC_DECL, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SORT), _in(SORT)))
21192147
*/
@@ -2126,7 +2154,9 @@ extern "C" {
21262154
/**
21272155
\brief Create a constant or function application.
21282156
2157+
\sa Z3_mk_fresh_func_decl
21292158
\sa Z3_mk_func_decl
2159+
\sa Z3_mk_rec_func_decl
21302160
21312161
def_API('Z3_mk_app', AST, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT), _in_array(2, AST)))
21322162
*/
@@ -2145,8 +2175,9 @@ extern "C" {
21452175
Z3_ast n = Z3_mk_app(c, d, 0, 0);
21462176
\endcode
21472177
2148-
\sa Z3_mk_func_decl
21492178
\sa Z3_mk_app
2179+
\sa Z3_mk_fresh_const
2180+
\sa Z3_mk_func_decl
21502181
21512182
def_API('Z3_mk_const', AST, (_in(CONTEXT), _in(SYMBOL), _in(SORT)))
21522183
*/
@@ -2176,8 +2207,10 @@ extern "C" {
21762207
21772208
\remark If \c prefix is \c NULL, then it is assumed to be the empty string.
21782209
2179-
\sa Z3_mk_func_decl
21802210
\sa Z3_mk_app
2211+
\sa Z3_mk_const
2212+
\sa Z3_mk_fresh_func_decl
2213+
\sa Z3_mk_func_decl
21812214
21822215
def_API('Z3_mk_fresh_const', AST, (_in(CONTEXT), _in(STRING), _in(SORT)))
21832216
*/
@@ -2197,8 +2230,9 @@ extern "C" {
21972230
The function #Z3_mk_app can be used to create a constant or function
21982231
application.
21992232
2200-
\sa Z3_mk_app
22012233
\sa Z3_add_rec_def
2234+
\sa Z3_mk_app
2235+
\sa Z3_mk_func_decl
22022236
22032237
def_API('Z3_mk_rec_func_decl', FUNC_DECL, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SORT), _in(SORT)))
22042238
*/
@@ -5557,21 +5591,27 @@ extern "C" {
55575591
/**
55585592
\brief Return Z3 version number information.
55595593
5594+
\sa Z3_get_full_version
5595+
55605596
def_API('Z3_get_version', VOID, (_out(UINT), _out(UINT), _out(UINT), _out(UINT)))
55615597
*/
55625598
void Z3_API Z3_get_version(unsigned * major, unsigned * minor, unsigned * build_number, unsigned * revision_number);
55635599

55645600
/**
5565-
\brief Return a string that fully describes the version of Z3 in use.
5601+
\brief Return a string that fully describes the version of Z3 in use.
5602+
5603+
\sa Z3_get_version
55665604
5567-
def_API('Z3_get_full_version', STRING, ())
5605+
def_API('Z3_get_full_version', STRING, ())
55685606
*/
55695607
Z3_string Z3_API Z3_get_full_version(void);
55705608

55715609
/**
55725610
\brief Enable tracing messages tagged as \c tag when Z3 is compiled in debug mode.
55735611
It is a NOOP otherwise
55745612
5613+
\sa Z3_disable_trace
5614+
55755615
def_API('Z3_enable_trace', VOID, (_in(STRING),))
55765616
*/
55775617
void Z3_API Z3_enable_trace(Z3_string tag);
@@ -5580,6 +5620,8 @@ extern "C" {
55805620
\brief Disable tracing messages tagged as \c tag when Z3 is compiled in debug mode.
55815621
It is a NOOP otherwise
55825622
5623+
\sa Z3_enable_trace
5624+
55835625
def_API('Z3_disable_trace', VOID, (_in(STRING),))
55845626
*/
55855627
void Z3_API Z3_disable_trace(Z3_string tag);

‎src/api/z3_fpa.h

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ extern "C" {
218218
\param c logical context
219219
\param s target sort
220220
221+
\sa Z3_mk_fpa_inf
222+
\sa Z3_mk_fpa_zero
223+
221224
def_API('Z3_mk_fpa_nan', AST, (_in(CONTEXT),_in(SORT)))
222225
*/
223226
Z3_ast Z3_API Z3_mk_fpa_nan(Z3_context c, Z3_sort s);
@@ -231,6 +234,9 @@ extern "C" {
231234
232235
When \c negative is \c true, -oo will be generated instead of +oo.
233236
237+
\sa Z3_mk_fpa_nan
238+
\sa Z3_mk_fpa_zero
239+
234240
def_API('Z3_mk_fpa_inf', AST, (_in(CONTEXT),_in(SORT),_in(BOOL)))
235241
*/
236242
Z3_ast Z3_API Z3_mk_fpa_inf(Z3_context c, Z3_sort s, bool negative);
@@ -244,6 +250,9 @@ extern "C" {
244250
245251
When \c negative is \c true, -zero will be generated instead of +zero.
246252
253+
\sa Z3_mk_fpa_inf
254+
\sa Z3_mk_fpa_nan
255+
247256
def_API('Z3_mk_fpa_zero', AST, (_in(CONTEXT),_in(SORT),_in(BOOL)))
248257
*/
249258
Z3_ast Z3_API Z3_mk_fpa_zero(Z3_context c, Z3_sort s, bool negative);
@@ -262,6 +271,13 @@ extern "C" {
262271
\param exp exponent
263272
\param sig significand
264273
274+
\sa Z3_mk_fpa_numeral_double
275+
\sa Z3_mk_fpa_numeral_float
276+
\sa Z3_mk_fpa_numeral_int
277+
\sa Z3_mk_fpa_numeral_int_uint
278+
\sa Z3_mk_fpa_numeral_int64_uint64
279+
\sa Z3_mk_numeral
280+
265281
def_API('Z3_mk_fpa_fp', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(AST)))
266282
*/
267283
Z3_ast Z3_API Z3_mk_fpa_fp(Z3_context c, Z3_ast sgn, Z3_ast exp, Z3_ast sig);
@@ -278,6 +294,11 @@ extern "C" {
278294
279295
\c ty must be a FloatingPoint sort
280296
297+
\sa Z3_mk_fpa_fp
298+
\sa Z3_mk_fpa_numeral_double
299+
\sa Z3_mk_fpa_numeral_int
300+
\sa Z3_mk_fpa_numeral_int_uint
301+
\sa Z3_mk_fpa_numeral_int64_uint64
281302
\sa Z3_mk_numeral
282303
283304
def_API('Z3_mk_fpa_numeral_float', AST, (_in(CONTEXT), _in(FLOAT), _in(SORT)))
@@ -296,6 +317,11 @@ extern "C" {
296317
297318
\c ty must be a FloatingPoint sort
298319
320+
\sa Z3_mk_fpa_fp
321+
\sa Z3_mk_fpa_numeral_float
322+
\sa Z3_mk_fpa_numeral_int
323+
\sa Z3_mk_fpa_numeral_int_uint
324+
\sa Z3_mk_fpa_numeral_int64_uint64
299325
\sa Z3_mk_numeral
300326
301327
def_API('Z3_mk_fpa_numeral_double', AST, (_in(CONTEXT), _in(DOUBLE), _in(SORT)))
@@ -311,6 +337,11 @@ extern "C" {
311337
312338
\c ty must be a FloatingPoint sort
313339
340+
\sa Z3_mk_fpa_fp
341+
\sa Z3_mk_fpa_numeral_double
342+
\sa Z3_mk_fpa_numeral_float
343+
\sa Z3_mk_fpa_numeral_int_uint
344+
\sa Z3_mk_fpa_numeral_int64_uint64
314345
\sa Z3_mk_numeral
315346
316347
def_API('Z3_mk_fpa_numeral_int', AST, (_in(CONTEXT), _in(INT), _in(SORT)))
@@ -328,6 +359,11 @@ extern "C" {
328359
329360
\c ty must be a FloatingPoint sort
330361
362+
\sa Z3_mk_fpa_fp
363+
\sa Z3_mk_fpa_numeral_double
364+
\sa Z3_mk_fpa_numeral_float
365+
\sa Z3_mk_fpa_numeral_int
366+
\sa Z3_mk_fpa_numeral_int64_uint64
331367
\sa Z3_mk_numeral
332368
333369
def_API('Z3_mk_fpa_numeral_int_uint', AST, (_in(CONTEXT), _in(BOOL), _in(INT), _in(UINT), _in(SORT)))
@@ -345,6 +381,11 @@ extern "C" {
345381
346382
\c ty must be a FloatingPoint sort
347383
384+
\sa Z3_mk_fpa_fp
385+
\sa Z3_mk_fpa_numeral_double
386+
\sa Z3_mk_fpa_numeral_float
387+
\sa Z3_mk_fpa_numeral_int
388+
\sa Z3_mk_fpa_numeral_int_uint
348389
\sa Z3_mk_numeral
349390
350391
def_API('Z3_mk_fpa_numeral_int64_uint64', AST, (_in(CONTEXT), _in(BOOL), _in(INT64), _in(UINT64), _in(SORT)))

‎src/api/z3_optimization.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ extern "C" {
8282
\param id - optional identifier to group soft constraints
8383
8484
\sa Z3_optimize_assert
85+
\sa Z3_optimize_assert_and_track
8586
8687
def_API('Z3_optimize_assert_soft', UINT, (_in(CONTEXT), _in(OPTIMIZE), _in(AST), _in(STRING), _in(SYMBOL)))
8788
*/

0 commit comments

Comments
 (0)