Z3
 
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
RatNumRef Class Reference
+ Inheritance diagram for RatNumRef:

Public Member Functions

 numerator (self)
 
 denominator (self)
 
 numerator_as_long (self)
 
 denominator_as_long (self)
 
 is_int (self)
 
 is_real (self)
 
 is_int_value (self)
 
 as_long (self)
 
 as_decimal (self, prec)
 
 as_string (self)
 
 as_fraction (self)
 
- Public Member Functions inherited from ArithRef
 sort (self)
 
 __add__ (self, other)
 
 __radd__ (self, other)
 
 __mul__ (self, other)
 
 __rmul__ (self, other)
 
 __sub__ (self, other)
 
 __rsub__ (self, other)
 
 __pow__ (self, other)
 
 __rpow__ (self, other)
 
 __div__ (self, other)
 
 __truediv__ (self, other)
 
 __rdiv__ (self, other)
 
 __rtruediv__ (self, other)
 
 __mod__ (self, other)
 
 __rmod__ (self, other)
 
 __neg__ (self)
 
 __pos__ (self)
 
 __le__ (self, other)
 
 __lt__ (self, other)
 
 __gt__ (self, other)
 
 __ge__ (self, other)
 
- Public Member Functions inherited from ExprRef
 as_ast (self)
 
 get_id (self)
 
 sort_kind (self)
 
 __eq__ (self, other)
 
 __hash__ (self)
 
 __ne__ (self, other)
 
 params (self)
 
 decl (self)
 
 num_args (self)
 
 arg (self, idx)
 
 children (self)
 
 from_string (self, s)
 
 serialize (self)
 
- Public Member Functions inherited from AstRef
 __init__ (self, ast, ctx=None)
 
 __del__ (self)
 
 __deepcopy__ (self, memo={})
 
 __str__ (self)
 
 __repr__ (self)
 
 __nonzero__ (self)
 
 __bool__ (self)
 
 sexpr (self)
 
 ctx_ref (self)
 
 eq (self, other)
 
 translate (self, target)
 
 __copy__ (self)
 
 hash (self)
 
- Public Member Functions inherited from Z3PPObject
 use_pp (self)
 

Data Fields

 ctx
 
- Data Fields inherited from ArithRef
 ctx
 
- Data Fields inherited from ExprRef
 ctx
 
- Data Fields inherited from AstRef
 ast
 
 ctx
 

Additional Inherited Members

- Protected Member Functions inherited from Z3PPObject
 _repr_html_ (self)
 

Detailed Description

Rational values.

Definition at line 2988 of file z3py.py.

Member Function Documentation

◆ as_decimal()

as_decimal (   self,
  prec 
)
 Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.

>>> v = RealVal("1/5")
>>> v.as_decimal(3)
'0.2'
>>> v = RealVal("1/3")
>>> v.as_decimal(3)
'0.333?'

Definition at line 3054 of file z3py.py.

