Implementation of floating-point numbers (experimental).

@[deprecated "no replacement" (since := "2026-10-02")]

def Int.shift2 (a b : ℕ) : ℤ → ℕ × ℕ

Equations

• Int.shift2 a b (Int.ofNat e) = (a <<< e, b)
• Int.shift2 a b (Int.negSucc e) = (a, b <<< e.succ)

@[deprecated "no replacement" (since := "2026-10-02")]

inductive FP.RMode : Type

• NE : RMode

@[deprecated "no replacement" (since := "2026-10-02")]

class FP.FloatCfg : Type

• prec : ℕ
• emax : ℕ
• precPos : 0 < prec
• precMax : prec ≤ emax

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.prec [C : FloatCfg] : ℕ

Equations

• FP.prec = FP.FloatCfg.prec

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.emax [C : FloatCfg] : ℕ

Equations

• FP.emax = FP.FloatCfg.emax

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.emin [C : FloatCfg] : ℤ

Equations

• FP.emin = 1 - ↑FP.FloatCfg.emax

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.ValidFinite [C : FloatCfg] (e : ℤ) (m : ℕ) : Prop

Equations

• FP.ValidFinite e m = (FP.emin ≤ e + ↑FP.prec - 1 ∧ e + ↑FP.prec - 1 ≤ ↑FP.emax ∧ e = max (e + ↑m.size - ↑FP.prec) FP.emin)

@[instance_reducible]

instance FP.instDecidableValidFinite [C : FloatCfg] (e : ℤ) (m : ℕ) : Decidable (ValidFinite e m)

Equations

• One or more equations did not get rendered due to their size.

@[deprecated Float (since := "2026-10-02")]

inductive FP.Float [C : FloatCfg] : Type

• inf [C : FloatCfg] : Bool → Float
• nan [C : FloatCfg] : Float
• finite [C : FloatCfg] : Bool → (e : ℤ) → (m : ℕ) → ValidFinite e m → Float

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.isFinite [C : FloatCfg] : Float → Bool

Equations

• (FP.Float.finite a e m a_1).isFinite = true
• x✝.isFinite = false

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.toRat [C : FloatCfg] (f : Float) : f.isFinite = true → ℚ

Equations

• FP.toRat (FP.Float.finite s e m a) x_2 = match Int.shift2 m 1 e with | (n, d) => have r := mkRat (↑n) d; if s = true then -r else r

@[deprecated "no replacement" (since := "2026-10-02")]

theorem FP.Float.Zero.valid [C : FloatCfg] : ValidFinite emin 0

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.zero [C : FloatCfg] (s : Bool) : Float

Equations

• FP.Float.zero s = FP.Float.finite s FP.emin 0 ⋯

@[instance_reducible, deprecated "no replacement" (since := "2026-10-02")]

instance FP.instInhabitedFloat [C : FloatCfg] : Inhabited Float

Equations

• FP.instInhabitedFloat = { default := FP.Float.zero true }

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.sign' [C : FloatCfg] : Float → Semiquot Bool

Equations

• (FP.Float.inf s).sign' = pure s
• FP.Float.nan.sign' = ⊤
• (FP.Float.finite s e m a).sign' = pure s

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.sign [C : FloatCfg] : Float → Bool

Equations

• (FP.Float.inf s).sign = s
• FP.Float.nan.sign = false
• (FP.Float.finite s e m a).sign = s

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.isZero [C : FloatCfg] : Float → Bool

Equations

• (FP.Float.finite a e 0 a_1).isZero = true
• x✝.isZero = false

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.Float.neg [C : FloatCfg] : Float → Float

Equations

• (FP.Float.inf s).neg = FP.Float.inf !s
• FP.Float.nan.neg = FP.Float.nan
• (FP.Float.finite s e m a).neg = FP.Float.finite (!s) e m a

@[deprecated "no replacement" (since := "2026-10-02")]

def FP.divNatLtTwoPow (n d : ℕ) : ℤ → Bool

Equations

• FP.divNatLtTwoPow n d (Int.ofNat e) = decide (n < d <<< e)
• FP.divNatLtTwoPow n d (Int.negSucc e) = decide (n <<< e.succ < d)

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.ofPosRatDn [C : FloatCfg] (n d : ℕ+) : Float × Bool

Equations

• One or more equations did not get rendered due to their size.

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.nextUpPos [C : FloatCfg] (e : ℤ) (m : ℕ) (v : ValidFinite e m) : Float

Equations

• FP.nextUpPos e m v = if ss : m.succ.size = m.size then FP.Float.finite false e m.succ ⋯ else if h : e = ↑FP.emax then FP.Float.inf false else FP.Float.finite false e.succ m.succ.div2 ⋯

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.nextDnPos [C : FloatCfg] (e : ℤ) (m : ℕ) (v : ValidFinite e m) : Float

Equations

• One or more equations did not get rendered due to their size.
• FP.nextDnPos e 0 v_2 = FP.nextUpPos FP.emin 0 ⋯

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.nextUp [C : FloatCfg] : Float → Float

Equations

• FP.nextUp (FP.Float.finite false e m f) = FP.nextUpPos e m f
• FP.nextUp (FP.Float.finite true e m f) = (FP.nextDnPos e m f).neg
• FP.nextUp x✝ = x✝

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.nextDn [C : FloatCfg] : Float → Float

Equations

• FP.nextDn (FP.Float.finite false e m f) = FP.nextDnPos e m f
• FP.nextDn (FP.Float.finite true e m f) = (FP.nextUpPos e m f).neg
• FP.nextDn x✝ = x✝

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.ofRatUp [C : FloatCfg] : ℚ → Float

Equations

• FP.ofRatUp { num := 0, den := den, den_nz := den_nz, reduced := reduced } = FP.Float.zero false
• FP.ofRatUp { num := Int.ofNat n.succ, den := d, den_nz := h, reduced := reduced } = match FP.ofPosRatDn n.succPNat ⟨d, ⋯⟩ with | (f, exact) => if exact = true then f else FP.nextUp f
• FP.ofRatUp { num := Int.negSucc n, den := d, den_nz := h, reduced := reduced } = (FP.ofPosRatDn n.succPNat ⟨d, ⋯⟩).1.neg

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.ofRatDn [C : FloatCfg] (r : ℚ) : Float

Equations

• FP.ofRatDn r = (FP.ofRatUp (-r)).neg

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.ofRat [C : FloatCfg] : RMode → ℚ → Float

Equations

• One or more equations did not get rendered due to their size.

@[instance_reducible, deprecated "no replacement" (since := "2026-10-02")]

instance FP.Float.instNeg [C : FloatCfg] : Neg Float

Equations

• FP.Float.instNeg = { neg := FP.Float.neg }

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.Float.add [C : FloatCfg] (mode : RMode) : Float → Float → Float

Equations

• FP.Float.add mode FP.Float.nan x✝ = FP.Float.nan
• FP.Float.add mode x✝ FP.Float.nan = FP.Float.nan
• FP.Float.add mode (FP.Float.inf true) (FP.Float.inf false) = FP.Float.nan
• FP.Float.add mode (FP.Float.inf false) (FP.Float.inf true) = FP.Float.nan
• FP.Float.add mode (FP.Float.inf s₁) x✝ = FP.Float.inf s₁
• FP.Float.add mode x✝ (FP.Float.inf s₂) = FP.Float.inf s₂
• FP.Float.add mode (FP.Float.finite s₁ e₁ m₁ v₁) (FP.Float.finite s₂ e₂ m₂ v₂) = FP.ofRat mode (FP.toRat (FP.Float.finite s₁ e₁ m₁ v₁) ⋯ + FP.toRat (FP.Float.finite s₂ e₂ m₂ v₂) ⋯)

@[instance_reducible, deprecated "no replacement" (since := "2026-10-02")]

unsafe instance FP.Float.instAdd [C : FloatCfg] : Add Float

Equations

• FP.Float.instAdd = { add := FP.Float.add FP.RMode.NE }

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.Float.sub [C : FloatCfg] (mode : RMode) (f1 f2 : Float) : Float

Equations

• FP.Float.sub mode f1 f2 = FP.Float.add mode f1 (-f2)

@[instance_reducible, deprecated "no replacement" (since := "2026-10-02")]

unsafe instance FP.Float.instSub [C : FloatCfg] : Sub Float

Equations

• FP.Float.instSub = { sub := FP.Float.sub FP.RMode.NE }

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.Float.mul [C : FloatCfg] (mode : RMode) : Float → Float → Float

Equations

• FP.Float.mul mode FP.Float.nan x✝ = FP.Float.nan
• FP.Float.mul mode x✝ FP.Float.nan = FP.Float.nan
• FP.Float.mul mode (FP.Float.inf s₁) x✝ = if x✝.isZero = true then FP.Float.nan else FP.Float.inf (s₁ ^^ x✝.sign)
• FP.Float.mul mode x✝ (FP.Float.inf s₂) = if x✝.isZero = true then FP.Float.nan else FP.Float.inf (x✝.sign ^^ s₂)
• FP.Float.mul mode (FP.Float.finite s₁ e₁ m₁ v₁) (FP.Float.finite s₂ e₂ m₂ v₂) = FP.ofRat mode (FP.toRat (FP.Float.finite s₁ e₁ m₁ v₁) ⋯ * FP.toRat (FP.Float.finite s₂ e₂ m₂ v₂) ⋯)

@[deprecated "no replacement" (since := "2026-10-02")]

unsafe def FP.Float.div [C : FloatCfg] (mode : RMode) : Float → Float → Float

Equations

• One or more equations did not get rendered due to their size.
• FP.Float.div mode FP.Float.nan x✝ = FP.Float.nan
• FP.Float.div mode x✝ FP.Float.nan = FP.Float.nan
• FP.Float.div mode (FP.Float.inf a) (FP.Float.inf a_1) = FP.Float.nan
• FP.Float.div mode (FP.Float.inf s₁) x✝ = FP.Float.inf (s₁ ^^ x✝.sign)
• FP.Float.div mode x✝ (FP.Float.inf s₂) = FP.Float.zero (x✝.sign ^^ s₂)