package batteries

  1. Overview
  2. No Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.7.2.tar.gz
md5=1fd7bddce07cf5d244fc9427f7b5e4d4
sha512=c0f2a0fdc8253e0ea999d8d4c58bfbf32b18d251a2e1d9656bf279de5f01a33e9aabac3af4d95f465f8b671e7711ebd37218043face233340a0c11b08fa62f78

doc/batteries.unthreaded/BatInt64/index.html

Module BatInt64Source

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.

Any integer literal followed by L is taken to be an int64. For instance, 1L is Int64.one.

This module extends Stdlib's Int64 module, go there for documentation on the rest of the functions and types.

  • author Xavier Leroy (base module)
  • author Gabriel Scherer
  • author David Teller
Sourcetype t = int64
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. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/).

Sourceval unsigned_div : int64 -> int64 -> int64

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

  • since 2.10.0 and OCaml 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).

Sourceval unsigned_rem : int64 -> int64 -> int64

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

  • since 2.10.0 and OCaml 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 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 (--) : t -> t -> t BatEnum.t

Enumerate an interval.

5L -- 10L is the enumeration 5L,6L,7L,8L,9L,10L. 10L -- 5L is the empty enumeration

Sourceval (---) : t -> t -> t BatEnum.t

Enumerate an interval.

5L -- 10L is the enumeration 5L,6L,7L,8L,9L,10L. 10L -- 5L is the enumeration 10L,9L,8L,7L,6L,5L.

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 2.10.0 and OCaml 4.08.0
Sourceval of_float : float -> int64

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 [Int64.min_int, Int64.max_int].

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 of_string : string -> int64

Convert the given string to a 64-bit integer. The string is read in decimal (by default) or in hexadecimal, octal or binary if the string begins with 0x, 0o or 0b respectively.

  • raises Failure

    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 of_string_opt : string -> int64 option

Same as of_string, but return None instead of raising.

  • since 2.7.0
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.

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 Int64 to be passed as argument to the functors Set.Make and Map.Make.

Sourceval min : t -> t -> t

Return the smaller of the two.

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

Return the greater of the two.

  • since 3.4.0
Sourceval unsigned_compare : t -> t -> int

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

  • since 2.10.0 and OCaml 4.08.0
Sourceval equal : t -> t -> bool

Equality function for 64-bit integers, useful for HashedType.

Sourceval ord : t -> t -> BatOrd.order
Submodules grouping all infix operators
Sourceval modulo : int64 -> int64 -> int64
Sourceval pow : int64 -> int64 -> int64
Sourceval (+) : t -> t -> t
Sourceval (-) : t -> t -> t
Sourceval (*) : t -> t -> t
Sourceval (/) : t -> t -> t
Sourceval (**) : t -> t -> t
Sourceval operations : t BatNumber.numeric
Boilerplate code
Printing
Sourceval print : 'a BatInnerIO.output -> t -> unit

prints as decimal string

Sourceval print_hex : 'a BatInnerIO.output -> t -> unit

prints as hex string

Sourceval seeded_hash : int -> t -> int
Sourceval hash : t -> int