library colibrilib.stdq — module ExportThe functions without precondition, for the extraction: a division by zero raises Division_by_zero
module Export757use colibrilib.spec.Value758use int.Int759use real.RealInfix760use real.FromInt761use colibrilib.q.Real as Real762use number.Gcd as Gcd763use colibrilib.zarith.Z as Z764use colibrilib.zarith.Q as Q765use StdQ'impl766767exception DivZero768Valid (53ms) (colibri2)769let div_e (a b:Q.t) : Q.t770ensures { value2 Q.real (fun x y -> from_int (Real.div_e x y)) a b result }771raises { DivZero -> Q.real b = 0. }772= if is_zero b then raise DivZero; div_e a b773Valid (58ms) (colibri2)774let div_t (a b:Q.t) : Q.t775ensures { value2 Q.real (fun x y -> from_int (Real.div_t x y)) a b result }776raises { DivZero -> Q.real b = 0. }777= if is_zero b then raise DivZero; div_t a b778Valid (63ms) (colibri2)779let div_f (a b:Q.t) : Q.t780ensures { value2 Q.real (fun x y -> from_int (Real.div_f x y)) a b result }781raises { DivZero -> Q.real b = 0. }782= if is_zero b then raise DivZero; div_f a b783Valid (52ms) (colibri2)784let mod_e (a b:Q.t) : Q.t785ensures { value2 Q.real Real.mod_e a b result }786raises { DivZero -> Q.real b = 0. }787= if is_zero b then raise DivZero; mod_e a b788Valid (57ms) (colibri2)789let mod_t (a b:Q.t) : Q.t790ensures { value2 Q.real Real.mod_t a b result }791raises { DivZero -> Q.real b = 0. }792= if is_zero b then raise DivZero; mod_t a b793Valid (61ms) (colibri2)794let mod_f (a b:Q.t) : Q.t795ensures { value2 Q.real Real.mod_f a b result }796raises { DivZero -> Q.real b = 0. }797= if is_zero b then raise DivZero; mod_f a b798799use real.Truncate800
floor (a / m) * m: for m > 0, the largest multiple of m below a (StdQ.round_down_to)
Valid (78ms) (colibri2)let round_down_to (a m:Q.t) : Q.t804ensures { value0 Q.real (from_int (floor (Q.real a /. Q.real m)) *. Q.real m) result }805raises { DivZero -> Q.real m = 0. }806= if is_zero m then raise DivZero;807Q.mul (floor (Q.div a m)) m808
ceil (a / m) * m
Valid (78ms) (colibri2)let round_up_to (a m:Q.t) : Q.t811ensures { value0 Q.real (from_int (ceil (Q.real a /. Q.real m)) *. Q.real m) result }812raises { DivZero -> Q.real m = 0. }813= if is_zero m then raise DivZero;814Q.mul (ceil (Q.div a m)) m815816use mach.int.Int63817use real.PowerInt as RP818use PowRound as SP819820exception PowDomain821
The power q^n (Std.Q.pow); PowDomain for a negative power of zero, or for min_int, whose opposite does not fit
Valid (306ms) (colibri2)let pow (q:Q.t) (n:int63) : Q.t825ensures { value1 Q.real (fun x -> if 0 <= n then RP.power x n else 1. /. RP.power x (- n)) q result }826raises { PowDomain -> (n < 0 /\ Q.real q = 0.) \/ n <= -0x4000000000000000 }827= if (n < 0 && is_zero q) || n = -0x4000000000000000 then raise PowDomain;828SP.pow q n829
A number below q with a smaller denominator (PowRound.round_down_to_small)
Valid (31ms) (colibri2)let round_down_to_small [@spec:none "a rounding: any number below q"] (max_size_bit:int) (q:Q.t) : Q.t833ensures { Q.real result <=. Q.real q }834= SP.round_down_to_small max_size_bit q835
A number above q with a smaller denominator (PowRound.round_up_to_small)
Valid (38ms) (colibri2)let round_up_to_small [@spec:none "a rounding: any number above q"] (max_size_bit:int) (q:Q.t) : Q.t839ensures { Q.real q <=. Q.real result }840= SP.round_up_to_small max_size_bit q841842use colibrilib.dv.Dv843Valid (27ms) (colibri2)844let is_integer (q:Q.t) : bool845ensures { result <-> q.Q.den = 1 }846ensures { result <-> exists z. Q.real q = from_int z }847= StdQ'impl.is_integer q848Valid (30ms) (colibri2)849let floor (x:Q.t) : Q.t850ensures { result.Q.den = 1 }851ensures { Q.real result = from_int (Truncate.floor (Q.real x)) }852= StdQ'impl.floor x853Valid (34ms) (colibri2)854let ceil (x:Q.t) : Q.t855ensures { result.Q.den = 1 }856ensures { Q.real result = from_int (Truncate.ceil (Q.real x)) }857= StdQ'impl.ceil x858Valid (33ms) (colibri2)859let truncate (d:Q.t) : Q.t860ensures { result.Q.den = 1 }861ensures { Q.real result = from_int (Truncate.truncate (Q.real d)) }862= StdQ'impl.truncate d863Valid (33ms) (colibri2)864let floor_z (x:Q.t) : int865ensures { result = Truncate.floor (Q.real x) }866= StdQ'impl.floor_z x867Valid (31ms) (colibri2)868let ceil_z (x:Q.t) : int869ensures { result = Truncate.ceil (Q.real x) }870= StdQ'impl.ceil_z x871Valid (29ms) (colibri2)872let truncate_z (x:Q.t) : int873ensures { result = Truncate.truncate (Q.real x) }874= StdQ'impl.truncate_z x875Valid (27ms) (colibri2)876let is_zero (c:Q.t) : bool877ensures { result <-> Q.real c = 0. }878= StdQ'impl.is_zero c879Valid (26ms) (colibri2)880let gcd (a b:Q.t) : Q.t881ensures { Q.real result = from_int (Gcd.gcd a.Q.num b.Q.num) /. from_int (Z.lcm a.Q.den b.Q.den) }882ensures { 0. <=. Q.real result }883ensures { dv (Q.real a) (Q.real result) }884ensures { dv (Q.real b) (Q.real result) }885ensures { forall r. dv (Q.real a) r -> dv (Q.real b) r -> dv (Q.real result) r }886= StdQ'impl.gcd a b887Valid (28ms) (colibri2)888let gcdext3 (a b:Q.t) : (g:Q.t, u:int, v:int)889ensures { 0. <=. Q.real g }890ensures { dv (Q.real a) (Q.real g) }891ensures { dv (Q.real b) (Q.real g) }892ensures { Q.real g = from_int u *. Q.real a +. from_int v *. Q.real b }893= StdQ'impl.gcdext3 a b894Valid (36ms) (colibri2)895let lcm (a b:Q.t) : Q.t896ensures { 0. <=. Q.real result }897ensures { dv (Q.real result) (Q.real a) }898ensures { dv (Q.real result) (Q.real b) }899ensures { forall r. dv r (Q.real a) -> dv r (Q.real b) -> dv r (Q.real result) }900= StdQ'impl.lcm a b901Valid (24ms) (colibri2)902let divisible (a b:Q.t) : bool903ensures { result <-> dv (Q.real a) (Q.real b) }904= let r, _ = StdQ'impl.divisible a b in r905
Raised by divexact when a is not an integer multiple of b
exception NotDivisible908Valid (39ms) (colibri2)909let divexact (a b:Q.t) : int910ensures { Q.real b <> 0. /\ Q.real a = from_int result *. Q.real b }911raises { NotDivisible -> Q.real b = 0. \/ not dv (Q.real a) (Q.real b) }912= if StdQ'impl.is_zero b then raise NotDivisible913else begin914let r, _ = StdQ'impl.divisible a b in915if r then StdQ'impl.divexact a b else raise NotDivisible916end917end918