package integers

You can search for identifiers within the package.

in-package search v0.2.0

Various signed and unsigned integer types for OCaml

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (10)

Authors

Maintainers

Y

yallop@gmail.com

Sources

0.7.0.tar.gz

sha256=8bb517fa9a1818246eb8c4ce34ee1489fbebb4b92defa3a25d13cab8d23ec685

md5=201cf24143d7cb9a3921d572b6e6c42c

doc/integers/Unsigned/UInt64/index.html

Module `Unsigned.UInt64`Source

Unsigned 64-bit integer type and operations.

include S

Sourcetype t

Sourceval add : t -> t -> t

Addition.

Sourceval sub : t -> t -> t

Subtraction.

Sourceval mul : t -> t -> t

Multiplication.

Sourceval div : t -> t -> t

Division. Raise Division_by_zero if the second argument is zero.

Sourceval rem : t -> t -> t

Integer remainder. Raise Division_by_zero if the second argument is zero.

Sourceval max_int : t

The greatest representable integer.

Sourceval logand : t -> t -> t

Bitwise logical and.

Sourceval logor : t -> t -> t

Bitwise logical or.

Sourceval logxor : t -> t -> t

Bitwise logical exclusive or.

Sourceval shift_left : t -> int -> t

shift_left x y shifts x to the left by y bits.

Sourceval shift_right : t -> int -> t

shift_right x y shifts x to the right by y bits.

Sourceval of_int : int -> t

Convert the given int value to an unsigned integer.

Sourceval to_int : t -> int

Convert the given unsigned integer value to an int.

Sourceval of_string : string -> t

Convert the given string to an unsigned integer. Raise Failure if the given string is not a valid representation of an unsigned integer.

Sourceval to_string : t -> string

Return the string representation of its argument.

Sourceval to_hexstring : t -> string

Return the hexadecimal string representation of its argument.

Sourceval zero : t

The integer 0.

Sourceval one : t

The integer 1.

Sourceval lognot : t -> t

Bitwise logical negation.

Sourceval succ : t -> t

Successor.

Sourceval pred : t -> t

Predecessor.

Sourceval compare : t -> t -> int

The comparison function for unsigned integers, with the same specification as Stdlib.compare.

Sourceval equal : t -> t -> bool

Tests for equality, with the same specification as Stdlib.(=).

Sourceval max : t -> t -> t

max x y is the greater of x and y

Sourceval min : t -> t -> t

min x y is the lesser of x and y

Sourceval of_string_opt : string -> t option

Convert the given string to an unsigned integer. Returns None if the given string is not a valid representation of an unsigned integer.

Sourceval pp : Format.formatter -> t -> unit

Output the result of to_string on a formatter.

Sourceval pp_hex : Format.formatter -> t -> unit

Output the result of to_hexstring on a formatter.

Sourcemodule Infix : Infix with type t := t

Sourceval of_int64 : int64 -> t

Convert the given 64-bit signed integer to an unsigned 64-bit integer.

If the signed integer fits within the unsigned range (in other words, if the signed integer is positive) then the numerical values represented by the signed and unsigned integers are the same.

Whether the signed integer fits or not, the function of_int64 is always the inverse of the function to_int64. In other words, to_int64 (of_int64 x) = x holds for all x : int64.

Sourceval to_int64 : t -> int64

Convert the given 64-bit unsigned integer to a signed 64-bit integer.

If the unsigned integer fits within the signed range (in other words, if the unsigned integer is less than Int64.max_int) then the numerical values represented by unsigned and signed integers are the same.

Whether the unsigned integer fits or not, the function to_int64 is always the inverse of the function of_int64. In other words, of_int64 (to_int64 x) = x holds for all x : t.

Sourceval of_uint32 : UInt32.t -> t

Convert the given 32-bit unsigned integer to a 64-bit unsigned integer.

Sourceval to_uint32 : t -> UInt32.t

Convert the given 64-bit unsigned integer to a 32-bit unsigned integer. The 64-bit unsigned integer is taken modulo 2³², i.e. the top 32 bits are lost during the conversion.