Bitwise operations using binary representation of integers

Definitions

• bitwise operations for PosNum and Num,
• SNum, a type that represents integers as a bit string with a sign bit at the end,
• arithmetic operations for SNum.

def PosNum.lor : PosNum → PosNum → PosNum

Bitwise "or" for PosNum.

Equations

• PosNum.one.lor q.bit0 = q.bit1
• PosNum.one.lor x = x
• p.bit0.lor PosNum.one = p.bit1
• x.lor PosNum.one = x
• p.bit0.lor q.bit0 = (p.lor q).bit0
• p.bit0.lor q.bit1 = (p.lor q).bit1
• p.bit1.lor q.bit0 = (p.lor q).bit1
• p.bit1.lor q.bit1 = (p.lor q).bit1

instance PosNum.instOrOp : OrOp PosNum

Equations

• PosNum.instOrOp = { or := PosNum.lor }

@[simp]

theorem PosNum.lor_eq_or (p q : PosNum) : p.lor q = p ||| q

def PosNum.land : PosNum → PosNum → Num

Bitwise "and" for PosNum.

Equations

• PosNum.one.land q.bit0 = 0
• PosNum.one.land x = 1
• p.bit0.land PosNum.one = 0
• x.land PosNum.one = 1
• p.bit0.land q.bit0 = (p.land q).bit0
• p.bit0.land q.bit1 = (p.land q).bit0
• p.bit1.land q.bit0 = (p.land q).bit0
• p.bit1.land q.bit1 = (p.land q).bit1

instance PosNum.instHAndNum : HAnd PosNum PosNum Num

Equations

• PosNum.instHAndNum = { hAnd := PosNum.land }

@[simp]

theorem PosNum.land_eq_and (p q : PosNum) : p.land q = p &&& q

def PosNum.ldiff : PosNum → PosNum → Num

Bitwise fun a b ↦ a && !b for PosNum. For example, ldiff 5 9 = 4:

 101
1001
----
 100

Equations

• PosNum.one.ldiff a.bit0 = 1
• PosNum.one.ldiff x = 0
• p.bit0.ldiff PosNum.one = Num.pos p.bit0
• p.bit1.ldiff PosNum.one = Num.pos p.bit0
• p.bit0.ldiff q.bit0 = (p.ldiff q).bit0
• p.bit0.ldiff q.bit1 = (p.ldiff q).bit0
• p.bit1.ldiff q.bit0 = (p.ldiff q).bit1
• p.bit1.ldiff q.bit1 = (p.ldiff q).bit0

def PosNum.lxor : PosNum → PosNum → Num

Bitwise "xor" for PosNum.

Equations

• PosNum.one.lxor PosNum.one = 0
• PosNum.one.lxor q.bit0 = Num.pos q.bit1
• PosNum.one.lxor q.bit1 = Num.pos q.bit0
• p.bit0.lxor PosNum.one = Num.pos p.bit1
• p.bit1.lxor PosNum.one = Num.pos p.bit0
• p.bit0.lxor q.bit0 = (p.lxor q).bit0
• p.bit0.lxor q.bit1 = (p.lxor q).bit1
• p.bit1.lxor q.bit0 = (p.lxor q).bit1
• p.bit1.lxor q.bit1 = (p.lxor q).bit0

instance PosNum.instHXorNum : HXor PosNum PosNum Num

Equations

• PosNum.instHXorNum = { hXor := PosNum.lxor }

@[simp]

theorem PosNum.lxor_eq_xor (p q : PosNum) : p.lxor q = p ^^^ q

def PosNum.testBit : PosNum → ℕ → Bool

a.testBit n is true iff the n-th bit (starting from the LSB) in the binary representation of a is active. If the size of a is less than n, this evaluates to false.

Equations

• PosNum.one.testBit 0 = true
• PosNum.one.testBit x = false
• a.bit0.testBit 0 = false
• p.bit0.testBit n.succ = p.testBit n
• a.bit1.testBit 0 = true
• p.bit1.testBit n.succ = p.testBit n

