package batteries

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

Install 

dune-project
 Dependency

github.com Readme 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.9.0.tar.gz
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb

doc/batteries.unthreaded/BatInt32/index.html

Module BatInt32Source

32-bit integers.

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

Any integer literal followed by l is taken to be an int32. For instance, 1l is Int32.one.

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

This module extends Stdlib's Int32 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 = int32
Sourceval zero : int32

The 32-bit integer 0.

Sourceval one : int32

The 32-bit integer 1.

Sourceval minus_one : int32

The 32-bit integer -1.

Sourceval neg : int32 -> int32

Unary negation.

Sourceval add : int32 -> int32 -> int32

Addition.

Sourceval sub : int32 -> int32 -> int32

Subtraction.

Sourceval mul : int32 -> int32 -> int32

Multiplication.

Sourceval div : int32 -> int32 -> int32

Integer division. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/).

Sourceval unsigned_div : int32 -> int32 -> int32

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

  • since 2.10.0 and OCaml 4.08.0
Sourceval rem : int32 -> int32 -> int32

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

Sourceval unsigned_rem : int32 -> int32 -> int32

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

  • since 2.10.0 and OCaml 4.08.0
Sourceval modulo : int32 -> int32 -> int32
Sourceval pow : int32 -> int32 -> int32
Sourceval succ : int32 -> int32

Successor. Int32.succ x is Int32.add x Int32.one.

Sourceval pred : int32 -> int32

Predecessor. Int32.pred x is Int32.sub x Int32.one.

Sourceval abs : int32 -> int32

Return the absolute value of its argument.

Sourceval max_int : int32

The greatest representable 32-bit integer, 231 - 1.

Sourceval min_int : int32

The smallest representable 32-bit integer, -231.

Sourceval logand : int32 -> int32 -> int32

Bitwise logical and.

Sourceval logor : int32 -> int32 -> int32

Bitwise logical or.

Sourceval logxor : int32 -> int32 -> int32

Bitwise logical exclusive or.

Sourceval lognot : int32 -> int32

Bitwise logical negation

Sourceval shift_left : int32 -> int -> int32

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

Sourceval shift_right : int32 -> int -> int32

Int32.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 >= 32.

Sourceval shift_right_logical : int32 -> int -> int32

Int32.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 >= 32.

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 -> int32

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

Sourceval to_int : int32 -> int

Convert the given 32-bit integer (type int32) to an integer (type int). On 32-bit platforms, the 32-bit integer is taken modulo 231, i.e. the high-order bit is lost during the conversion. On 64-bit platforms, the conversion is exact.

Sourceval unsigned_to_int : int32 -> 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 -> int32

Convert the given floating-point number to a 32-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 [Int32.min_int, Int32.max_int].

Sourceval to_float : int32 -> float

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

Sourceval of_int64 : 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 to_int64 : int32 -> int64

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

Sourceval of_nativeint : nativeint -> int32

Convert the given native integer (type nativeint) to a 32-bit integer (type int32). On 64-bits platform the top 32 bits are lost.

Sourceval to_nativeint : int32 -> nativeint

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

Sourceval of_string : string -> int32

Convert the given string to a 32-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 int32.

Sourceval of_string_opt : string -> int32 option

Same as of_string, but return None instead of raising.

  • since 2.7.0
Sourceval to_string : int32 -> string

Return the string representation of its argument, in signed decimal.

Sourceval bits_of_float : float -> int32

Return the internal representation of the given float according to the IEEE 754 floating-point ``single format'' bit layout. Bit 31 of the result represents the sign of the float; bits 30 to 23 represent the (biased) exponent; bits 22 to 0 represent the mantissa.

Sourceval float_of_bits : int32 -> float

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

Sourceval of_byte : char -> int32
Sourceval to_byte : int32 -> char
Sourceval pack : Bytes.t -> int -> int32 -> unit

pack s off i writes the little endian bit representation of i into byte sequence s at offset off

Sourceval pack_big : Bytes.t -> int -> int32 -> unit

pack_big s off i writes the big endian bit representation of i into byte sequence s at offset off

Sourceval unpack : Bytes.t -> int -> int32

unpack s off reads 4 bytes from byte sequence str starting at offset off as a little-endian int32

Sourceval unpack_big : Bytes.t -> int -> int32

unpack s off reads 4 bytes from byte sequence str starting at offset off as a big-endian int32

Sourceval compare : t -> t -> int

The comparison function for 32-bit integers, with the same specification as Pervasives.compare. Along with the type t, this function compare allows the module Int32 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 32-bit integers.

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

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

Sourceval ord : t -> t -> BatOrd.order
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

Submodules grouping all infix operators

include BatNumber.Bounded with type bounded = t
Sourcetype bounded = t
Sourceval min_num : bounded
Sourceval max_num : bounded

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