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.7.2.tar.gz
md5=1fd7bddce07cf5d244fc9427f7b5e4d4
sha512=c0f2a0fdc8253e0ea999d8d4c58bfbf32b18d251a2e1d9656bf279de5f01a33e9aabac3af4d95f465f8b671e7711ebd37218043face233340a0c11b08fa62f78

doc/batteries.unthreaded/BatInt/Safe_int/index.html

Module BatInt.Safe_intSource

Safe operations on integers.

This module provides operations on the type int of integers. Values of this type may be either 31 bits on 32-bit processors or 63 bits on 64-bit processors. Operations which overflow raise exception Number.Overflow.

This module implements Number.Numeric, Number.Bounded, Number.Discrete.

Important note Untested.

Sourcetype t = int

An alias for the type of integers.

Sourceval zero : t

The integer 0.

Sourceval one : t

The integer 1.

Sourceval minus_one : t

The integer -1.

Sourceval neg : t -> t

Unary negation.

Sourceval add : t -> t -> t

Addition.

Sourceval (+) : t -> t -> t

Addition.

Sourceval sub : t -> t -> t

Subtraction.

Sourceval (-) : t -> t -> t

Subtraction.

Sourceval mul : t -> t -> t

Multiplication.

Sourceval (*) : t -> t -> t

Multiplication.

Sourceval div : t -> t -> t

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

Sourceval (/) : t -> t -> t

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

Sourceval rem : t -> t -> t

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).

Sourceval modulo : t -> t -> t

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.

Sourceval pow : t -> t -> t

pow a b computes ab.

Sourceval (**) : t -> t -> t

a ** b computes ab

Sourceval (<>) : t -> t -> bool

Comparison: a <> b is true if and only if a and b have different values.

Sourceval (>) : t -> t -> bool

Comparison: a > b is true if and only if a is strictly greater than b.

Sourceval (<) : t -> t -> bool

Comparison: a < b is true if and only if a is strictly smaller than b.

Sourceval (>=) : t -> t -> bool

Comparison: a >= b is true if and only if a is greater or equal to b.

Sourceval (<=) : t -> t -> bool

Comparison: a <= b is true if and only if a is smaller or equalto b.

Sourceval (=) : t -> t -> bool

Comparison: a = b if and only if a and b have the same value.

Sourceval max_num : t

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

Sourceval min_num : t

The smallest representable integer, -230 or 262.

Sourceval succ : t -> t

Successor. succ x is add x one.

Sourceval pred : t -> t

Predecessor. pred x is sub x one.

Sourceval abs : t -> t

Return the absolute value of its argument.

Sourceval of_float : float -> t

Convert the given floating-point number to 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].

Sourceval to_float : t -> float

Convert the given integer to a floating-point number.

Sourceval of_string : string -> t

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 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 int.

Sourceval to_string : t -> string

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

Sourceval operations : t BatNumber.numeric
Sourceval of_int : int -> t
Sourceval to_int : t -> int
Submodules regrouping all infix operations on safe integers
Boilerplate code
Sourceval print : 'a BatInnerIO.output -> t -> unit
Sourceval 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.

Sourceval equal : t -> t -> bool

Equality function for integers, useful for HashedType.

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