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 558 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 617 of file z3py.py.

    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
        """
        if other is None:
            return False
        return Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
 

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

__hash__()

def __hash__

(

self

)

 Hash code. 

Reimplemented from AstRef.

Definition at line 641 of file z3py.py.

    def __hash__(self):
        """ Hash code. """
        return AstRef.__hash__(self)
 
 

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

    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
        """
        return not Z3_is_eq_sort(self.ctx_ref(), self.ast, other.ast)
 

as_ast()

def as_ast

(

self

)

Return a pointer to the corresponding C Z3_ast object.

Reimplemented from AstRef.

Definition at line 561 of file z3py.py.

    def as_ast(self):
        return Z3_sort_to_ast(self.ctx_ref(), self.ast)
 

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

    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)
        """
        if z3_debug():
            _z3_assert(is_expr(val), "Z3 expression expected")
            _z3_assert(self.eq(val.sort()), "Sort mismatch")
        return val
 

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

    def get_id(self):
        return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
 

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

    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
        """
        return _sort_kind(self.ctx, self.ast)
 

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

    def name(self):
        """Return the name (string) of sort `self`.
 
        >>> BoolSort().name()
        'Bool'
        >>> ArraySort(IntSort(), IntSort()).name()
        'Array'
        """
        return _symbol2py(self.ctx, Z3_get_sort_name(self.ctx_ref(), self.ast))
 

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

    def subsort(self, other):
        """Return `True` if `self` is a subsort of `other`.
 
        >>> IntSort().subsort(RealSort())
        True
        """
        return False