package traits

  1. Overview
  2. Docs

Module Traits.IntSource

Standard traits implementations for int

It includes Stdlib's Int to be able to open Traits without losing access to Int

include module type of struct include Int end

Integers

Sourcetype t = int

The type for integer values.

Sourceval zero : int

zero is the integer 0.

Sourceval one : int

one is the integer 1.

Sourceval minus_one : int

minus_one is the integer -1.

Sourceval neg : int -> int

neg x is ~-x.

Sourceval add : int -> int -> int

add x y is the addition x + y.

Sourceval sub : int -> int -> int

sub x y is the subtraction x - y.

Sourceval mul : int -> int -> int

mul x y is the multiplication x * y.

Sourceval div : int -> int -> int

div x y is the division x / y. See Stdlib.(/) for details.

Sourceval rem : int -> int -> int

rem x y is the remainder x mod y. See Stdlib.(mod) for details.

Sourceval succ : int -> int

succ x is add x 1.

Sourceval pred : int -> int

pred x is sub x 1.

Sourceval abs : int -> int

abs x is the absolute value of x. That is x if x is positive and neg x if x is negative. Warning. This may be negative if the argument is min_int.

Sourceval max_int : int

max_int is the greatest representable integer, 2Sys.int_size - 1-1.

Sourceval min_int : int

min_int is the smallest representable integer, -2Sys.int_size - 1.

Sourceval logand : int -> int -> int

logand x y is the bitwise logical and of x and y.

Sourceval logor : int -> int -> int

logor x y is the bitwise logical or of x and y.

Sourceval logxor : int -> int -> int

logxor x y is the bitwise logical exclusive or of x and y.

Sourceval lognot : int -> int

lognot x is the bitwise logical negation of x.

Sourceval shift_left : int -> int -> int

shift_left x n shifts x to the left by n bits. The result is unspecified if n < 0 or n > Sys.int_size.

Sourceval shift_right : int -> int -> int

shift_right x n shifts x to the right by n bits. This is an arithmetic shift: the sign bit of x is replicated and inserted in the vacated bits. The result is unspecified if n < 0 or n > Sys.int_size.

Sourceval shift_right_logical : int -> int -> int

shift_right x n shifts x to the right by n bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x. The result is unspecified if n < 0 or n > Sys.int_size.

Predicates and comparisons

Sourceval equal : int -> int -> bool

equal x y is true if and only if x = y.

Sourceval compare : int -> int -> int

compare x y is Stdlib.compare x y but more efficient.

Sourceval min : int -> int -> int

Return the smaller of the two arguments.

  • since 4.13
Sourceval max : int -> int -> int

Return the greater of the two arguments.

  • since 4.13

Converting

Sourceval to_float : int -> float

to_float x is x as a floating point number.

Sourceval of_float : float -> int

of_float x truncates x to an integer. The result is unspecified if the argument is nan or falls outside the range of representable integers.

Sourceval to_string : int -> string

to_string x is the written representation of x in decimal.

Sourceval seeded_hash : int -> int -> int

A seeded hash function for ints, with the same output value as Hashtbl.seeded_hash. This function allows this module to be passed as argument to the functor Hashtbl.MakeSeeded.

  • since 5.1
Sourceval hash : int -> int

An unseeded hash function for ints, with the same output value as Hashtbl.hash. This function allows this module to be passed as argument to the functor Hashtbl.Make.

  • since 5.1
Sourcemodule PartialEq : sig ... end
Sourcemodule Eq : sig ... end
Sourcemodule PartialOrd : sig ... end
Sourcemodule Ord : sig ... end
OCaml

Innovation. Community. Security.