Module Stdlib.Nativeint

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(ocaml
    CONSTRAINT "= 4.14.0"
    FINDLIBS str unix runtime_events threads dynlink)
DkSDKProject_MakeAvailable(ocaml)

Add the Findlib::ocaml library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::ocaml)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install ocaml.4.14.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (ocaml (>= 4.14.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "ocaml" {>= "4.14.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    ))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    ))

val zero : nativeint

The native integer 0.

val one : nativeint

The native integer 1.

val minus_one : nativeint

The native integer -1.

valneg : ``nativeint-> nativeint

Unary negation.

valadd : ``nativeint->``nativeint-> nativeint

Addition.

valsub : ``nativeint->``nativeint-> nativeint

Subtraction.

valmul : ``nativeint->``nativeint-> nativeint

Multiplication.

valdiv : ``nativeint->``nativeint-> nativeint

Integer division. This division rounds the real quotient of its arguments towards zero, as specified for [Stdlib.(/)](../<stdlib/#val-( )="">).

raises Division_by_zero

if the second argument is zero.

</stdlib.html#val-(>

valunsigned_div : ``nativeint->``nativeint-> nativeint

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

since 4.08.0

valrem : ``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.

valunsigned_rem : ``nativeint->``nativeint-> nativeint

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

since 4.08.0

valsucc : ``nativeint-> nativeint

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

valpred : ``nativeint-> nativeint

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

valabs : ``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.

vallogand : ``nativeint->``nativeint-> nativeint

Bitwise logical and.

vallogor : ``nativeint->``nativeint-> nativeint

Bitwise logical or.

vallogxor : ``nativeint->``nativeint-> nativeint

Bitwise logical exclusive or.

vallognot : ``nativeint-> nativeint

Bitwise logical negation.

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

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

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

valof_int : ``int-> nativeint

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

valto_int : ``nativeint-> int

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

valunsigned_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

valof_float : ``float-> nativeint

Convert the given floating-point number to a native integer, discarding the fractional part (truncate towards 0). If the truncated floating-point number is outside the range [Nativeint.min_int, Nativeint.max_int], no exception is raised, and an unspecified, platform-dependent integer is returned.

valto_float : ``nativeint-> float

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

valof_int32 : ``int32-> nativeint

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

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

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

valof_string_opt : ``string-> ``nativeint option

Same as of_string, but return None instead of raising.

since 4.05

valto_string : ``nativeint-> string

Return the string representation of its argument, in decimal.

type t`` = nativeint

An alias for the type of native integers.

valcompare :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.

valunsigned_compare :t -> t -> int

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

since 4.08.0

valequal :t -> t -> bool

The equal function for native ints.

since 4.03.0

valmin :t -> t -> t

Return the smaller of the two arguments.

since 4.13.0

valmax :t -> t -> t

Return the greater of the two arguments.

since 4.13.0

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. 1. Module type MessageSig.MESSAGE
        Module type MessageSig.S
        Module S.ListStorage
        Module S.Message
        Module S.Object
        Module S.Segment
        Module S.Slice
        Module S.StructStorage
        Module type MessageSig.SEGMENT
        Module type MessageSig.SLICE
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. 1. Module type Logs.LOG
      1. ...
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. 1. Module type Logs_lwt.LOG
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. 1. Module type Lwt_io.NumberIO
    1. Module Lwt_list
    1. Module Lwt_main
    1. 1. Module type Lwt_main.Hooks
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. 1. Module type Lwt_pqueue.OrderedType
        Module type Lwt_pqueue.S
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. 1. Module type Lwt_throttle.S
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. 1. ...
      1. Module Stdlib.Nativeint
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint
    1. 1. Module type Stdint.Int