package containers

  1. Overview
  2. Docs
package containers
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module CCInt64Source

Helpers for 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.

  • since 0.13

Documentation for the standard Int64 module

include module type of struct include Int64 end
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 unsigned_div : int64 -> int64 -> int64

Same as div, except that arguments and result are interpreted as unsigned 64-bit integers.

  • since 4.08
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 unsigned_rem : int64 -> int64 -> int64

Same as rem, except that arguments and result are interpreted as unsigned 64-bit integers.

  • since 4.08
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

abs x is the absolute value of x. On min_int this is min_int itself and thus remains negative.

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 unsigned_to_int : int64 -> int option

Same as to_int, but interprets the argument as an unsigned integer. Returns None if the unsigned value of the argument cannot fit into an int.

  • since 4.08
Sourceval of_float : float -> int64

Convert the given floating-point number to a 64-bit integer, discarding the fractional part (truncate towards 0). If the truncated floating-point number is outside the range [Int64.min_int, Int64.max_int], no exception is raised, and an unspecified, platform-dependent integer is returned.

Sourceval to_float : int64 -> float

Convert the given 64-bit integer to a floating-point number.

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_nativeint : nativeint -> int64

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

Sourceval to_nativeint : int64 -> nativeint

Convert the given 64-bit integer (type int64) to a native integer. On 32-bit platforms, the 64-bit integer is taken modulo 232. On 64-bit platforms, the conversion is exact.

Sourceval to_string : int64 -> string

Return the string representation of its argument, in decimal.

Sourceval bits_of_float : float -> int64

Return the internal representation of the given float according to the IEEE 754 floating-point 'double format' bit layout. Bit 63 of the result represents the sign of the float; bits 62 to 52 represent the (biased) exponent; bits 51 to 0 represent the mantissa.

Sourceval float_of_bits : int64 -> float

Return the floating-point number whose internal representation, according to the IEEE 754 floating-point 'double format' bit layout, is the given int64.

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 unsigned_compare : t -> t -> int

Same as compare, except that arguments are interpreted as unsigned 64-bit integers.

  • since 4.08
Sourceval equal : t -> t -> bool

The equal function for int64s.

  • since 4.03
Sourceval seeded_hash : int -> t -> int

A seeded hash function for 64-bit ints, with the same output value as Hashtbl.seeded_hash. This function allows this module to be passed as argument to the functor Hashtbl.MakeSeeded.

  • since 5.1
Sourceval min : t -> t -> t

min x y returns the minimum of the two integers x and y.

  • since 3.0
Sourceval max : t -> t -> t

max x y returns the maximum of the two integers x and y.

  • since 3.0
Sourceval hash : t -> int

hash x computes the hash of x. Like Stdlib.abs(to_intx).

Sourceval popcount : t -> int

Number of bits set to 1.

  • since 3.9
Sourceval sign : t -> int

sign x return 0 if x = 0, -1 if x < 0 and 1 if x > 0. Same as compare x zero.

  • since 3.0
Sourceval pow : t -> t -> t

pow base exponent returns base raised to the power of exponent. pow x y = x^y for positive integers x and y. Raises Invalid_argument if x = y = 0 or y < 0.

  • since 0.11
Sourceval floor_div : t -> t -> t

floor_div x n is integer division rounding towards negative infinity. It satisfies x = m * floor_div x n + rem x n.

  • since 3.0
Sourcetype 'a printer = Format.formatter -> 'a -> unit
Sourcetype 'a random_gen = Random.State.t -> 'a
Sourcetype 'a iter = ('a -> unit) -> unit
Sourceval range_by : step:t -> t -> t -> t iter

range_by ~step i j iterates on integers from i to j included, where the difference between successive elements is step. Use a negative step for a decreasing list.

  • since 3.0
Sourceval range : t -> t -> t iter

range i j iterates on integers from i to j included . It works both for decreasing and increasing ranges.

  • since 3.0
Sourceval range' : t -> t -> t iter

range' i j is like range but the second bound j is excluded. For instance range' 0 5 = Iter.of_list [0;1;2;3;4].

  • since 3.0
Sourceval random : t -> t random_gen
Sourceval random_small : t random_gen
Sourceval random_range : t -> t -> t random_gen

Conversion

Sourceval of_string : string -> t option

of_string s is the safe version of of_string_exn. Like of_string_exn, but return None instead of raising.

Sourceval of_string_opt : string -> t option

of_string_opt s is an alias to of_string.

  • since 2.1
Sourceval of_string_exn : string -> t

of_string_exn s converts the given string s into a 64-bit integer. Alias to Int64.of_string. The string is read in decimal (by default, or if the string begins with 0u) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively.

The 0u prefix reads the input as an unsigned integer in the range [0, 2*CCInt64.max_int+1]. If the input exceeds CCInt64.max_int it is converted to the signed integer CCInt64.min_int + input - CCInt64.max_int - 1.

The _ (underscore) character can appear anywhere in the string and is ignored. Raise Failure "Int64.of_string" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int64.

Sourceval to_string_binary : t -> string

to_string_binary x returns the string representation of the integer x, in binary.

  • since 3.0

Printing

Sourceval pp : t printer

pp ppf x prints the integer x on ppf.

  • since 3.0
Sourceval pp_binary : t printer

pp_binary ppf x prints x on ppf. Print as "0b00101010".

  • since 3.0

Infix Operators

Infix operators

  • since 2.1
Sourcemodule Infix : sig ... end
include module type of Infix
Sourceval (+) : t -> t -> t

x + y is the sum of x and y. Addition.

Sourceval (-) : t -> t -> t

x - y is the difference of x and y. Subtraction.

Sourceval (~-) : t -> t

~- x is the negation of x. Unary negation.

Sourceval (*) : t -> t -> t

x * y is the product of x and y. Multiplication.

Sourceval (/) : t -> t -> t

x / y is the integer quotient of x and y. Integer division. Raise Division_by_zero if the second argument y is zero. This division rounds the real quotient of its arguments towards zero, as specified for Stdlib.(/).

Sourceval (mod) : t -> t -> t

x mod y is the integer remainder of x / y. If y <> zero, the result of x mod y satisfies the following properties: zero <= x mod y < abs y and x = ((x / y) * y) + (x mod y). If y = 0, x mod y raises Division_by_zero.

Sourceval (**) : t -> t -> t

Alias to pow

  • since 3.0
Sourceval (--) : t -> t -> t iter

Alias to range.

  • since 3.0
Sourceval (--^) : t -> t -> t iter

Alias to range'.

  • since 3.0
Sourceval (land) : t -> t -> t

x land y is the bitwise logical and of x and y.

Sourceval (lor) : t -> t -> t

x lor y is the bitwise logical or of x and y.

Sourceval (lxor) : t -> t -> t

x lxor y is the bitwise logical exclusive or of x and y.

Sourceval lnot : t -> t

lnot x is the bitwise logical negation of x (the bits of x are inverted).

Sourceval (lsl) : t -> int -> t

x lsl y shifts x to the left by y bits, filling in with zeroes. The result is unspecified if y < 0 or y >= 64.

Sourceval (lsr) : t -> int -> t

x lsr 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 (asr) : t -> int -> t

x asr 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 (=) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (<) : t -> t -> bool
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct