package optint

  1. Overview
  2. Docs
package optint
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module OptintSource

Sourcetype t

A, at least, 32-bits integer.

Sourceval zero : t

Integer 0.

Sourceval one : t

Integer 1.

Sourceval minus_one : t

Integer (-1).

Sourceval neg : t -> t

Unary negation.

Sourceval add : t -> t -> t

Addition.

Sourceval sub : t -> t -> t

Subtraction.

Sourceval mul : t -> t -> t

Mulitplication.

Sourceval div : t -> t -> t

Integer division. Raise Division_by_zero if the second argument is zero. This division rounds the real quotient of its arguments towrds zero.

Sourceval rem : t -> t -> t

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

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 its argument.

Sourceval max_int : t

The greatest representable integer.

Sourceval min_int : t

The smallest 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 lognot : t -> t

Bitwise logical negation.

Sourceval shift_left : t -> int -> t

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

Sourceval shift_right : t -> int -> t

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

Sourceval shift_right_logical : t -> int -> t

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

Sourceval of_int : int -> t

Convert the given integer (type int ) to t. It's an unsafe function whose semantic is different from architecture.

Sourceval to_int : t -> int

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

Sourceval of_int32 : int32 -> t

Convert the given 32-bit integer (type int32 ) to t integer. It's an unsafe function whose semantic is different from architecture.

Sourceval to_int32 : t -> int32

Convert the given t integer to a 32-bits integer.

Sourceval of_float : float -> t

Convert the given floating-point number to a t integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outise the range min_int, max_int.

Sourceval to_float : t -> float

Convert the given t integer to a floating-point number.

Sourceval of_string : string -> t

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

The 0u prefix reads the input as an unsigned integer in the range [0, 2 * max_int + 1]. If the input exceeds max_int it is converted to the signed integer min_int + input - max_int - 1.

The _ (underscore) character can appear anywhere in the string is ignored. Raise Failure _ if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integer, or if the integer represented exceeds the range of integers representable in type t.

Sourceval of_string_opt : string -> t option

Same as of_string, but return None instead of raising.

Sourceval to_string : t -> string

Return the string representation of its argument, in decimal.

Sourceval compare : t -> t -> int

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

Sourceval equal : t -> t -> bool

The equal function for t.

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

The pretty-printer for t.

Sourcemodule Infix : sig ... end