def PosNum.oneBits : PosNum → ℕ → List ℕ

n.oneBits 0 is the list of indices of active bits in the binary representation of n.

Equations

• PosNum.one.oneBits x = [x]
• p.bit0.oneBits x = p.oneBits (x + 1)
• p.bit1.oneBits x = x :: p.oneBits (x + 1)

def PosNum.shiftl : PosNum → ℕ → PosNum

Left-shift the binary representation of a PosNum.

Equations

• x.shiftl 0 = x
• x.shiftl n.succ = x.bit0.shiftl n

instance PosNum.instHShiftLeftNat : HShiftLeft PosNum ℕ PosNum

Equations

• PosNum.instHShiftLeftNat = { hShiftLeft := PosNum.shiftl }

@[simp]

theorem PosNum.shiftl_eq_shiftLeft (p : PosNum) (n : ℕ) : p.shiftl n = p <<< n

theorem PosNum.shiftl_succ_eq_bit0_shiftl (p : PosNum) (n : ℕ) : p <<< n.succ = (p <<< n).bit0

def PosNum.shiftr : PosNum → ℕ → Num

Right-shift the binary representation of a PosNum.

Equations

• x.shiftr 0 = Num.pos x
• PosNum.one.shiftr x = 0
• p.bit0.shiftr n.succ = p.shiftr n
• p.bit1.shiftr n.succ = p.shiftr n

instance PosNum.instHShiftRightNatNum : HShiftRight PosNum ℕ Num

Equations

• PosNum.instHShiftRightNatNum = { hShiftRight := PosNum.shiftr }

@[simp]

theorem PosNum.shiftr_eq_shiftRight (p : PosNum) (n : ℕ) : p.shiftr n = p >>> n

def Num.lor : Num → Num → Num

Bitwise "or" for Num.

Equations

• Num.zero.lor x = x
• x.lor Num.zero = x
• (Num.pos p).lor (Num.pos q) = Num.pos (p ||| q)

instance Num.instOrOp : OrOp Num

Equations

• Num.instOrOp = { or := Num.lor }

@[simp]

theorem Num.lor_eq_or (p q : Num) : p.lor q = p ||| q

def Num.land : Num → Num → Num

Bitwise "and" for Num.

Equations

• Num.zero.land x = 0
• x.land Num.zero = 0
• (Num.pos p).land (Num.pos q) = p &&& q

instance Num.instAndOp : AndOp Num

Equations

• Num.instAndOp = { and := Num.land }

@[simp]

theorem Num.land_eq_and (p q : Num) : p.land q = p &&& q

def Num.ldiff : Num → Num → Num

Bitwise fun a b ↦ a && !b for Num. For example, ldiff 5 9 = 4:

 101
1001
----
 100

Equations

• Num.zero.ldiff x = 0
• x.ldiff Num.zero = x
• (Num.pos p).ldiff (Num.pos q) = p.ldiff q

def Num.lxor : Num → Num → Num

Bitwise "xor" for Num.

Equations

• Num.zero.lxor x = x
• x.lxor Num.zero = x
• (Num.pos p).lxor (Num.pos q) = p ^^^ q

instance Num.instXor : Xor Num

Equations

• Num.instXor = { xor := Num.lxor }

@[simp]

theorem Num.lxor_eq_xor (p q : Num) : p.lxor q = p ^^^ q

def Num.shiftl : Num → ℕ → Num

Left-shift the binary representation of a Num.

Equations

• Num.zero.shiftl x = 0
• (Num.pos p).shiftl x = Num.pos (p <<< x)

instance Num.instHShiftLeftNat : HShiftLeft Num ℕ Num

Equations

• Num.instHShiftLeftNat = { hShiftLeft := Num.shiftl }

@[simp]

theorem Num.shiftl_eq_shiftLeft (p : Num) (n : ℕ) : p.shiftl n = p <<< n

def Num.shiftr : Num → ℕ → Num

Right-shift the binary representation of a Num.

