Integer Type, Coercions, and Notation

This file defines the Int type as well as

• coercions, conversions, and compatibility with numeric literals,
• basic arithmetic operations add/sub/mul/div/mod/pow,
• a few Nat-related operations such as negOfNat and subNatNat,
• relations </≤/≥/>, the NonNeg property and min/max,
• decidability of equality, relations and NonNeg.

inductive Int : Type

The type of integers. It is defined as an inductive type based on the natural number type Nat featuring two constructors: "a natural number is an integer", and "the negation of a successor of a natural number is an integer". The former represents integers between 0 (inclusive) and ∞, and the latter integers between -∞ and -1 (inclusive).

This type is special-cased by the compiler. The runtime has a special representation for Int which stores "small" signed numbers directly, and larger numbers use an arbitrary precision "bignum" library (usually GMP). A "small number" is an integer that can be encoded with 63 bits (31 bits on 32-bits architectures).

• ofNat: Nat → Int

  A natural number is an integer (0 to ∞).

• negSucc: Nat → Int

  The negation of the successor of a natural number is an integer (-1 to -∞).

instance instNatCastInt : NatCast Int

Equations

• instNatCastInt = { natCast := fun (n : Nat) => Int.ofNat n }

instance instOfNat {n : Nat} : OfNat Int n

Equations

• instOfNat = { ofNat := Int.ofNat n }

def Int.«term-[_+1]» : Lean.ParserDescr

-[n+1] is suggestive notation for negSucc n, which is the second constructor of Int for making strictly negative numbers by mapping n : Nat to -(n + 1).

Equations

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

instance Int.instInhabitedInt : Inhabited Int

Equations

• Int.instInhabitedInt = { default := Int.ofNat 0 }

@[simp]

theorem Int.default_eq_zero : default = 0

theorem Int.zero_ne_one : 0 ≠ 1

Coercions

@[simp]

theorem Int.ofNat_eq_coe {n : Nat} : Int.ofNat n = ↑n

@[simp]

theorem Int.ofNat_zero : ↑0 = 0

@[simp]

theorem Int.ofNat_one : ↑1 = 1

theorem Int.ofNat_two : ↑2 = 2

def Int.negOfNat : Nat → Int

Negation of a natural number.

Equations

• Int.negOfNat x = match x with | 0 => 0 | Nat.succ m => Int.negSucc m

@[extern lean_int_neg]

def Int.neg (n : Int) : Int

Negation of an integer.

Implemented by efficient native code.

Equations

• Int.neg n = match n with | Int.ofNat n => Int.negOfNat n | Int.negSucc n => ↑(Nat.succ n)

@[defaultInstance 500]

instance Int.instNegInt : Neg Int

Equations

• Int.instNegInt = { neg := Int.neg }

def Int.subNatNat (m : Nat) (n : Nat) : Int

Subtraction of two natural numbers.

Equations

• Int.subNatNat m n = match n - m with | 0 => Int.ofNat (m - n) | Nat.succ k => Int.negSucc k

@[extern lean_int_add]

def Int.add (m : Int) (n : Int) : Int

Addition of two integers.

#eval (7 : Int) + (6 : Int) -- 13
#eval (6 : Int) + (-6 : Int) -- 0

Implemented by efficient native code.

Equations

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

instance Int.instAddInt : Add Int

Equations

• Int.instAddInt = { add := Int.add }

@[extern lean_int_mul]

def Int.mul (m : Int) (n : Int) : Int

Multiplication of two integers.

#eval (63 : Int) * (6 : Int) -- 378
#eval (6 : Int) * (-6 : Int) -- -36
#eval (7 : Int) * (0 : Int) -- 0

Implemented by efficient native code.

Equations

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

instance Int.instMulInt : Mul Int

Equations

• Int.instMulInt = { mul := Int.mul }

@[extern lean_int_sub]

def Int.sub (m : Int) (n : Int) : Int

Subtraction of two integers.

#eval (63 : Int) - (6 : Int) -- 57
#eval (7 : Int) - (0 : Int) -- 7
#eval (0 : Int) - (7 : Int) -- -7

Implemented by efficient native code.

Equations

• Int.sub m n = m + -n

instance Int.instSubInt : Sub Int

Equations

• Int.instSubInt = { sub := Int.sub }

inductive Int.NonNeg : Int → Prop

A proof that an Int is non-negative.

• mk: ∀ (n : Nat), Int.NonNeg (Int.ofNat n)

  Sole constructor, proving that ofNat n is positive.

def Int.le (a : Int) (b : Int) : Prop

Definition of a ≤ b, encoded as b - a ≥ 0.

Equations

• Int.le a b = Int.NonNeg (b - a)

instance Int.instLEInt : LE Int

Equations

• Int.instLEInt = { le := Int.le }

def Int.lt (a : Int) (b : Int) : Prop

Definition of a < b, encoded as a + 1 ≤ b.

Equations

• Int.lt a b = (a + 1 ≤ b)

instance Int.instLTInt : LT Int

