Batteries user guide : Batteries.Int

# Module Batteries.Int

    module Int: BatInt

    type t = int

An alias for the type of integers.

    val zero : int

The integer `0`.

    val one : int

The integer `1`.

    val minus_one : int

The integer `-1`.

    val neg : int -> int

Unary negation.

    val add : int -> int -> int

Addition.

    val (+) : int -> int -> int

Addition.

    val sub : int -> int -> int

Subtraction.

    val (-) : int -> int -> int

Subtraction.

    val mul : int -> int -> int

Multiplication.

    val ( * ) : int -> int -> int

Multiplication.

    val div : int -> int -> int

Integer division. This division rounds the real quotient of its arguments towards zero, as specified for `Pervasives.(/)`.
Raises `Division_by_zero` if the second argument is zero.

    val (/) : int -> int -> int

Integer division. This division rounds the real quotient of its arguments towards zero, as specified for `Pervasives.(/)`.
Raises `Division_by_zero` if the second argument is zero.

    val rem : int -> int -> int

Integer remainder. If `y` is not zero, the result of `Int.rem x y` satisfies the following property: `x = Int.add (Int.mul (Int.div x y) y) (Int.rem x y)`.
Raises `Division_by_zero` if the second argument is zero.

    val modulo : int -> int -> int

`modulo a b` computes the remainder of the integer division of `a` by `b`. This is defined only if `b <> 0`.

The result of `modulo a b` is a number `m` between `0` and `abs ( b - 1 )` if `a >= 0` or between `~- ( abs ( b - 1 ) )` if `a < 0` and such that `a * k + (abs b) = m`, for some `k`.

    val pow : int -> int -> int

`pow a b` computes ab.
Raises `Invalid_argument` when `b` is negative.

    val ( ** ) : int -> int -> int

`a ** b` computes ab

    val (<>) : int -> int -> bool

    val (>) : int -> int -> bool

    val (<) : int -> int -> bool

    val (>=) : int -> int -> bool

    val (<=) : int -> int -> bool

    val (=) : int -> int -> bool

    val min_num : int

The smallest representable integer, -230 or -262.

    val max_num : int

The greatest representable integer, which is either 230-1 or 262-1.

    val succ : int -> int

Successor. `Int.succ x` is `Int.add x Int.one`.

    val pred : int -> int

Predecessor. `Int.pred x` is `Int.sub x Int.one`.

    val abs : int -> int

Return the absolute value of its argument, except when the argument is `min_num`. In that case, `abs min_num = min_num`.

    val of_float : float -> int

Convert the given floating-point number to integer integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [`Int.min_int`, `Int.max_int`].

    val to_float : int -> float

Convert the given integer to a floating-point number.

    val of_string : string -> int

Convert the given string to an 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 `Invalid_argument` 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 `int`.

    val to_string : int -> string

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

    val min : int -> int -> int

The minimum of two integers. Faster than the polymorphic `min` from the standard library.

    val max : int -> int -> int

The maximum of two integers. Faster than the polymorphic `min` from the standard library.

    val mid : int -> int -> int

Midpoint function; `mid a b` returns `floor((a+b)/2)`, but done correctly to compensate for numeric overflows. The result is an integer that lies between `a` and `b` and is as equidistant from both as possible.

    val popcount : int -> int

Returns the number of 1 bits set in the binary representation of the number. Maybe has problems with negative numbers

    val operations : int BatNumber.numeric

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

Enumerate an interval.

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

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

Enumerate an interval.

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

    val of_int : int -> int

    val to_int : int -> int

###### Submodules regrouping all infix operations

    module Infix: BatNumber.Infix  with type bat__infix_t = t

    module Compare: BatNumber.Compare  with type bat__compare_t = t

###### Boilerplate code

Printing

    val print : 'a BatInnerIO.output -> int -> unit

prints as decimal string

    val print_hex : 'a BatInnerIO.output -> int -> unit

prints as hex string
Compare

    val compare : t -> t -> int

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

    val equal : t -> t -> bool

Equality function for integers, useful for `HashedType`.

    val ord : t -> t -> BatOrd.order

    module Safe_int: sig .. end

Safe operations on integers.