Equations

• Num.zero.shiftr x = 0
• (Num.pos p).shiftr x = p >>> x

instance Num.instHShiftRightNat : HShiftRight Num ℕ Num

Equations

• Num.instHShiftRightNat = { hShiftRight := Num.shiftr }

@[simp]

theorem Num.shiftr_eq_shiftRight (p : Num) (n : ℕ) : p.shiftr n = p >>> n

def Num.testBit : Num → ℕ → Bool

a.testBit n is true iff the n-th bit (starting from the LSB) in the binary representation of a is active. If the size of a is less than n, this evaluates to false.

Equations

• Num.zero.testBit x = false
• (Num.pos p).testBit x = p.testBit x

def Num.oneBits : Num → List ℕ

n.oneBits is the list of indices of active bits in the binary representation of n.

Equations

• Num.zero.oneBits = []
• (Num.pos p).oneBits = p.oneBits 0

inductive NzsNum : Type

This is a nonzero (and "non minus one") version of SNum. See the documentation of SNum for more details.

• msb: Bool → NzsNum
• bit: Bool → NzsNum → NzsNum

  Add a bit at the end of a NzsNum.

instance instDecidableEqNzsNum : DecidableEq NzsNum

Equations

• instDecidableEqNzsNum = decEqNzsNum✝

inductive SNum : Type

Alternative representation of integers using a sign bit at the end. The convention on sign here is to have the argument to msb denote the sign of the MSB itself, with all higher bits set to the negation of this sign. The result is interpreted in two's complement.

13 = ..0001101(base 2) = nz (bit1 (bit0 (bit1 (msb true)))) -13 = ..1110011(base 2) = nz (bit1 (bit1 (bit0 (msb false))))

As with Num, a special case must be added for zero, which has no msb, but by two's complement symmetry there is a second special case for -1. Here the Bool field indicates the sign of the number.

0 = ..0000000(base 2) = zero false -1 = ..1111111(base 2) = zero true

• zero: Bool → SNum
• nz: NzsNum → SNum

instance instDecidableEqSNum : DecidableEq SNum

Equations

• instDecidableEqSNum = decEqSNum✝

instance instCoeNzsNumSNum : Coe NzsNum SNum

Equations

• instCoeNzsNumSNum = { coe := SNum.nz }

instance instZeroSNum : Zero SNum

Equations

• instZeroSNum = { zero := SNum.zero false }

instance instOneNzsNum : One NzsNum

Equations

• instOneNzsNum = { one := NzsNum.msb true }

instance instOneSNum : One SNum

Equations

• instOneSNum = { one := SNum.nz 1 }

instance instInhabitedNzsNum : Inhabited NzsNum

Equations

• instInhabitedNzsNum = { default := 1 }

instance instInhabitedSNum : Inhabited SNum

Equations

• instInhabitedSNum = { default := 0 }

The SNum representation uses a bit string, essentially a list of 0 (false) and 1 (true) bits, and the negation of the MSB is sign-extended to all higher bits.

def NzsNum.«term_::_» : Lean.TrailingParserDescr

Add a bit at the end of a NzsNum.

Equations

• NzsNum.«term_::_» = Lean.ParserDescr.trailingNode `NzsNum.«term_::_» 1022 0 (Lean.ParserDescr.binary `andthen (Lean.ParserDescr.symbol "::") (Lean.ParserDescr.cat `term 0))

def NzsNum.sign : NzsNum → Bool

Sign of a NzsNum.

Equations

• (NzsNum.msb b).sign = !b
• (NzsNum.bit a p).sign = p.sign

@[match_pattern]

def NzsNum.not : NzsNum → NzsNum

Bitwise not for NzsNum.

Equations

• (NzsNum.msb b).not = NzsNum.msb (decide ¬b = true)
• (NzsNum.bit a p).not = NzsNum.bit (decide ¬a = true) p.not

def NzsNum.«term~_» : Lean.ParserDescr

Bitwise not for NzsNum.

Equations

• NzsNum.«term~_» = Lean.ParserDescr.node `NzsNum.«term~_» 100 (Lean.ParserDescr.binary `andthen (Lean.ParserDescr.symbol "~") (Lean.ParserDescr.cat `term 100))

