Z3
Public Member Functions
SortRef Class Reference
+ Inheritance diagram for SortRef:

Public Member Functions

def as_ast (self)
 
def get_id (self)
 
def kind (self)
 
def subsort (self, other)
 
def cast (self, val)
 
def name (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
- Public Member Functions inherited from AstRef
def __init__ (self, ast, ctx=None)
 
def __del__ (self)
 
def __deepcopy__ (self, memo={})
 
def __str__ (self)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 
def __nonzero__ (self)
 
def __bool__ (self)
 
def sexpr (self)
 
def as_ast (self)
 
def get_id (self)
 
def ctx_ref (self)
 
def eq (self, other)
 
def translate (self, target)
 
def hash (self)
 
- Public Member Functions inherited from Z3PPObject
def use_pp (self)
 

Additional Inherited Members

- Data Fields inherited from AstRef
 ast
 
 ctx
 

Detailed Description

A Sort is essentially a type. Every Z3 expression has a sort. A sort is an AST node.

Definition at line 476 of file z3py.py.

Member Function Documentation

§ __eq__()

def __eq__ (   self,
  other 
)
Return `True` if `self` and `other` are the same Z3 sort.

>>> p = Bool('p')
>>> p.sort() == BoolSort()
True
>>> p.sort() == IntSort()
False

Definition at line 533 of file z3py.py.

Referenced by Probe.__ne__().

533  def __eq__(self, other):
534  """Return `True` if `self` and `other` are the same Z3 sort.
535 
536  >>> p = Bool('p')
537  >>> p.sort() == BoolSort()
538  True
539  >>> p.sort() == IntSort()
540  False
541  """
542  if other is None:
543  return False
544  return Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
545 
Z3_bool Z3_API Z3_is_eq_sort(Z3_context c, Z3_sort s1, Z3_sort s2)
compare sorts.

§ __hash__()

def __hash__ (   self)
Hash code. 

Definition at line 557 of file z3py.py.

557  def __hash__(self):
558  """ Hash code. """
559  return AstRef.__hash__(self)
560 

§ __ne__()

def __ne__ (   self,
  other 
)
Return `True` if `self` and `other` are not the same Z3 sort.

>>> p = Bool('p')
>>> p.sort() != BoolSort()
False
>>> p.sort() != IntSort()
True

Definition at line 546 of file z3py.py.

546  def __ne__(self, other):
547  """Return `True` if `self` and `other` are not the same Z3 sort.
548 
549  >>> p = Bool('p')
550  >>> p.sort() != BoolSort()
551  False
552  >>> p.sort() != IntSort()
553  True
554  """
555  return not Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
556 
Z3_bool Z3_API Z3_is_eq_sort(Z3_context c, Z3_sort s1, Z3_sort s2)
compare sorts.

§ as_ast()

def as_ast (   self)

Definition at line 478 of file z3py.py.

478  def as_ast(self):
479  return Z3_sort_to_ast(self.ctx_ref(), self.ast)
480 
Z3_ast Z3_API Z3_sort_to_ast(Z3_context c, Z3_sort s)
Convert a Z3_sort into Z3_ast. This is just type casting.

§ cast()

def cast (   self,
  val 
)
Try to cast `val` as an element of sort `self`.

This method is used in Z3Py to convert Python objects such as integers,
floats, longs and strings into Z3 expressions.

>>> x = Int('x')
>>> RealSort().cast(x)
ToReal(x)

Definition at line 508 of file z3py.py.

508  def cast(self, val):
509  """Try to cast `val` as an element of sort `self`.
510 
511  This method is used in Z3Py to convert Python objects such as integers,
512  floats, longs and strings into Z3 expressions.
513 
514  >>> x = Int('x')
515  >>> RealSort().cast(x)
516  ToReal(x)
517  """
518  if __debug__:
519  _z3_assert(is_expr(val), "Z3 expression expected")
520  _z3_assert(self.eq(val.sort()), "Sort mismatch")
521  return val
522 
def is_expr(a)
Definition: z3py.py:1033

§ get_id()

def get_id (   self)

Definition at line 481 of file z3py.py.

481  def get_id(self):
482  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
483 
unsigned Z3_API Z3_get_ast_id(Z3_context c, Z3_ast t)
Return a unique identifier for t. The identifier is unique up to structural equality. Thus, two ast nodes created by the same context and having the same children and same function symbols have the same identifiers. Ast nodes created in the same context, but having different children or different functions have different identifiers. Variables and quantifiers are also assigned different identifiers according to their structure.

§ kind()

def kind (   self)
Return the Z3 internal kind of a sort. This method can be used to test if `self` is one of the Z3 builtin sorts.

>>> b = BoolSort()
>>> b.kind() == Z3_BOOL_SORT
True
>>> b.kind() == Z3_INT_SORT
False
>>> A = ArraySort(IntSort(), IntSort())
>>> A.kind() == Z3_ARRAY_SORT
True
>>> A.kind() == Z3_INT_SORT
False

Definition at line 484 of file z3py.py.

484  def kind(self):
485  """Return the Z3 internal kind of a sort. This method can be used to test if `self` is one of the Z3 builtin sorts.
486 
487  >>> b = BoolSort()
488  >>> b.kind() == Z3_BOOL_SORT
489  True
490  >>> b.kind() == Z3_INT_SORT
491  False
492  >>> A = ArraySort(IntSort(), IntSort())
493  >>> A.kind() == Z3_ARRAY_SORT
494  True
495  >>> A.kind() == Z3_INT_SORT
496  False
497  """
498  return _sort_kind(self.ctx, self.ast)
499 

§ name()

def name (   self)
Return the name (string) of sort `self`.

>>> BoolSort().name()
'Bool'
>>> ArraySort(IntSort(), IntSort()).name()
'Array'

Definition at line 523 of file z3py.py.

523  def name(self):
524  """Return the name (string) of sort `self`.
525 
526  >>> BoolSort().name()
527  'Bool'
528  >>> ArraySort(IntSort(), IntSort()).name()
529  'Array'
530  """
531  return _symbol2py(self.ctx, Z3_get_sort_name(self.ctx_ref(), self.ast))
532 
Z3_symbol Z3_API Z3_get_sort_name(Z3_context c, Z3_sort d)
Return the sort name as a symbol.

§ subsort()

def subsort (   self,
  other 
)
Return `True` if `self` is a subsort of `other`.

>>> IntSort().subsort(RealSort())
True

Definition at line 500 of file z3py.py.

500  def subsort(self, other):
501  """Return `True` if `self` is a subsort of `other`.
502 
503  >>> IntSort().subsort(RealSort())
504  True
505  """
506  return False
507