Fixedpoint

java.lang.Object
- com.microsoft.z3.IDisposable
- - com.microsoft.z3.Z3Object
  - - com.microsoft.z3.Fixedpoint

public class Fixedpoint
extends Z3Object

Object for managing fixedpoints

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(BoolExpr... constraints)` Assert a constraint (or multiple) into the fixedpoint solver.
`void`	`addCover(int level, FuncDecl predicate, Expr property)` Add `property` about the `predicate`.
`void`	`addFact(FuncDecl pred, int... args)` Add table fact to the fixedpoint solver.
`void`	`addRule(BoolExpr rule, Symbol name)` Add rule into the fixedpoint solver.
`Expr`	`getAnswer()` Retrieve satisfying instance or instances of solver, or definitions for the recursive predicates that show unsatisfiability.
`BoolExpr[]`	`getAssertions()` Retrieve set of assertions added to fixedpoint context.
`Expr`	`getCoverDelta(int level, FuncDecl predicate)` Retrieve the cover of a predicate.
`java.lang.String`	`getHelp()` A string that describes all available fixedpoint solver parameters.
`int`	`getNumLevels(FuncDecl predicate)` Retrieve the number of levels explored for a given predicate.
`ParamDescrs`	`getParameterDescriptions()` Retrieves parameter descriptions for Fixedpoint solver.
`java.lang.String`	`getReasonUnknown()` Retrieve explanation why fixedpoint engine returned status Unknown.
`BoolExpr[]`	`getRules()` Retrieve set of rules added to fixedpoint context.
`Statistics`	`getStatistics()` Fixedpoint statistics.
`BoolExpr[]`	`ParseFile(java.lang.String file)` Parse an SMT-LIB2 file with fixedpoint rules.
`BoolExpr[]`	`ParseString(java.lang.String s)` Parse an SMT-LIB2 string with fixedpoint rules.
`void`	`pop()` Backtrack one backtracking point.
`void`	`push()` Creates a backtracking point.
`Status`	`query(BoolExpr query)` Query the fixedpoint solver.
`Status`	`query(FuncDecl[] relations)` Query the fixedpoint solver.
`void`	`registerRelation(FuncDecl f)` Register predicate as recursive relation.
`void`	`setParameters(Params value)` Sets the fixedpoint solver parameters.
`void`	`setPredicateRepresentation(FuncDecl f, Symbol[] kinds)` Instrument the Datalog engine on which table representation to use for recursive predicate.
`java.lang.String`	`toString()` Retrieve internal string representation of fixedpoint object.
`java.lang.String`	`toString(BoolExpr[] queries)` Convert benchmark given as set of axioms, rules and queries to a string.
`void`	`updateRule(BoolExpr rule, Symbol name)` Update named rule into in the fixedpoint solver.

Methods inherited from class com.microsoft.z3.Z3Object
dispose, finalize

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getHelp
```
public java.lang.String getHelp()
```
    A string that describes all available fixedpoint solver parameters.
  - setParameters
```
public void setParameters(Params value)
```
    Sets the fixedpoint solver parameters.
    
    Throws:
    
    Z3Exception
  - getParameterDescriptions
```
public ParamDescrs getParameterDescriptions()
```
    Retrieves parameter descriptions for Fixedpoint solver.
    
    Throws:
    
    Z3Exception
  - add
```
public void add(BoolExpr... constraints)
```
    Assert a constraint (or multiple) into the fixedpoint solver.
    
    Throws:
    
    Z3Exception
  - registerRelation
```
public void registerRelation(FuncDecl f)
```
    Register predicate as recursive relation.
    
    Throws:
    
    Z3Exception
  - addRule
```
public void addRule(BoolExpr rule,
           Symbol name)
```
    Add rule into the fixedpoint solver.
    
    Throws:
    
    Z3Exception
  - addFact
```
public void addFact(FuncDecl pred,
           int... args)
```
    Add table fact to the fixedpoint solver.
    
    Throws:
    
    Z3Exception
  - query
```
public Status query(BoolExpr query)
```
    Query the fixedpoint solver. A query is a conjunction of constraints. The constraints may include the recursively defined relations. The query is satisfiable if there is an instance of the query variables and a derivation for it. The query is unsatisfiable if there are no derivations satisfying the query variables.
    
    Throws:
    
    Z3Exception
  - query
```
public Status query(FuncDecl[] relations)
```
    Query the fixedpoint solver. A query is an array of relations. The query is satisfiable if there is an instance of some relation that is non-empty. The query is unsatisfiable if there are no derivations satisfying any of the relations.
    
    Throws:
    
    Z3Exception
  - push
```
public void push()
```
    Creates a backtracking point.
    
    See Also:
    pop()
  - pop
```
public void pop()
```
    Backtrack one backtracking point. Remarks: Note that an exception is thrown if pop is called without a corresponding push
    
    See Also:
    push()
  - updateRule
```
public void updateRule(BoolExpr rule,
              Symbol name)
```
    Update named rule into in the fixedpoint solver.
    
    Throws:
    
    Z3Exception
  - getAnswer
```
public Expr getAnswer()
```
    Retrieve satisfying instance or instances of solver, or definitions for the recursive predicates that show unsatisfiability.
    
    Throws:
    
    Z3Exception
  - getReasonUnknown
```
public java.lang.String getReasonUnknown()
```
    Retrieve explanation why fixedpoint engine returned status Unknown.
  - getNumLevels
```
public int getNumLevels(FuncDecl predicate)
```
    Retrieve the number of levels explored for a given predicate.
  - getCoverDelta
```
public Expr getCoverDelta(int level,
                 FuncDecl predicate)
```
    Retrieve the cover of a predicate.
    
    Throws:
    
    Z3Exception
  - addCover
```
public void addCover(int level,
            FuncDecl predicate,
            Expr property)
```
    Add property about the predicate. The property is added at level.
  - toString
```
public java.lang.String toString()
```
    Retrieve internal string representation of fixedpoint object.
    
    Overrides:
    
    toString in class java.lang.Object
  - setPredicateRepresentation
```
public void setPredicateRepresentation(FuncDecl f,
                              Symbol[] kinds)
```
    Instrument the Datalog engine on which table representation to use for recursive predicate.
  - toString
```
public java.lang.String toString(BoolExpr[] queries)
```
    Convert benchmark given as set of axioms, rules and queries to a string.
  - getRules
```
public BoolExpr[] getRules()
```
    Retrieve set of rules added to fixedpoint context.
    
    Throws:
    
    Z3Exception
  - getAssertions
```
public BoolExpr[] getAssertions()
```
    Retrieve set of assertions added to fixedpoint context.
    
    Throws:
    
    Z3Exception
  - getStatistics
```
public Statistics getStatistics()
```
    Fixedpoint statistics.
    
    Throws:
    
    Z3Exception
  - ParseFile
```
public BoolExpr[] ParseFile(java.lang.String file)
```
    Parse an SMT-LIB2 file with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the file.
  - ParseString
```
public BoolExpr[] ParseString(java.lang.String s)
```
    Parse an SMT-LIB2 string with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the file.

Class Fixedpoint

Method Summary

Methods inherited from class com.microsoft.z3.Z3Object

Methods inherited from class java.lang.Object

Method Detail

getHelp

setParameters

getParameterDescriptions

add

registerRelation

addRule

addFact

query

query

push

pop

updateRule

getAnswer

getReasonUnknown

getNumLevels

getCoverDelta

addCover

toString

setPredicateRepresentation

toString

getRules

getAssertions

getStatistics

ParseFile

ParseString