package containers

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

Module CCInt64Source

Int64

Helpers for 64-bit integers

  • since 0.13
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.0
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.0
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 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 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.0
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 unsigned_compare : t -> t -> int

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

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

Return the smaller of the two arguments.

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

Return the greater of the two arguments.

  • since 4.13.0
Sourceval abs : t -> t

Return the absolute value of its argument.

Sourceval max_int : t

The greatest representable 64-bit integer, 263 - 1 = 9_223_372_036_854_775_807.

Sourceval min_int : t

The smallest representable 64-bit integer, -263 = -9_223_372_036_854_775_808.

Sourcemodule Infix : sig ... end

Infix operators

include module type of Infix
Sourceval (+) : t -> t -> t
Sourceval (-) : t -> t -> t
Sourceval (~-) : t -> t
Sourceval (*) : t -> t -> t
Sourceval (/) : t -> t -> t
Sourceval (mod) : t -> t -> t
Sourceval (land) : t -> t -> t
Sourceval (lor) : t -> t -> t
Sourceval (lxor) : t -> t -> t
Sourceval lnot : t -> t
Sourceval (lsl) : t -> int -> t
Sourceval (lsr) : t -> int -> t
Sourceval (asr) : t -> int -> t
Sourceval (=) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval equal : t -> t -> bool

The equal function for 64-bit integers. Like Pervasives.(=)xy).

Sourceval compare : t -> t -> int

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

Sourceval hash : t -> int

Like Pervasives.abs(to_intx).

Conversion

Sourceval to_int : t -> 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_int : int -> t

Alias to Int64.of_int. NOTE: used to return an option, but the function actually never fails.

Sourceval of_int_exn : int -> t
  • deprecated use Int64.of_int instead
Sourceval to_int32 : t -> 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_int32 : int32 -> t

Alias to Int64.of_int32. NOTE: use to return an option, but the function actually never fails.

Sourceval of_int32_exn : int32 -> t
  • deprecated use Int64.of_int32 instead
Sourceval to_nativeint : t -> 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 of_nativeint : nativeint -> t

Alias to Int64.of_nativeint. NOTE: use to return an option, but the function actually never fails.

Sourceval of_nativeint_exn : nativeint -> t
  • deprecated use Int64.of_nativeint instead
Sourceval to_float : t -> float

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

Sourceval of_float : float -> t

Alias to Int64.of_float. Convert the given floating-point number to a 64-bit integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [CCInt64.min_int, CCInt64.max_int]. NOTE: used to return an option, but the function never fails.

Sourceval of_float_exn : float -> t
  • deprecated use Int64.of_float instead
Sourceval to_string : t -> string

Return the string representation of its argument, in decimal.

Sourceval of_string : string -> t option

Safe version of of_string_exn.

Sourceval of_string_opt : string -> t option

Alias to of_string.

  • since 2.1
Sourceval of_string_exn : string -> t

Alias to Int64.of_string. Convert the given string to a 64-bit integer. 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.

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