3054 def as_decimal(self, prec):
3055 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3056
3057 >>> v = RealVal("1/5")
3058 >>> v.as_decimal(3)
3059 '0.2'
3060 >>> v = RealVal("1/3")
3061 >>> v.as_decimal(3)
3062 '0.333?'
3063 """
3064 return Z3_get_numeral_decimal_string(self.ctx_ref(), self.as_ast(), prec)
3065
Z3_string Z3_API Z3_get_numeral_decimal_string(Z3_context c, Z3_ast a, unsigned precision)
Return numeral as a string in decimal notation. The result has at most precision decimal places.

◆ as_fraction()

as_fraction (   self)
Return a Z3 rational as a Python Fraction object.

>>> v = RealVal("1/5")
>>> v.as_fraction()
Fraction(1, 5)

Definition at line 3075 of file z3py.py.

3075 def as_fraction(self):
3076 """Return a Z3 rational as a Python Fraction object.
3077
3078 >>> v = RealVal("1/5")
3079 >>> v.as_fraction()
3080 Fraction(1, 5)
3081 """
3082 return Fraction(self.numerator_as_long(), self.denominator_as_long())
3083
3084

◆ as_long()

as_long (   self)

Definition at line 3050 of file z3py.py.

3050 def as_long(self):
3051 _z3_assert(self.is_int_value(), "Expected integer fraction")
3052 return self.numerator_as_long()
3053

Referenced by BitVecNumRef.as_signed_long(), RatNumRef.denominator_as_long(), and RatNumRef.numerator_as_long().

◆ as_string()

as_string (   self)
Return a Z3 rational numeral as a Python string.

>>> v = Q(3,6)
>>> v.as_string()
'1/2'

Definition at line 3066 of file z3py.py.

3066 def as_string(self):
3067 """Return a Z3 rational numeral as a Python string.
3068
3069 >>> v = Q(3,6)
3070 >>> v.as_string()
3071 '1/2'
3072 """
3073 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
3074
Z3_string Z3_API Z3_get_numeral_string(Z3_context c, Z3_ast a)
Return numeral value, as a decimal string of a numeric constant term.

Referenced by IntNumRef.as_long(), and BitVecNumRef.as_long().

◆ denominator()

denominator (   self)
 Return the denominator of a Z3 rational numeral.

>>> is_rational_value(Q(3,5))
True
>>> n = Q(3,5)
>>> n.denominator()
5

Definition at line 3006 of file z3py.py.

3006 def denominator(self):
3007 """ Return the denominator of a Z3 rational numeral.
3008
3009 >>> is_rational_value(Q(3,5))
3010 True
3011 >>> n = Q(3,5)
3012 >>> n.denominator()
3013 5
3014 """
3015 return IntNumRef(Z3_get_denominator(self.ctx_ref(), self.as_ast()), self.ctx)
3016
Z3_ast Z3_API Z3_get_denominator(Z3_context c, Z3_ast a)
Return the denominator (as a numeral AST) of a numeral AST of sort Real.

Referenced by RatNumRef.denominator_as_long(), and RatNumRef.is_int_value().

◆ denominator_as_long()

denominator_as_long (   self)
 Return the denominator as a Python long.

>>> v = RealVal("1/3")
>>> v
1/3
>>> v.denominator_as_long()
3

Definition at line 3030 of file z3py.py.

3030 def denominator_as_long(self):
3031 """ Return the denominator as a Python long.
3032
3033 >>> v = RealVal("1/3")
3034 >>> v
3035 1/3
3036 >>> v.denominator_as_long()
3037 3
3038 """
3039 return self.denominator().as_long()
3040

Referenced by RatNumRef.as_fraction(), and RatNumRef.is_int_value().

◆ is_int()

is_int (   self)
Return `True` if `self` is an integer expression.

>>> x = Int('x')
>>> x.is_int()
True
>>> (x + 1).is_int()
True
>>> y = Real('y')
>>> (x + y).is_int()
False

Reimplemented from ArithRef.

Definition at line 3041 of file z3py.py.

3041 def is_int(self):
3042 return False
3043

Referenced by IntNumRef.as_long(), RatNumRef.is_int_value(), and ArithSortRef.subsort().

◆ is_int_value()

is_int_value (   self)

Definition at line 3047 of file z3py.py.

3047 def is_int_value(self):
3048 return self.denominator().is_int() and self.denominator_as_long() == 1
3049

Referenced by RatNumRef.as_long().

◆ is_real()

is_real (   self)
Return `True` if `self` is an real expression.

>>> x = Real('x')
>>> x.is_real()
True
>>> (x + 1).is_real()
True

Reimplemented from ArithRef.

Definition at line 3044 of file z3py.py.

3044 def is_real(self):
3045 return True
3046

◆ numerator()

numerator (   self)
 Return the numerator of a Z3 rational numeral.

>>> is_rational_value(RealVal("3/5"))
True
>>> n = RealVal("3/5")
>>> n.numerator()
3
>>> is_rational_value(Q(3,5))
True
>>> Q(3,5).numerator()
3

Definition at line 2991 of file z3py.py.

2991 def numerator(self):
2992 """ Return the numerator of a Z3 rational numeral.
2993
2994 >>> is_rational_value(RealVal("3/5"))
2995 True
2996 >>> n = RealVal("3/5")
2997 >>> n.numerator()
2998 3
2999 >>> is_rational_value(Q(3,5))
3000 True
3001 >>> Q(3,5).numerator()
3002 3
3003 """
3004 return IntNumRef(Z3_get_numerator(self.ctx_ref(), self.as_ast()), self.ctx)
3005
Z3_ast Z3_API Z3_get_numerator(Z3_context c, Z3_ast a)
Return the numerator (as a numeral AST) of a numeral AST of sort Real.

Referenced by RatNumRef.numerator_as_long().

◆ numerator_as_long()

numerator_as_long (   self)
 Return the numerator as a Python long.

>>> v = RealVal(10000000000)
>>> v
10000000000
>>> v + 1
10000000000 + 1
>>> v.numerator_as_long() + 1 == 10000000001
True

Definition at line 3017 of file z3py.py.

3017 def numerator_as_long(self):
3018 """ Return the numerator as a Python long.
3019
3020 >>> v = RealVal(10000000000)
3021 >>> v
3022 10000000000
3023 >>> v + 1
3024 10000000000 + 1
3025 >>> v.numerator_as_long() + 1 == 10000000001
3026 True
3027 """
3028 return self.numerator().as_long()
3029

Referenced by RatNumRef.as_fraction(), and RatNumRef.as_long().

Field Documentation

◆ ctx

ctx

Definition at line 3004 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Context.__del__(), AstRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), ParamsRef.__del__(), ParamDescrsRef.__del__(), Goal.__del__(), AstVector.__del__(), AstMap.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), BoolRef.__mul__(), ArithRef.__mul__(), BitVecRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), Solver.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), QuantifierRef.body(), Solver.check(), Goal.convert_model(), AstRef.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), FuncDeclRef.domain(), ArraySortRef.domain_n(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Goal.get(), ParamDescrsRef.get_documentation(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), ModelRef.get_sort(), ModelRef.get_universe(), Goal.inconsistent(), AstMap.keys(), Statistics.keys(), Solver.model(), SortRef.name(), QuantifierRef.no_pattern(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Solver.pop(), Goal.prec(), Solver.push(), AstVector.push(), FuncDeclRef.range(), ArraySortRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), ParamsRef.set(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), ParamDescrsRef.size(), Goal.size(), AstVector.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().