Equations

• Int.instLTInt = { lt := Int.lt }

@[extern lean_int_dec_eq]

def Int.decEq (a : Int) (b : Int) : Decidable (a = b)

Decides equality between two Ints.

#eval (7 : Int) = (3 : Int) + (4 : Int) -- true
#eval (6 : Int) = (3 : Int) * (2 : Int) -- true
#eval ¬ (6 : Int) = (3 : Int) -- true

Implemented by efficient native code.

Equations

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

instance Int.instDecidableEqInt : DecidableEq Int

Equations

• Int.instDecidableEqInt = Int.decEq

@[extern lean_int_dec_le]

instance Int.decLe (a : Int) (b : Int) : Decidable (a ≤ b)

Decides whether a ≤ b.

#eval ¬ ( (7 : Int) ≤ (0 : Int) ) -- true
#eval (0 : Int) ≤ (0 : Int) -- true
#eval (7 : Int) ≤ (10 : Int) -- true

Implemented by efficient native code.

Equations

• Int.decLe a b = Int.decNonneg (b - a)

@[extern lean_int_dec_lt]

instance Int.decLt (a : Int) (b : Int) : Decidable (a < b)

Decides whether a < b.

#eval `¬ ( (7 : Int) < 0 )` -- true
#eval `¬ ( (0 : Int) < 0 )` -- true
#eval `(7 : Int) < 10` -- true

Implemented by efficient native code.

Equations

• Int.decLt a b = Int.decNonneg (b - (a + 1))

@[extern lean_nat_abs]

def Int.natAbs (m : Int) : Nat

Absolute value (Nat) of an integer.

#eval (7 : Int).natAbs -- 7
#eval (0 : Int).natAbs -- 0
#eval (-11 : Int).natAbs -- 11

Implemented by efficient native code.

Equations

• Int.natAbs m = match m with | Int.ofNat m => m | Int.negSucc m => Nat.succ m

sign

def Int.sign : Int → Int

Returns the "sign" of the integer as another integer: 1 for positive numbers, -1 for negative numbers, and 0 for 0.

Equations

• Int.sign x = match x with | Int.ofNat (Nat.succ n) => 1 | Int.ofNat 0 => 0 | Int.negSucc a => -1

Conversion

def Int.toNat : Int → Nat

Turns an integer into a natural number, negative numbers become 0.

#eval (7 : Int).toNat -- 7
#eval (0 : Int).toNat -- 0
#eval (-7 : Int).toNat -- 0

Equations

• Int.toNat x = match x with | Int.ofNat n => n | Int.negSucc a => 0

def Int.toNat' : Int → Option Nat

• If n : Nat, then int.toNat' n = some n
• If n : Int is negative, then int.toNat' n = none.

Equations

• Int.toNat' x = match x with | Int.ofNat n => some n | Int.negSucc a => none

divisibility

instance Int.instDvdInt : Dvd Int

Divisibility of integers. a ∣ b (typed as \|) says that there is some c such that b = a * c.

Equations

• Int.instDvdInt = { dvd := fun (a b : Int) => ∃ (c : Int), b = a * c }

Powers

def Int.pow (m : Int) : Nat → Int

Power of an integer to some natural number.

#eval (2 : Int) ^ 4 -- 16
#eval (10 : Int) ^ 0 -- 1
#eval (0 : Int) ^ 10 -- 0
#eval (-7 : Int) ^ 3 -- -343

Equations

• Int.pow m 0 = 1
• Int.pow m (Nat.succ m_1) = Int.pow m m_1 * m

instance Int.instHPowIntNat : HPow Int Nat Int

Equations

• Int.instHPowIntNat = { hPow := Int.pow }

instance Int.instLawfulBEqIntInstBEqInstDecidableEqInt : LawfulBEq Int

Equations

• Int.instLawfulBEqIntInstBEqInstDecidableEqInt = ⋯

instance Int.instMinInt : Min Int

Equations

• Int.instMinInt = minOfLe

instance Int.instMaxInt : Max Int

Equations

• Int.instMaxInt = maxOfLe

class IntCast (R : Type u) : Type u

The canonical homomorphism Int → R. In most use cases R will have a ring structure and this will be a ring homomorphism.

• intCast : Int → R

  The canonical map Int → R.

instance instIntCastInt : IntCast Int

Equations

• instIntCastInt = { intCast := fun (n : Int) => n }

@[match_pattern, reducible]

def Int.cast {R : Type u} [IntCast R] : Int → R

Apply the canonical homomorphism from Int to a type R from an IntCast R instance.

In Mathlib there will be such a homomorphism whenever R is an additive group with a 1.

Equations

• Int.cast = IntCast.intCast

instance instCoeTailInt {R : Type u_1} [IntCast R] : CoeTail Int R

Equations

• instCoeTailInt = { coe := Int.cast }

instance instCoeHTCTInt {R : Type u_1} [IntCast R] : CoeHTCT Int R

Equations

• instCoeHTCTInt = { coe := Int.cast }