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

3243 def as_decimal(self, prec):
3244 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3245
3246 >>> v = RealVal("1/5")
3247 >>> v.as_decimal(3)
3248 '0.2'
3249 >>> v = RealVal("1/3")
3250 >>> v.as_decimal(3)
3251 '0.333?'
3252 """
3253 return Z3_get_numeral_decimal_string(self.ctx_ref(), self.as_ast(), prec)
3254
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 3264 of file z3py.py.

3264 def as_fraction(self):
3265 """Return a Z3 rational as a Python Fraction object.
3266
3267 >>> v = RealVal("1/5")
3268 >>> v.as_fraction()
3269 Fraction(1, 5)
3270 """
3271 return Fraction(self.numerator_as_long(), self.denominator_as_long())
3272

◆ as_long()

as_long ( self)

Definition at line 3239 of file z3py.py.

3239 def as_long(self):
3240 _z3_assert(self.is_int_value(), "Expected integer fraction")
3241 return self.numerator_as_long()
3242

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

3255 def as_string(self):
3256 """Return a Z3 rational numeral as a Python string.
3257
3258 >>> v = Q(3,6)
3259 >>> v.as_string()
3260 '1/2'
3261 """
3262 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
3263
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 3195 of file z3py.py.

3195 def denominator(self):
3196 """ Return the denominator of a Z3 rational numeral.
3197
3198 >>> is_rational_value(Q(3,5))
3199 True
3200 >>> n = Q(3,5)
3201 >>> n.denominator()
3202 5
3203 """
3204 return IntNumRef(Z3_get_denominator(self.ctx_ref(), self.as_ast()), self.ctx)
3205
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 3219 of file z3py.py.

3219 def denominator_as_long(self):
3220 """ Return the denominator as a Python long.
3221
3222 >>> v = RealVal("1/3")
3223 >>> v
3224 1/3
3225 >>> v.denominator_as_long()
3226 3
3227 """
3228 return self.denominator().as_long()
3229

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

3230 def is_int(self):
3231 return False
3232

Referenced by is_int_value().

◆ is_int_value()

is_int_value ( self)

Definition at line 3236 of file z3py.py.

3236 def is_int_value(self):
3237 return self.denominator().is_int() and self.denominator_as_long() == 1
3238

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

3233 def is_real(self):
3234 return True
3235

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

3180 def numerator(self):
3181 """ Return the numerator of a Z3 rational numeral.
3182
3183 >>> is_rational_value(RealVal("3/5"))
3184 True
3185 >>> n = RealVal("3/5")
3186 >>> n.numerator()
3187 3
3188 >>> is_rational_value(Q(3,5))
3189 True
3190 >>> Q(3,5).numerator()
3191 3
3192 """
3193 return IntNumRef(Z3_get_numerator(self.ctx_ref(), self.as_ast()), self.ctx)
3194
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 3206 of file z3py.py.

3206 def numerator_as_long(self):
3207 """ Return the numerator as a Python long.
3208
3209 >>> v = RealVal(10000000000)
3210 >>> v
3211 10000000000
3212 >>> v + 1
3213 10000000000 + 1
3214 >>> v.numerator_as_long() + 1 == 10000000001
3215 True
3216 """
3217 return self.numerator().as_long()
3218

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

3273 def py_value(self):
3274 return Z3_get_numeral_double(self.ctx_ref(), self.as_ast())
3275
3276
double Z3_API Z3_get_numeral_double(Z3_context c, Z3_ast a)
Return numeral as a double.