def NzsNum.bit0 : NzsNum → NzsNum

Add an inactive bit at the end of a NzsNum. This mimics PosNum.bit0.

Equations

• NzsNum.bit0 = NzsNum.bit false

def NzsNum.bit1 : NzsNum → NzsNum

Add an active bit at the end of a NzsNum. This mimics PosNum.bit1.

Equations

• NzsNum.bit1 = NzsNum.bit true

def NzsNum.head : NzsNum → Bool

The head of a NzsNum is the boolean value of its LSB.

Equations

• (NzsNum.msb b).head = b
• (NzsNum.bit a p).head = a

def NzsNum.tail : NzsNum → SNum

The tail of a NzsNum is the SNum obtained by removing the LSB. Edge cases: tail 1 = 0 and tail (-2) = -1.

Equations

• (NzsNum.msb b).tail = SNum.zero (decide ¬b = true)
• (NzsNum.bit a p).tail = SNum.nz p

def SNum.sign : SNum → Bool

Sign of a SNum.

Equations

• (SNum.zero z).sign = z
• (SNum.nz p).sign = p.sign

@[match_pattern]

def SNum.not : SNum → SNum

Bitwise not for SNum.

Equations

• (SNum.zero z).not = SNum.zero (decide ¬z = true)
• (SNum.nz p).not = SNum.nz p.not

def SNum.«term~_» : Lean.ParserDescr

Bitwise not for SNum.

Equations

• SNum.«term~_» = Lean.ParserDescr.node `SNum.«term~_» 100 (Lean.ParserDescr.binary `andthen (Lean.ParserDescr.symbol "~") (Lean.ParserDescr.cat `term 100))

@[match_pattern]

def SNum.bit : Bool → SNum → SNum

Add a bit at the end of a SNum. This mimics NzsNum.bit.

Equations

• SNum.bit x (SNum.zero z) = if x = z then SNum.zero x else SNum.nz (NzsNum.msb x)
• SNum.bit x (SNum.nz p) = SNum.nz (NzsNum.bit x p)

def SNum.«term_::_» : Lean.TrailingParserDescr

Add a bit at the end of a SNum. This mimics NzsNum.bit.

Equations

• SNum.«term_::_» = Lean.ParserDescr.trailingNode `SNum.«term_::_» 1022 0 (Lean.ParserDescr.binary `andthen (Lean.ParserDescr.symbol "::") (Lean.ParserDescr.cat `term 0))

def SNum.bit0 : SNum → SNum

Add an inactive bit at the end of a SNum. This mimics ZNum.bit0.

Equations

• SNum.bit0 = SNum.bit false

def SNum.bit1 : SNum → SNum

Add an active bit at the end of a SNum. This mimics ZNum.bit1.

Equations

• SNum.bit1 = SNum.bit true

theorem SNum.bit_zero (b : Bool) : SNum.bit b (SNum.zero b) = SNum.zero b

theorem SNum.bit_one (b : Bool) : SNum.bit b (SNum.zero (decide ¬b = true)) = SNum.nz (NzsNum.msb b)

def NzsNum.drec' {C : SNum → Sort u_1} (z : (b : Bool) → C (SNum.zero b)) (s : (b : Bool) → (p : SNum) → C p → C (SNum.bit b p)) (p : NzsNum) : C (SNum.nz p)

A dependent induction principle for NzsNum, with base cases 0 : SNum and (-1) : SNum.

Equations

• NzsNum.drec' z s (NzsNum.msb b) = ⋯.mpr (s b (SNum.zero (decide ¬b = true)) (z (decide ¬b = true)))
• NzsNum.drec' z s (NzsNum.bit a p) = s a (SNum.nz p) (NzsNum.drec' z s p)

def SNum.head : SNum → Bool

