package octez-proto-libs

  1. Overview
  2. Docs
Octez protocol libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V8/Make/Int64/index.html

Module Make.Int64Source

64-bit integers.

This module provides operations on the type int64 of signed 64-bit integers. Unlike the built-in int type, the type int64 is guaranteed to be exactly 64-bit wide on all platforms. All arithmetic operations over int64 are taken modulo 264

Performance notice: values of type int64 occupy more memory space than values of type int, and arithmetic operations on int64 are generally slower than those on int. Use int64 only when the application requires exact 64-bit arithmetic.

Literals for 64-bit integers are suffixed by L:

  let zero: int64 = 0L
  let one: int64 = 1L
  let m_one: int64 = -1L
Sourceval zero : int64

The 64-bit integer 0.

Sourceval one : int64

The 64-bit integer 1.

Sourceval minus_one : int64

The 64-bit integer -1.

Sourceval neg : int64 -> int64

Unary negation.

Sourceval add : int64 -> int64 -> int64

Addition.

Sourceval sub : int64 -> int64 -> int64

Subtraction.

Sourceval mul : int64 -> int64 -> int64

Multiplication.

Sourceval div : int64 -> int64 -> int64

Integer division.

  • raises Division_by_zero

    if the second argument is zero. This division rounds the real quotient of its arguments towards zero, as specified for Stdlib.(/).

Sourceval rem : int64 -> int64 -> int64

Integer remainder. If y is not zero, the result of Int64.rem x y satisfies the following property: x = Int64.add (Int64.mul (Int64.div x y) y) (Int64.rem x y). If y = 0, Int64.rem x y raises Division_by_zero.

Sourceval succ : int64 -> int64

Successor. Int64.succ x is Int64.add x Int64.one.

Sourceval pred : int64 -> int64

Predecessor. Int64.pred x is Int64.sub x Int64.one.

Sourceval abs : int64 -> int64

Return the absolute value of its argument.

Sourceval max_int : int64

The greatest representable 64-bit integer, 263 - 1.

Sourceval min_int : int64

The smallest representable 64-bit integer, -263.

Sourceval logand : int64 -> int64 -> int64

Bitwise logical and.

Sourceval logor : int64 -> int64 -> int64

Bitwise logical or.

Sourceval logxor : int64 -> int64 -> int64

Bitwise logical exclusive or.

Sourceval lognot : int64 -> int64

Bitwise logical negation.

Sourceval shift_left : int64 -> int -> int64

Int64.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= 64.

Sourceval shift_right : int64 -> int -> int64

Int64.shift_right x y shifts x to the right by y bits. This is an arithmetic shift: the sign bit of x is replicated and inserted in the vacated bits. The result is unspecified if y < 0 or y >= 64.

Sourceval shift_right_logical : int64 -> int -> int64

Int64.shift_right_logical x y shifts x to the right by y bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x. The result is unspecified if y < 0 or y >= 64.

Sourceval of_int : int -> int64

Convert the given integer (type int) to a 64-bit integer (type int64).

Sourceval to_int : int64 -> int

Convert the given 64-bit integer (type int64) to an integer (type int). On 64-bit platforms, the 64-bit integer is taken modulo 263, i.e. the high-order bit is lost during the conversion. On 32-bit platforms, the 64-bit integer is taken modulo 231, i.e. the top 33 bits are lost during the conversion.

Sourceval of_int32 : int32 -> int64

Convert the given 32-bit integer (type int32) to a 64-bit integer (type int64).

Sourceval to_int32 : int64 -> int32

Convert the given 64-bit integer (type int64) to a 32-bit integer (type int32). The 64-bit integer is taken modulo 232, i.e. the top 32 bits are lost during the conversion.

Sourceval of_string_opt : string -> int64 option

Same as of_string, but return None instead of raising.

  • since 4.05
Sourceval to_string : int64 -> string

Return the string representation of its argument, in decimal.

Sourcetype t = int64

An alias for the type of 64-bit integers.

Sourceval compare : t -> t -> int

The comparison function for 64-bit integers, with the same specification as Stdlib.compare. Along with the type t, this function compare allows the module Int64 to be passed as argument to the functors Set.Make and Map.Make.

Sourceval equal : t -> t -> bool

The equal function for int64s.

  • since 4.03.0