mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
39 lines
No EOL
23 KiB
HTML
39 lines
No EOL
23 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCInt32 (containers.CCInt32)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCInt32</span></h1></header><h2>Int32</h2><p>Helpers for 32-bit integers.</p><p>This module provides operations on the type int32 of signed 32-bit integers.
|
|
Unlike the built-in int type, the type int32 is guaranteed to be exactly
|
|
32-bit wide on all platforms. All arithmetic operations over int32 are taken
|
|
modulo 2<sup>32</sup>.</p><p>Performance notice: values of type int32 occupy more memory space than values
|
|
of type int, and arithmetic operations on int32 are generally slower than
|
|
those on int. Use int32 only when the application requires exact 32-bit arithmetic.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.1</li></ul><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><span class="keyword">sig</span> ... <span class="keyword">end</span></code></span></summary><div class="spec val" id="val-zero"><a href="#val-zero" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>zero : int32</code></div><div class="doc"></div></div><div class="spec val" id="val-one"><a href="#val-one" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>one : int32</code></div><div class="doc"></div></div><div class="spec val" id="val-minus_one"><a href="#val-minus_one" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>minus_one : int32</code></div><div class="doc"></div></div><div class="spec val" id="val-neg"><a href="#val-neg" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>neg : int32 <span class="keyword">‑></span> int32 = "%int32_neg" </code></div><div class="doc"></div></div><div class="spec val" id="val-add"><a href="#val-add" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>add : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_add" </code></div><div class="doc"></div></div><div class="spec val" id="val-sub"><a href="#val-sub" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>sub : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_sub" </code></div><div class="doc"></div></div><div class="spec val" id="val-mul"><a href="#val-mul" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>mul : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_mul" </code></div><div class="doc"></div></div><div class="spec val" id="val-div"><a href="#val-div" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>div : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_div" </code></div><div class="doc"></div></div><div class="spec val" id="val-rem"><a href="#val-rem" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>rem : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_mod" </code></div><div class="doc"></div></div><div class="spec val" id="val-succ"><a href="#val-succ" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>succ : int32 <span class="keyword">‑></span> int32</code></div><div class="doc"></div></div><div class="spec val" id="val-pred"><a href="#val-pred" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pred : int32 <span class="keyword">‑></span> int32</code></div><div class="doc"></div></div><div class="spec val" id="val-abs"><a href="#val-abs" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>abs : int32 <span class="keyword">‑></span> int32</code></div><div class="doc"></div></div><div class="spec val" id="val-max_int"><a href="#val-max_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>max_int : int32</code></div><div class="doc"></div></div><div class="spec val" id="val-min_int"><a href="#val-min_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>min_int : int32</code></div><div class="doc"></div></div><div class="spec val" id="val-logand"><a href="#val-logand" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>logand : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_and" </code></div><div class="doc"></div></div><div class="spec val" id="val-logor"><a href="#val-logor" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>logor : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_or" </code></div><div class="doc"></div></div><div class="spec val" id="val-logxor"><a href="#val-logxor" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>logxor : int32 <span class="keyword">‑></span> int32 <span class="keyword">‑></span> int32 = "%int32_xor" </code></div><div class="doc"></div></div><div class="spec val" id="val-lognot"><a href="#val-lognot" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lognot : int32 <span class="keyword">‑></span> int32</code></div><div class="doc"></div></div><div class="spec val" id="val-shift_left"><a href="#val-shift_left" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>shift_left : int32 <span class="keyword">‑></span> int <span class="keyword">‑></span> int32 = "%int32_lsl" </code></div><div class="doc"></div></div><div class="spec val" id="val-shift_right"><a href="#val-shift_right" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>shift_right : int32 <span class="keyword">‑></span> int <span class="keyword">‑></span> int32 = "%int32_asr" </code></div><div class="doc"></div></div><div class="spec val" id="val-shift_right_logical"><a href="#val-shift_right_logical" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>shift_right_logical : int32 <span class="keyword">‑></span> int <span class="keyword">‑></span> int32 = "%int32_lsr" </code></div><div class="doc"></div></div><div class="spec val" id="val-of_int"><a href="#val-of_int" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>of_int : int <span class="keyword">‑></span> int32 = "%int32_of_int" </code></div><div class="doc"></div></div><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>to_int : int32 <span class="keyword">‑></span> int = "%int32_to_int" </code></div><div class="doc"></div></div><div class="spec val" id="val-of_float"><a href="#val-of_float" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>of_float : float <span class="keyword">‑></span> int32 = "caml_int32_of_float" "caml_int32_of_float_unboxed" </code></div><div class="doc"></div></div><div class="spec val" id="val-to_float"><a href="#val-to_float" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>to_float : int32 <span class="keyword">‑></span> float = "caml_int32_to_float" "caml_int32_to_float_unboxed" </code></div><div class="doc"></div></div><div class="spec val" id="val-of_string"><a href="#val-of_string" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>of_string : string <span class="keyword">‑></span> int32 = "caml_int32_of_string" </code></div><div class="doc"></div></div><div class="spec val" id="val-of_string_opt"><a href="#val-of_string_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_string_opt : string <span class="keyword">‑></span> int32 option</code></div><div class="doc"></div></div><div class="spec val" id="val-to_string"><a href="#val-to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_string : int32 <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-bits_of_float"><a href="#val-bits_of_float" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>bits_of_float : float <span class="keyword">‑></span> int32 = "caml_int32_bits_of_float" "caml_int32_bits_of_float_unboxed" </code></div><div class="doc"></div></div><div class="spec val" id="val-float_of_bits"><a href="#val-float_of_bits" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>float_of_bits : int32 <span class="keyword">‑></span> float = "caml_int32_float_of_bits" "caml_int32_float_of_bits_unboxed" </code></div><div class="doc"></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>int32</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-format"><a href="#val-format" class="anchor"></a><div class="def val"><code><span class="keyword">external </span>format : string <span class="keyword">‑></span> int32 <span class="keyword">‑></span> string = "caml_int32_format" </code></div><div class="doc"></div></div></details></div><div class="spec val" id="val-(+)"><a href="#val-(+)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(+) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Addition.</p></div></div><div class="spec val" id="val-(-)"><a href="#val-(-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Subtraction.</p></div></div><div class="spec val" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(~-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Unary negation.</p></div></div><div class="spec val" id="val-(*)"><a href="#val-(*)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(*) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Multiplication.</p></div></div><div class="spec val" id="val-(/)"><a href="#val-(/)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(/) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Integer division. Raise <code class="code">Division_by_zero</code> if the second
|
|
argument is zero. This division rounds the real quotient of
|
|
its arguments towards zero, as specified for <span class="xref-unresolved" title="unresolved reference to "Pervasives.(/)"">Pervasives.(/)</span>.</p></div></div><div class="spec val" id="val-(mod)"><a href="#val-(mod)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(mod) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x mod y </code> is the integer remainder.
|
|
If <code class="code">y <> zero</code>, the result of <code class="code">x mod y</code> satisfies the following property:
|
|
<code class="code">x = ((x / y) * y) + (x mod y)</code>.
|
|
If <code class="code">y = 0</code>, <code class="code">x mod y</code> raises <code class="code">Division_by_zero</code>.</p></div></div><div class="spec val" id="val-(land)"><a href="#val-(land)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(land) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical and.</p></div></div><div class="spec val" id="val-(lor)"><a href="#val-(lor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical or.</p></div></div><div class="spec val" id="val-(lxor)"><a href="#val-(lxor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lxor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical exclusive or.</p></div></div><div class="spec val" id="val-(lnot)"><a href="#val-(lnot)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lnot) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical negation.</p></div></div><div class="spec val" id="val-(lsl)"><a href="#val-(lsl)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lsl) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code"> x lsl y</code> shifts <code class="code">x</code> to the left by <code class="code">y</code> bits, filling in with zeroes.
|
|
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 32</code>.</p></div></div><div class="spec val" id="val-(lsr)"><a href="#val-(lsr)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lsr) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x lsr y</code> shifts <code class="code">x</code> to the right by <code class="code">y</code> bits.
|
|
This is a logical shift: zeroes are inserted in the vacated bits
|
|
regardless of the sign of <code class="code">x</code>.
|
|
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 32</code>.</p></div></div><div class="spec val" id="val-(asr)"><a href="#val-(asr)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(asr) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x asr y</code> shifts <code class="code">x</code> to the right by <code class="code">y</code> bits.
|
|
This is an arithmetic shift: the sign bit of <code class="code">x</code> is replicated
|
|
and inserted in the vacated bits.
|
|
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 32</code>.</p></div></div><div class="spec module" id="module-Infix"><a href="#module-Infix" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Infix/index.html">Infix</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>The equal function for 32-bit integers.
|
|
Like <span class="xref-unresolved" title="unresolved reference to "Pervasives.(=) x y)"">Pervasives.(=) x y)</span>.</p></div></div><div class="spec val" id="val-hash"><a href="#val-hash" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>hash : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Like <span class="xref-unresolved" title="unresolved reference to "Pervasives.abs (to_int x)"">Pervasives.abs (to_int x)</span>.</p></div></div><h3>Conversion</h3><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_int : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Convert the given 32-bit integer (type <code class="code">int32</code>) to an
|
|
integer (type <code class="code">int</code>). On 32-bit platforms, the 32-bit integer
|
|
is taken modulo 2<sup>31</sup>, i.e. the high-order bit is lost
|
|
during the conversion. On 64-bit platforms, the conversion is exact.</p></div></div><div class="spec val" id="val-of_int"><a href="#val-of_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_int : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Int32.of_int"">Int32.of_int</span>.</p></div></div><div class="spec val" id="val-to_float"><a href="#val-to_float" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_float : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> float</code></div><div class="doc"><p>Convert the given 32-bit integer to a floating-point number.</p></div></div><div class="spec val" id="val-of_float"><a href="#val-of_float" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_float : float <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Int32.of_float"">Int32.of_float</span>.
|
|
Convert the given floating-point number to a 32-bit integer,
|
|
discarding the fractional part (truncate towards 0).
|
|
The result of the conversion is undefined if, after truncation, the number
|
|
is outside the range [<a href="index.html#val-min_int">CCInt32.min_int</a>, <a href="index.html#val-max_int">CCInt32.max_int</a>].</p></div></div><div class="spec val" id="val-to_string"><a href="#val-to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_string : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Return the string representation of its argument, in signed decimal.</p></div></div><div class="spec val" id="val-of_string_exn"><a href="#val-of_string_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_string_exn : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Int32.of_string"">Int32.of_string</span>.
|
|
Convert the given string to a 32-bit integer.
|
|
The string is read in decimal (by default, or if the string
|
|
begins with <code class="code">0u</code>) or in hexadecimal, octal or binary if the
|
|
string begins with <code class="code">0x</code>, <code class="code">0o</code> or <code class="code">0b</code> respectively.</p><p>The <code class="code">0u</code> prefix reads the input as an unsigned integer in the range
|
|
<code class="code">[0, 2*CCInt32.max_int+1]</code>. If the input exceeds <a href="index.html#val-max_int">CCInt32.max_int</a>
|
|
it is converted to the signed integer
|
|
<code class="code">CCInt32.min_int + input - CCInt32.max_int - 1</code>.</p><p>The <code class="code">_</code> (underscore) character can appear anywhere in the string
|
|
and is ignored.
|
|
Raise <code class="code">Failure "Int32.of_string"</code> 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 <code class="code">int32</code>.</p></div></div><div class="spec val" id="val-of_string"><a href="#val-of_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_string : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a> option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-of_string_exn">of_string_exn</a>.
|
|
Like <a href="index.html#val-of_string_exn">of_string_exn</a>, but return <code class="code">None</code> instead of raising.</p></div></div><div class="spec val" id="val-of_string_opt"><a href="#val-of_string_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_string_opt : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a> option</code></div><div class="doc"><p>Alias to <a href="index.html#val-of_string">of_string</a>.</p></div></div></body></html> |