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 __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 490 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 547 of file z3py.py.

Referenced by Probe.__ne__().

547  def __eq__(self, other):
548  """Return `True` if `self` and `other` are the same Z3 sort.
549 
550  >>> p = Bool('p')
551  >>> p.sort() == BoolSort()
552  True
553  >>> p.sort() == IntSort()
554  False
555  """
556  if other is None:
557  return False
558  return Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
559 
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 571 of file z3py.py.

571  def __hash__(self):
572  """ Hash code. """
573  return AstRef.__hash__(self)
574 

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

560  def __ne__(self, other):
561  """Return `True` if `self` and `other` are not the same Z3 sort.
562 
563  >>> p = Bool('p')
564  >>> p.sort() != BoolSort()
565  False
566  >>> p.sort() != IntSort()
567  True
568  """
569  return not Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
570 
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 492 of file z3py.py.

492  def as_ast(self):
493  return Z3_sort_to_ast(self.ctx_ref(), self.ast)
494 
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 522 of file z3py.py.

522  def cast(self, val):
523  """Try to cast `val` as an element of sort `self`.
524 
525  This method is used in Z3Py to convert Python objects such as integers,
526  floats, longs and strings into Z3 expressions.
527 
528  >>> x = Int('x')
529  >>> RealSort().cast(x)
530  ToReal(x)
531  """
532  if __debug__:
533  _z3_assert(is_expr(val), "Z3 expression expected")
534  _z3_assert(self.eq(val.sort()), "Sort mismatch")
535  return val
536 
def is_expr(a)
Definition: z3py.py:1047

◆ get_id()

def get_id (   self)

Definition at line 495 of file z3py.py.

495  def get_id(self):
496  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
497 
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 498 of file z3py.py.

498  def kind(self):
499  """Return the Z3 internal kind of a sort. This method can be used to test if `self` is one of the Z3 builtin sorts.
500 
501  >>> b = BoolSort()
502  >>> b.kind() == Z3_BOOL_SORT
503  True
504  >>> b.kind() == Z3_INT_SORT
505  False
506  >>> A = ArraySort(IntSort(), IntSort())
507  >>> A.kind() == Z3_ARRAY_SORT
508  True
509  >>> A.kind() == Z3_INT_SORT
510  False
511  """
512  return _sort_kind(self.ctx, self.ast)
513 

◆ name()

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

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

Definition at line 537 of file z3py.py.

537  def name(self):
538  """Return the name (string) of sort `self`.
539 
540  >>> BoolSort().name()
541  'Bool'
542  >>> ArraySort(IntSort(), IntSort()).name()
543  'Array'
544  """
545  return _symbol2py(self.ctx, Z3_get_sort_name(self.ctx_ref(), self.ast))
546 
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 514 of file z3py.py.

514  def subsort(self, other):
515  """Return `True` if `self` is a subsort of `other`.
516 
517  >>> IntSort().subsort(RealSort())
518  True
519  """
520  return False
521