Skip to content

Commit

Permalink
api text -- to be checked with sphinx, which is not running with brew
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmed-irfan committed Nov 20, 2023
1 parent 595045d commit c871036
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/sphinx/source/context-operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1207,6 +1207,39 @@ as follows::
-- error code: :c:enum:`CTX_INVALID_OPERATION`
Set Variable Ordering for MCSat
-------------------------------
It is possible to give a variable ordering for the MCSat search --
this will make MCSAT to decide the variables in the given order. Note
that this operation will overwrite any previously set ordering.
.. c:function:: smt_status_t yices_mcsat_set_var_order(context_t *ctx, const term_t t[], uint32_t n)
Set the variable ordering for the MCSat search.
**Parameters**
- *ctx* is a context
- *t* is an array of variables
- *n* is the size of the *t* array
If the operation fails, it will return :c:enum:`STATUS_ERROR`,
otherwise it returns :c:enum:`STATUS_IDLE`.
**Error report**
- If the context is not configured for MCSat:
-- error code: :c:enum:`CTX_OPERATION_NOT_SUPPORTED`
- If the terms in the *t* array are not variables:
-- error code: :c:enum:`VARIABLE_REQUIRED`
.. _params:
Search Parameters
Expand Down

0 comments on commit c871036

Please sign in to comment.