Module Tezos_raw_protocol_016_PtMumbai.Script_intSource

Sourcetype 't repr

The types for arbitrary precision integers in Michelson. The type variable 't is always n or z, n num and z num are incompatible.

This is internally a Z.t. This module mostly adds signedness preservation guarantees.

Sourcetype 't num =
  1. | Num_tag of 't repr

num is made algebraic in order to distinguish it from the other type parameters of Script_typed_ir.ty.

Sourcetype n =
  1. | Natural_tag

Flag for natural numbers.

Sourcetype z =
  1. | Integer_tag

Flag for relative numbers.

Sourceval zero_n : n num

Natural zero.

Sourceval one_n : n num

Natural one.

Sourceval succ_n : n num -> n num

Natural successor.

succ_n x is the same as add_n one_n.

Sourceval zero : z num

Relative zero.

Sourceval one : z num

Relative one.

Sourceval compare : 'a num -> 'a num -> int

Compare two numbers as if they were

Sourceval to_string : _ num -> string

Conversion to an OCaml string in decimal notation.

Sourceval of_string : string -> z num option

Conversion from an OCaml string. Returns None in case of an invalid notation. Supports + and - sign modifiers, and 0x, 0o and 0b base modifiers.

Sourceval of_int32 : int32 -> z num

Conversion from an OCaml int32.

Sourceval to_int64 : _ num -> int64 option

Conversion to an OCaml int64, returns None on overflow.

Sourceval of_int64 : int64 -> z num

Conversion from an OCaml int64.

Sourceval to_int : _ num -> int option

Conversion to an OCaml int, returns None on overflow.

Sourceval of_int : int -> z num

Conversion from an OCaml int.

Conversion from a Zarith integer (Z.t).

Conversion to a Zarith integer (Z.t).

Sourceval add_n : n num -> n num -> n num

Addition between naturals.

Sourceval mul_n : n num -> 'a num -> 'a num

Multiplication with a natural.

Sourceval ediv_n : n num -> 'a num -> ('a num * n num) option

Euclidean division of a natural. ediv_n n d returns None if divisor is zero, or Some (q, r) where n = d * q + r and [0 <= r < d] otherwise.

Sourceval add : _ num -> _ num -> z num

Sign agnostic addition. Use add_n when working with naturals to preserve the sign.

Sourceval sub : _ num -> _ num -> z num

Sign agnostic subtraction. Use sub_n when working with naturals to preserve the sign.

Sourceval mul : _ num -> _ num -> z num

Sign agnostic multiplication. Use mul_n when working with a natural to preserve the sign.

Sourceval ediv : _ num -> _ num -> (z num * n num) option

Sign agnostic euclidean division. ediv n d returns None if divisor is zero, or Some (q, r) where n = d * q + r and [0 <= r < |d|] otherwise. Use ediv_n when working with a natural to preserve the sign.

Sourceval abs : z num -> n num

Compute the absolute value of a relative, turning it into a natural.

Sourceval is_nat : z num -> n num option

Partial identity over N.

Sourceval neg : _ num -> z num

Negates a number.

Sourceval int : n num -> z num

Turns a natural into a relative, not changing its value.

Sourceval lognot : _ num -> z num

Reverses each bit in the representation of the number. Also applies to the sign.

Sourceval shift_left_n : n num -> n num -> n num option

Shifts the natural to the left of a number of bits between 0 and 256. Returns None if the amount is too high.

Sourceval shift_right_n : n num -> n num -> n num option

Shifts the natural to the right of a number of bits between 0 and 256. Returns None if the amount is too high.

Sourceval shift_left : 'a num -> n num -> 'a num option

Shifts the number to the left of a number of bits between 0 and 256. Returns None if the amount is too high.

Sourceval shift_right : 'a num -> n num -> 'a num option

Shifts the number to the right of a number of bits between 0 and 256. Returns None if the amount is too high.

Sourceval logor : 'a num -> 'a num -> 'a num

Applies a boolean or operation to each bit.

Sourceval logand : _ num -> n num -> n num

Applies a boolean and operation to each bit.

Sourceval logxor : n num -> n num -> n num

Applies a boolean xor operation to each bit.

Naturals are encoded using Data_encoding.n

Integers are encoded using Data_encoding.z