package stdcompat

You can search for identifiers within the package.

in-package search v0.2.0

package stdcompat

stdcompat
- Stdcompat
  - Arg
  - Array
  - ArrayLabels
  - Atomic
  - Bool
  - Buffer
  - Bytes
  - BytesLabels
  - Char
  - Digest
  - Either
  - Ephemeron
    
    K1
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    K2
    
    Bucket
    
    Make
    
    H1
    
    H2
    
    MakeSeeded
    
    H1
    
    H2
    
    Kn
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    S
    
    SeededS
  - Filename
  - Float
  - Format
  - Fun
  - Hashtbl
    
    S
    
    SeededHashedType
    
    SeededS
  - In_channel
  - Int
  - Int32
  - Int64
  - Lazy
  - Lexing
  - List
  - ListLabels
  - Map
    
    S
  - Nativeint
  - Option
  - Out_channel
  - Pervasives
  - Printexc
  - Printf
  - Queue
  - Random
    
    State
  - Result
  - Seq
  - Set
    
    S
  - Stack
  - StdLabels
    
    Array
    
    Bytes
    
    List
    
    String
  - Stdlib
    
    Arg
    
    Array
    
    ArrayLabels
    
    Atomic
    
    Bool
    
    Buffer
    
    Bytes
    
    BytesLabels
    
    Char
    
    Digest
    
    Either
    
    Ephemeron
    
    K1
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    K2
    
    Bucket
    
    Make
    
    H1
    
    H2
    
    MakeSeeded
    
    H1
    
    H2
    
    Kn
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    S
    
    SeededS
    
    Filename
    
    Float
    
    Format
    
    Fun
    
    Hashtbl
    
    S
    
    SeededHashedType
    
    SeededS
    
    In_channel
    
    Int
    
    Int32
    
    Int64
    
    Lazy
    
    Lexing
    
    List
    
    ListLabels
    
    Map
    
    S
    
    Nativeint
    
    Option
    
    Out_channel
    
    Pervasives
    
    Printexc
    
    Printf
    
    Queue
    
    Random
    
    State
    
    Result
    
    Seq
    
    Set
    
    S
    
    Stack
    
    StdLabels
    
    Array
    
    Bytes
    
    List
    
    String
    
    Stream
    
    String
    
    StringLabels
    
    Sys
    
    Uchar
    
    Unit
    
    Weak
  - Stream
  - String
  - StringLabels
  - Sys
  - Uchar
  - Unit
  - Weak

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of struct include Nativeint end

val zero : nativeint

The native integer 0.

val one : nativeint

The native integer 1.

val minus_one : nativeint

The native integer -1.

val neg : nativeint -> nativeint

Unary negation.

val add : nativeint -> nativeint -> nativeint

Addition.

val sub : nativeint -> nativeint -> nativeint

Subtraction.

val mul : nativeint -> nativeint -> nativeint

Multiplication.

val div : nativeint -> nativeint -> nativeint

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

raises Division_by_zero
if the second argument is zero.

val unsigned_div : nativeint -> nativeint -> nativeint

Same as div, except that arguments and result are interpreted as unsigned native integers.

since 4.08.0

val rem : nativeint -> nativeint -> nativeint

Integer remainder. If y is not zero, the result of Nativeint.rem x y satisfies the following properties: Nativeint.zero <= Nativeint.rem x y < Nativeint.abs y and x = Nativeint.add (Nativeint.mul (Nativeint.div x y) y) (Nativeint.rem x y). If y = 0, Nativeint.rem x y raises Division_by_zero.

val unsigned_rem : nativeint -> nativeint -> nativeint

Same as rem, except that arguments and result are interpreted as unsigned native integers.

since 4.08.0

val succ : nativeint -> nativeint

Successor. Nativeint.succ x is Nativeint.add x Nativeint.one.

val pred : nativeint -> nativeint

Predecessor. Nativeint.pred x is Nativeint.sub x Nativeint.one.

val abs : nativeint -> nativeint

Return the absolute value of its argument.

val size : int

The size in bits of a native integer. This is equal to 32 on a 32-bit platform and to 64 on a 64-bit platform.

val max_int : nativeint

The greatest representable native integer, either 2³¹ - 1 on a 32-bit platform, or 2⁶³ - 1 on a 64-bit platform.

val min_int : nativeint

The smallest representable native integer, either -2³¹ on a 32-bit platform, or -2⁶³ on a 64-bit platform.

val logand : nativeint -> nativeint -> nativeint

Bitwise logical and.

val logor : nativeint -> nativeint -> nativeint

Bitwise logical or.

val logxor : nativeint -> nativeint -> nativeint

Bitwise logical exclusive or.

val lognot : nativeint -> nativeint

Bitwise logical negation.

val shift_left : nativeint -> int -> nativeint

Nativeint.shift_left x y shifts x to the left by y bits. The result is unspecified if y < 0 or y >= bitsize, where bitsize is 32 on a 32-bit platform and 64 on a 64-bit platform.

val shift_right : nativeint -> int -> nativeint

Nativeint.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 >= bitsize.

val shift_right_logical : nativeint -> int -> nativeint

Nativeint.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 >= bitsize.

val of_int : int -> nativeint

Convert the given integer (type int) to a native integer (type nativeint).

val to_int : nativeint -> int

Convert the given native integer (type nativeint) to an integer (type int). The high-order bit is lost during the conversion.

val unsigned_to_int : nativeint -> int option

Same as to_int, but interprets the argument as an unsigned integer. Returns None if the unsigned value of the argument cannot fit into an int.

since 4.08.0

val of_float : float -> nativeint

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

val to_float : nativeint -> float

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

val of_int32 : int32 -> nativeint

Convert the given 32-bit integer (type int32) to a native integer.

val to_int32 : nativeint -> int32

Convert the given native integer to a 32-bit integer (type int32). On 64-bit platforms, the 64-bit native integer is taken modulo 2³², i.e. the top 32 bits are lost. On 32-bit platforms, the conversion is exact.

val of_string : string -> nativeint

Convert the given string to a native 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*Nativeint.max_int+1]. If the input exceeds Nativeint.max_int it is converted to the signed integer Int64.min_int + input - Nativeint.max_int - 1.

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

val of_string_opt : string -> nativeint option

Same as of_string, but return None instead of raising.

since 4.05

val to_string : nativeint -> string

Return the string representation of its argument, in decimal.

type t = nativeint

An alias for the type of native integers.

val compare : t -> t -> int

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

val unsigned_compare : t -> t -> int

Same as compare, except that arguments are interpreted as unsigned native integers.

since 4.08.0

val equal : t -> t -> bool

The equal function for native ints.

since 4.03.0

val min : t -> t -> t

Return the smaller of the two arguments.

since 4.13.0

val max : t -> t -> t

Return the greater of the two arguments.

since 4.13.0