package integers

  1. Overview
  2. Docs
Various signed and unsigned integer types for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (10)

Authors

  1. J
    Jeremy Yallop
  2. D
    Demi Obenour
  3. S
    Stephane Glondu
  4. A
    Andreas Hauptmann

Maintainers

  1. Y
    yallop@gmail.com

Sources

0.6.0.tar.gz
sha256=7b4bd5f03270201aa22612137edb7844f752e201012b6b584620b76fa0062bf8
md5=a1e2412f4a0d88757d1a4297f18b374e

doc/integers/Signed/SInt/index.html

Module Signed.SIntSource

C's signed integer type and operations.

Sourcetype t
Sourcemodule Infix : Infix with type t := t
include Unsigned.S with type t := t with module Infix := Infix
Sourceval add : t -> t -> t

Addition.

Sourceval sub : t -> t -> t

Subtraction.

Sourceval mul : t -> t -> t

Multiplication.

Sourceval div : t -> t -> t

Division. Raise Division_by_zero if the second argument is zero.

Sourceval rem : t -> t -> t

Integer remainder. Raise Division_by_zero if the second argument is zero.

Sourceval max_int : t

The greatest 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 shift_left : t -> int -> t

shift_left x y shifts x to the left by y bits.

Sourceval shift_right : t -> int -> t

shift_right x y shifts x to the right by y bits.

Sourceval of_int : int -> t

Convert the given int value to an unsigned integer.

Sourceval to_int : t -> int

Convert the given unsigned integer value to an int.

Sourceval of_string : string -> t

Convert the given string to an unsigned integer. Raise Failure if the given string is not a valid representation of an unsigned integer.

Sourceval to_string : t -> string

Return the string representation of its argument.

Sourceval to_hexstring : t -> string

Return the hexadecimal string representation of its argument.

Sourceval zero : t

The integer 0.

Sourceval one : t

The integer 1.

Sourceval lognot : t -> t

Bitwise logical negation.

Sourceval succ : t -> t

Successor.

Sourceval pred : t -> t

Predecessor.

Sourceval compare : t -> t -> int

The comparison function for unsigned integers, with the same specification as Stdlib.compare.

Sourceval equal : t -> t -> bool

Tests for equality, with the same specification as Stdlib.(=).

Sourceval max : t -> t -> t

max x y is the greater of x and y

Sourceval min : t -> t -> t

min x y is the lesser of x and y

Sourceval of_string_opt : string -> t option

Convert the given string to an unsigned integer. Returns None if the given string is not a valid representation of an unsigned integer.

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

Output the result of to_string on a formatter.

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

Output the result of to_hexstring on a formatter.

Sourceval neg : t -> t

Unary negation.

Sourceval abs : t -> t

Return the absolute value of its argument.

Sourceval minus_one : t

The value -1

Sourceval min_int : t

The smallest representable integer.

Sourceval shift_right_logical : t -> int -> t

shift_right_logical x y shifts x to the right by y bits. See Int32.shift_right_logical.

Sourceval of_nativeint : nativeint -> t

Convert the given nativeint value to a signed integer.

Sourceval to_nativeint : t -> nativeint

Convert the given signed integer to a nativeint value.

Sourceval of_int64 : int64 -> t

Convert the given int64 value to a signed integer.

Sourceval to_int64 : t -> int64

Convert the given signed integer to an int64 value.