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 494 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 551 of file z3py.py.

Referenced by Probe.__ne__().

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

575  def __hash__(self):
576  """ Hash code. """
577  return AstRef.__hash__(self)
578 

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

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

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

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

◆ get_id()

def get_id (   self)

Definition at line 499 of file z3py.py.

499  def get_id(self):
500  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
501 
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 502 of file z3py.py.

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

◆ name()

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

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

Definition at line 541 of file z3py.py.

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

518  def subsort(self, other):
519  """Return `True` if `self` is a subsort of `other`.
520 
521  >>> IntSort().subsort(RealSort())
522  True
523  """
524  return False
525