The head of a SNum is the boolean value of its LSB.

Equations

• (SNum.zero z).head = z
• (SNum.nz p).head = p.head

def SNum.tail : SNum → SNum

The tail of a SNum is obtained by removing the LSB. Edge cases: tail 1 = 0, tail (-2) = -1, tail 0 = 0 and tail (-1) = -1.

Equations

• (SNum.zero z).tail = SNum.zero z
• (SNum.nz p).tail = p.tail

def SNum.drec' {C : SNum → Sort u_1} (z : (b : Bool) → C (SNum.zero b)) (s : (b : Bool) → (p : SNum) → C p → C (SNum.bit b p)) (p : SNum) : C p

A dependent induction principle for SNum which avoids relying on NzsNum.

Equations

• SNum.drec' z s (SNum.zero z_1) = z z_1
• SNum.drec' z s (SNum.nz p) = NzsNum.drec' z s p

def SNum.rec' {α : Sort u_1} (z : Bool → α) (s : Bool → SNum → α → α) : SNum → α

An induction principle for SNum which avoids relying on NzsNum.

Equations

• SNum.rec' z s = SNum.drec' z s

def SNum.testBit : ℕ → SNum → Bool

SNum.testBit n a is true iff the n-th bit (starting from the LSB) of a is active. If the size of a is less than n, this evaluates to false.

Equations

• SNum.testBit 0 x = x.head
• SNum.testBit n.succ x = SNum.testBit n x.tail

def SNum.succ : SNum → SNum

The successor of a SNum (i.e. the operation adding one).

Equations

• SNum.succ = SNum.rec' (fun (b : Bool) => bif b then 0 else 1) fun (b : Bool) (p succp : SNum) => bif b then SNum.bit false succp else SNum.bit true p

def SNum.pred : SNum → SNum

The predecessor of a SNum (i.e. the operation of removing one).

Equations

• SNum.pred = SNum.rec' (fun (b : Bool) => bif b then SNum.not 1 else SNum.not 0) fun (b : Bool) (p predp : SNum) => bif b then SNum.bit false p else SNum.bit true predp

def SNum.neg (n : SNum) : SNum

The opposite of a SNum.

Equations

• n.neg = n.not.succ

instance SNum.instNeg : Neg SNum

Equations

• SNum.instNeg = { neg := SNum.neg }

def SNum.czAdd : Bool → Bool → SNum → SNum

SNum.czAdd a b n is n + a - b (where a and b should be read as either 0 or 1). This is useful to implement the carry system in cAdd.

Equations

• SNum.czAdd false false x = x
• SNum.czAdd false true x = x.pred
• SNum.czAdd true false x = x.succ
• SNum.czAdd true true x = x

def SNum.bits : SNum → (n : ℕ) → Mathlib.Vector Bool n

a.bits n is the vector of the n first bits of a (starting from the LSB).

Equations

• x.bits 0 = Mathlib.Vector.nil
• x.bits n.succ = x.head ::ᵥ x.tail.bits n

def SNum.cAdd : SNum → SNum → Bool → SNum

SNum.cAdd n m a is n + m + a (where a should be read as either 0 or 1). a represents a carry bit.

Equations

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

def SNum.add (a b : SNum) : SNum

Add two SNums.

Equations

• a.add b = a.cAdd b false

instance SNum.instAdd : Add SNum

Equations

• SNum.instAdd = { add := SNum.add }

def SNum.sub (a b : SNum) : SNum

Subtract two SNums.

Equations

• a.sub b = a + -b

instance SNum.instSub : Sub SNum

Equations

• SNum.instSub = { sub := SNum.sub }

def SNum.mul (a : SNum) : SNum → SNum

Multiply two SNums.

Equations

• a.mul = SNum.rec' (fun (b : Bool) => bif b then -a else 0) fun (b : Bool) (x IH : SNum) => bif b then IH.bit0 + a else IH.bit0

instance SNum.instMul : Mul SNum

Equations

• SNum.instMul = { mul := SNum.mul }