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 __nonzero__ (self)
 
def __bool__ (self)
 
def sexpr (self)
 
def ctx_ref (self)
 
def eq (self, other)
 
def translate (self, target)
 
def __copy__ (self)
 
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 513 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

Reimplemented from AstRef.

Definition at line 570 of file z3py.py.

570  def __eq__(self, other):
571  """Return `True` if `self` and `other` are the same Z3 sort.
572 
573  >>> p = Bool('p')
574  >>> p.sort() == BoolSort()
575  True
576  >>> p.sort() == IntSort()
577  False
578  """
579  if other is None:
580  return False
581  return Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
582 
bool Z3_API Z3_is_eq_sort(Z3_context c, Z3_sort s1, Z3_sort s2)
compare sorts.

Referenced by CheckSatResult.__ne__(), and Probe.__ne__().

◆ __hash__()

def __hash__ (   self)
Hash code. 

Reimplemented from AstRef.

Definition at line 594 of file z3py.py.

594  def __hash__(self):
595  """ Hash code. """
596  return AstRef.__hash__(self)
597 

◆ __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 583 of file z3py.py.

583  def __ne__(self, other):
584  """Return `True` if `self` and `other` are not the same Z3 sort.
585 
586  >>> p = Bool('p')
587  >>> p.sort() != BoolSort()
588  False
589  >>> p.sort() != IntSort()
590  True
591  """
592  return not Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
593 
bool Z3_API Z3_is_eq_sort(Z3_context c, Z3_sort s1, Z3_sort s2)
compare sorts.

◆ as_ast()

def as_ast (   self)
Return a pointer to the corresponding C Z3_ast object.

Reimplemented from AstRef.

Definition at line 515 of file z3py.py.

515  def as_ast(self):
516  return Z3_sort_to_ast(self.ctx_ref(), self.ast)
517 
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)

Reimplemented in FPSortRef, BitVecSortRef, ArithSortRef, and BoolSortRef.

Definition at line 545 of file z3py.py.

545  def cast(self, val):
546  """Try to cast `val` as an element of sort `self`.
547 
548  This method is used in Z3Py to convert Python objects such as integers,
549  floats, longs and strings into Z3 expressions.
550 
551  >>> x = Int('x')
552  >>> RealSort().cast(x)
553  ToReal(x)
554  """
555  if z3_debug():
556  _z3_assert(is_expr(val), "Z3 expression expected")
557  _z3_assert(self.eq(val.sort()), "Sort mismatch")
558  return val
559 
def z3_debug()
Definition: z3py.py:58
def is_expr(a)
Definition: z3py.py:1117

◆ get_id()

def get_id (   self)
Return unique identifier for object. It can be used for hash-tables and maps.

Reimplemented from AstRef.

Definition at line 518 of file z3py.py.

518  def get_id(self):
519  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
520 
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....

◆ 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 521 of file z3py.py.

521  def kind(self):
522  """Return the Z3 internal kind of a sort. This method can be used to test if `self` is one of the Z3 builtin sorts.
523 
524  >>> b = BoolSort()
525  >>> b.kind() == Z3_BOOL_SORT
526  True
527  >>> b.kind() == Z3_INT_SORT
528  False
529  >>> A = ArraySort(IntSort(), IntSort())
530  >>> A.kind() == Z3_ARRAY_SORT
531  True
532  >>> A.kind() == Z3_INT_SORT
533  False
534  """
535  return _sort_kind(self.ctx, self.ast)
536 

Referenced by ArithSortRef.is_int(), and ArithSortRef.is_real().

◆ name()

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

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

Definition at line 560 of file z3py.py.

560  def name(self):
561  """Return the name (string) of sort `self`.
562 
563  >>> BoolSort().name()
564  'Bool'
565  >>> ArraySort(IntSort(), IntSort()).name()
566  'Array'
567  """
568  return _symbol2py(self.ctx, Z3_get_sort_name(self.ctx_ref(), self.ast))
569 
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

Reimplemented in BitVecSortRef, ArithSortRef, and BoolSortRef.

Definition at line 537 of file z3py.py.

537  def subsort(self, other):
538  """Return `True` if `self` is a subsort of `other`.
539 
540  >>> IntSort().subsort(RealSort())
541  True
542  """
543  return False
544