Z3
Loading...
Searching...
No Matches
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)
 py_value (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)
 __abs__ (self)
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)
 kind (self)
 num_args (self)
 arg (self, idx)
 children (self)
 update (self, *args)
 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)
 __eq__ (self, other)
 __hash__ (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)

Additional Inherited Members

Data Fields inherited from AstRef
 ast = ast
 ctx = _get_ctx(ctx)
Protected Member Functions inherited from Z3PPObject
 _repr_html_ (self)

Detailed Description

Rational values.

Definition at line 3155 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 3221 of file z3py.py.

3221 def as_decimal(self, prec):
3222 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3223
3224 >>> v = RealVal("1/5")
3225 >>> v.as_decimal(3)
3226 '0.2'
3227 >>> v = RealVal("1/3")
3228 >>> v.as_decimal(3)
3229 '0.333?'
3230 """
3231 return Z3_get_numeral_decimal_string(self.ctx_ref(), self.as_ast(), prec)
3232
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 3242 of file z3py.py.

3242 def as_fraction(self):
3243 """Return a Z3 rational as a Python Fraction object.
3244
3245 >>> v = RealVal("1/5")
3246 >>> v.as_fraction()
3247 Fraction(1, 5)
3248 """
3249 return Fraction(self.numerator_as_long(), self.denominator_as_long())
3250

◆ as_long()

as_long ( self)

Definition at line 3217 of file z3py.py.

3217 def as_long(self):
3218 _z3_assert(self.is_int_value(), "Expected integer fraction")
3219 return self.numerator_as_long()
3220

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

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

3233 def as_string(self):
3234 """Return a Z3 rational numeral as a Python string.
3235
3236 >>> v = Q(3,6)
3237 >>> v.as_string()
3238 '1/2'
3239 """
3240 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
3241
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 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 3173 of file z3py.py.

3173 def denominator(self):
3174 """ Return the denominator of a Z3 rational numeral.
3175
3176 >>> is_rational_value(Q(3,5))
3177 True
3178 >>> n = Q(3,5)
3179 >>> n.denominator()
3180 5
3181 """
3182 return IntNumRef(Z3_get_denominator(self.ctx_ref(), self.as_ast()), self.ctx)
3183
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 denominator_as_long(), and 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 3197 of file z3py.py.

3197 def denominator_as_long(self):
3198 """ Return the denominator as a Python long.
3199
3200 >>> v = RealVal("1/3")
3201 >>> v
3202 1/3
3203 >>> v.denominator_as_long()
3204 3
3205 """
3206 return self.denominator().as_long()
3207

Referenced by as_fraction(), and 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 3208 of file z3py.py.

3208 def is_int(self):
3209 return False
3210

Referenced by is_int_value().

◆ is_int_value()

is_int_value ( self)

Definition at line 3214 of file z3py.py.

3214 def is_int_value(self):
3215 return self.denominator().is_int() and self.denominator_as_long() == 1
3216

Referenced by 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 3211 of file z3py.py.

3211 def is_real(self):
3212 return True
3213

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

3158 def numerator(self):
3159 """ Return the numerator of a Z3 rational numeral.
3160
3161 >>> is_rational_value(RealVal("3/5"))
3162 True
3163 >>> n = RealVal("3/5")
3164 >>> n.numerator()
3165 3
3166 >>> is_rational_value(Q(3,5))
3167 True
3168 >>> Q(3,5).numerator()
3169 3
3170 """
3171 return IntNumRef(Z3_get_numerator(self.ctx_ref(), self.as_ast()), self.ctx)
3172
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 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 3184 of file z3py.py.

3184 def numerator_as_long(self):
3185 """ Return the numerator as a Python long.
3186
3187 >>> v = RealVal(10000000000)
3188 >>> v
3189 10000000000
3190 >>> v + 1
3191 10000000000 + 1
3192 >>> v.numerator_as_long() + 1 == 10000000001
3193 True
3194 """
3195 return self.numerator().as_long()
3196

Referenced by as_fraction(), and as_long().

◆ py_value()

py_value ( self)
Return a Python value that is equivalent to `self`.

Reimplemented from AstRef.

Definition at line 3251 of file z3py.py.

3251 def py_value(self):
3252 return Z3_get_numeral_double(self.ctx_ref(), self.as_ast())
3253
3254
double Z3_API Z3_get_numeral_double(Z3_context c, Z3_ast a)
Return numeral as a double.