mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
40 KiB
HTML
2 lines
No EOL
40 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCInt32 (containers.CCInt32)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCInt32</nav><header class="odoc-preamble"><h1>Module <code><span>CCInt32</span></code></h1><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-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></header><nav class="odoc-toc"><ul><li><a href="#conversion">Conversion</a></li><li><a href="#printing">Printing</a></li><li><a href="#infix-operators">Infix Operators</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-zero"><a href="#val-zero" class="anchor"></a><code><span><span class="keyword">val</span> zero : int32</span></code></div><div class="spec-doc"><p>The 32-bit integer 0.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-one"><a href="#val-one" class="anchor"></a><code><span><span class="keyword">val</span> one : int32</span></code></div><div class="spec-doc"><p>The 32-bit integer 1.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-minus_one"><a href="#val-minus_one" class="anchor"></a><code><span><span class="keyword">val</span> minus_one : int32</span></code></div><div class="spec-doc"><p>The 32-bit integer -1.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-neg"><a href="#val-neg" class="anchor"></a><code><span><span class="keyword">val</span> neg : <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Unary negation.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Addition.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sub"><a href="#val-sub" class="anchor"></a><code><span><span class="keyword">val</span> sub : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Subtraction.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-mul"><a href="#val-mul" class="anchor"></a><code><span><span class="keyword">val</span> mul : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Multiplication.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-div"><a href="#val-div" class="anchor"></a><code><span><span class="keyword">val</span> div : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Integer division. This division rounds the real quotient of its arguments towards zero, as specified for <a href="../../ocaml/Stdlib/index.html#val-(/)"><code>Stdlib.(/)</code></a>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Division_by_zero</span> <p>if the second argument is zero.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unsigned_div"><a href="#val-unsigned_div" class="anchor"></a><code><span><span class="keyword">val</span> unsigned_div : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Same as <a href="#val-div"><code>div</code></a>, except that arguments and result are interpreted as <em>unsigned</em> 32-bit integers.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08.0</li></ul></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-rem"><a href="#val-rem" class="anchor"></a><code><span><span class="keyword">val</span> rem : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Integer remainder. If <code>y</code> is not zero, the result of <code>Int32.rem x y</code> satisfies the following property: <code>x = Int32.add (Int32.mul (Int32.div x y) y) (Int32.rem x y)</code>. If <code>y = 0</code>, <code>Int32.rem x y</code> raises <code>Division_by_zero</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unsigned_rem"><a href="#val-unsigned_rem" class="anchor"></a><code><span><span class="keyword">val</span> unsigned_rem : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Same as <a href="#val-rem"><code>rem</code></a>, except that arguments and result are interpreted as <em>unsigned</em> 32-bit integers.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-succ"><a href="#val-succ" class="anchor"></a><code><span><span class="keyword">val</span> succ : <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Successor. <code>Int32.succ x</code> is <code>Int32.add x Int32.one</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pred"><a href="#val-pred" class="anchor"></a><code><span><span class="keyword">val</span> pred : <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Predecessor. <code>Int32.pred x</code> is <code>Int32.sub x Int32.one</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-abs"><a href="#val-abs" class="anchor"></a><code><span><span class="keyword">val</span> abs : <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Return the absolute value of its argument.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_int"><a href="#val-max_int" class="anchor"></a><code><span><span class="keyword">val</span> max_int : int32</span></code></div><div class="spec-doc"><p>The greatest representable 32-bit integer, 2<sup>31</sup> - 1.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_int"><a href="#val-min_int" class="anchor"></a><code><span><span class="keyword">val</span> min_int : int32</span></code></div><div class="spec-doc"><p>The smallest representable 32-bit integer, -2<sup>31</sup>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-logand"><a href="#val-logand" class="anchor"></a><code><span><span class="keyword">val</span> logand : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Bitwise logical and.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-logor"><a href="#val-logor" class="anchor"></a><code><span><span class="keyword">val</span> logor : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Bitwise logical or.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-logxor"><a href="#val-logxor" class="anchor"></a><code><span><span class="keyword">val</span> logxor : <span>int32 <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Bitwise logical exclusive or.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lognot"><a href="#val-lognot" class="anchor"></a><code><span><span class="keyword">val</span> lognot : <span>int32 <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Bitwise logical negation.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-shift_left"><a href="#val-shift_left" class="anchor"></a><code><span><span class="keyword">val</span> shift_left : <span>int32 <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p><code>Int32.shift_left x y</code> shifts <code>x</code> to the left by <code>y</code> bits. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-shift_right"><a href="#val-shift_right" class="anchor"></a><code><span><span class="keyword">val</span> shift_right : <span>int32 <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p><code>Int32.shift_right x y</code> shifts <code>x</code> to the right by <code>y</code> bits. This is an arithmetic shift: the sign bit of <code>x</code> is replicated and inserted in the vacated bits. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-shift_right_logical"><a href="#val-shift_right_logical" class="anchor"></a><code><span><span class="keyword">val</span> shift_right_logical : <span>int32 <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p><code>Int32.shift_right_logical x y</code> shifts <code>x</code> to the right by <code>y</code> bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of <code>x</code>. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-of_int"><a href="#val-of_int" class="anchor"></a><code><span><span class="keyword">val</span> of_int : <span>int <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Convert the given integer (type <code>int</code>) to a 32-bit integer (type <code>int32</code>). On 64-bit platforms, the argument is taken modulo 2<sup>32</sup>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-to_int"><a href="#val-to_int" class="anchor"></a><code><span><span class="keyword">val</span> to_int : <span>int32 <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Convert the given 32-bit integer (type <code>int32</code>) to an integer (type <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="odoc-spec"><div class="spec value anchored" id="val-unsigned_to_int"><a href="#val-unsigned_to_int" class="anchor"></a><code><span><span class="keyword">val</span> unsigned_to_int : <span>int32 <span class="arrow">-></span></span> <span>int option</span></span></code></div><div class="spec-doc"><p>Same as <a href="#val-to_int"><code>to_int</code></a>, but interprets the argument as an <em>unsigned</em> integer. Returns <code>None</code> if the unsigned value of the argument cannot fit into an <code>int</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08.0</li></ul></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-of_float"><a href="#val-of_float" class="anchor"></a><code><span><span class="keyword">val</span> of_float : <span>float <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Convert the given floating-point number to a 32-bit integer, discarding the fractional part (truncate towards 0). If the truncated floating-point number is outside the range [<code>Int32</code>.min_int, <code>Int32</code>.max_int], no exception is raised, and an unspecified, platform-dependent integer is returned.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-to_float"><a href="#val-to_float" class="anchor"></a><code><span><span class="keyword">val</span> to_float : <span>int32 <span class="arrow">-></span></span> float</span></code></div><div class="spec-doc"><p>Convert the given 32-bit integer to a floating-point number.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span>int32 <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Return the string representation of its argument, in signed decimal.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-bits_of_float"><a href="#val-bits_of_float" class="anchor"></a><code><span><span class="keyword">val</span> bits_of_float : <span>float <span class="arrow">-></span></span> int32</span></code></div><div class="spec-doc"><p>Return the internal representation of the given float according to the IEEE 754 floating-point 'single format' bit layout. Bit 31 of the result represents the sign of the float; bits 30 to 23 represent the (biased) exponent; bits 22 to 0 represent the mantissa.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-float_of_bits"><a href="#val-float_of_bits" class="anchor"></a><code><span><span class="keyword">val</span> float_of_bits : <span>int32 <span class="arrow">-></span></span> float</span></code></div><div class="spec-doc"><p>Return the floating-point number whose internal representation, according to the IEEE 754 floating-point 'single format' bit layout, is the given <code>int32</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = int32</span></code></div><div class="spec-doc"><p>An alias for the type of 32-bit integers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>The comparison function for 32-bit integers, with the same specification as <a href="../../ocaml/Stdlib/index.html#val-compare"><code>Stdlib.compare</code></a>. Along with the type <code>t</code>, this function <code>compare</code> allows the module <code>Int32</code> to be passed as argument to the functors <code>Set</code>.Make and <code>Map</code>.Make.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unsigned_compare"><a href="#val-unsigned_compare" class="anchor"></a><code><span><span class="keyword">val</span> unsigned_compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Same as <a href="#val-compare"><code>compare</code></a>, except that arguments are interpreted as <em>unsigned</em> 32-bit integers.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>The equal function for int32s.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.03.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min"><a href="#val-min" class="anchor"></a><code><span><span class="keyword">val</span> min : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>min x y</code> returns the minimum of the two integers <code>x</code> and <code>y</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max"><a href="#val-max" class="anchor"></a><code><span><span class="keyword">val</span> max : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>max x y</code> returns the maximum of the two integers <code>x</code> and <code>y</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>hash x</code> computes the hash of <code>x</code>. Like <code>Stdlib</code>.abs(to_intx).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sign"><a href="#val-sign" class="anchor"></a><code><span><span class="keyword">val</span> sign : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>sign x</code> return <code>0</code> if <code>x = 0</code>, <code>-1</code> if <code>x < 0</code> and <code>1</code> if <code>x > 0</code>. Same as <code>compare x zero</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pow"><a href="#val-pow" class="anchor"></a><code><span><span class="keyword">val</span> pow : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>pow base exponent</code> returns <code>base</code> raised to the power of <code>exponent</code>. <code>pow x y = x^y</code> for positive integers <code>x</code> and <code>y</code>. Raises <code>Invalid_argument</code> if <code>x = y = 0</code> or <code>y</code> < 0.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.11</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-popcount"><a href="#val-popcount" class="anchor"></a><code><span><span class="keyword">val</span> popcount : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Number of bits set to 1.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.9</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-floor_div"><a href="#val-floor_div" class="anchor"></a><code><span><span class="keyword">val</span> floor_div : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>floor_div x n</code> is integer division rounding towards negative infinity. It satisfies <code>x = m * floor_div x n + rem x n</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a printer</span></span><span> = <span><a href="../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-random_gen"><a href="#type-random_gen" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a random_gen</span></span><span> = <span><a href="../../ocaml/Stdlib/Random/State/index.html#type-t">Stdlib.Random.State.t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a iter</span></span><span> = <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-range_by"><a href="#val-range_by" class="anchor"></a><code><span><span class="keyword">val</span> range_by : <span>step:<a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p><code>range_by ~step i j</code> iterates on integers from <code>i</code> to <code>j</code> included, where the difference between successive elements is <code>step</code>. Use a negative <code>step</code> for a decreasing list.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Invalid_argument</span> <p>if <code>step=0</code>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-range"><a href="#val-range" class="anchor"></a><code><span><span class="keyword">val</span> range : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p><code>range i j</code> iterates on integers from <code>i</code> to <code>j</code> included . It works both for decreasing and increasing ranges.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-range'"><a href="#val-range'" class="anchor"></a><code><span><span class="keyword">val</span> range' : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p><code>range' i j</code> is like <a href="#val-range"><code>range</code></a> but the second bound <code>j</code> is excluded. For instance <code>range' 0 5 = Iter.of_list [0;1;2;3;4]</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random"><a href="#val-random" class="anchor"></a><code><span><span class="keyword">val</span> random : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random_small"><a href="#val-random_small" class="anchor"></a><code><span><span class="keyword">val</span> random_small : <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random_range"><a href="#val-random_range" class="anchor"></a><code><span><span class="keyword">val</span> random_range : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><h3 id="conversion"><a href="#conversion" class="anchor"></a>Conversion</h3><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p><code>of_string s</code> is the safe version of <a href="#val-of_string_exn"><code>of_string_exn</code></a>. Like <a href="#val-of_string_exn"><code>of_string_exn</code></a>, but return <code>None</code> instead of raising.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_opt"><a href="#val-of_string_opt" class="anchor"></a><code><span><span class="keyword">val</span> of_string_opt : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p><code>of_string_opt s</code> is an alias to <a href="#val-of_string"><code>of_string</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_exn"><a href="#val-of_string_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_string_exn : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>of_string_exn s</code> converts the given string <code>s</code> into a 32-bit integer. Alias to <code>Int32</code>.of_string. The string is read in decimal (by default, or if the string begins with <code>0u</code>) or in hexadecimal, octal or binary if the string begins with <code>0x</code>, <code>0o</code> or <code>0b</code> respectively.</p><p>The <code>0u</code> prefix reads the input as an unsigned integer in the range <code>[0, 2*CCInt32.max_int+1]</code>. If the input exceeds <a href="#val-max_int"><code>CCInt32.max_int</code></a> it is converted to the signed integer <code>CCInt32.min_int + input - CCInt32.max_int - 1</code>.</p><p>The <code>_</code> (underscore) character can appear anywhere in the string and is ignored. Raise <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>int32</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string_binary"><a href="#val-to_string_binary" class="anchor"></a><code><span><span class="keyword">val</span> to_string_binary : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_string_binary x</code> returns the string representation of the integer <code>x</code>, in binary.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><h3 id="printing"><a href="#printing" class="anchor"></a>Printing</h3><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>pp ppf x</code> prints the integer <code>x</code> on <code>ppf</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_binary"><a href="#val-pp_binary" class="anchor"></a><code><span><span class="keyword">val</span> pp_binary : <span><a href="#type-t">t</a> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>pp_binary ppf x</code> prints <code>x</code> on <code>ppf</code>. Print as "0b00101010".</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><h3 id="infix-operators"><a href="#infix-operators" class="anchor"></a>Infix Operators</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Infix"><a href="#module-Infix" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Infix/index.html">Infix</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <a href="Infix/index.html">Infix</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-(+)"><a href="#val-(+)" class="anchor"></a><code><span><span class="keyword">val</span> (+) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x + y</code> is the sum of <code>x</code> and <code>y</code>. Addition.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(-)"><a href="#val-(-)" class="anchor"></a><code><span><span class="keyword">val</span> (-) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x - y</code> is the difference of <code>x</code> and <code>y</code>. Subtraction.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><code><span><span class="keyword">val</span> (~-) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>~- x</code> is the negation of <code>x</code>. Unary negation.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(*)"><a href="#val-(*)" class="anchor"></a><code><span><span class="keyword">val</span> (*) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code> x * y</code> is the product of <code>x</code> and <code>y</code>. Multiplication.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(/)"><a href="#val-(/)" class="anchor"></a><code><span><span class="keyword">val</span> (/) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x / y</code> is the integer quotient of <code>x</code> and <code>y</code>. Integer division. Raise <code>Division_by_zero</code> if the second argument <code>y</code> is zero. This division rounds the real quotient of its arguments towards zero, as specified for <a href="../../ocaml/Stdlib/index.html#val-(/)"><code>Stdlib.(/)</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(mod)"><a href="#val-(mod)" class="anchor"></a><code><span><span class="keyword">val</span> (mod) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x mod y</code> is the integer remainder of <code>x / y</code>. If <code>y <> zero</code>, the result of <code>x mod y</code> satisfies the following properties: <code>zero <= x mod y < abs y</code> and <code>x = ((x / y) * y) + (x mod y)</code>. If <code>y = 0</code>, <code>x mod y</code> raises <code>Division_by_zero</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(**)"><a href="#val-(**)" class="anchor"></a><code><span><span class="keyword">val</span> (**) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-pow"><code>pow</code></a></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span><span class="keyword">val</span> (--) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-range"><code>range</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span><span class="keyword">val</span> (--^) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-range'"><code>range'</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(land)"><a href="#val-(land)" class="anchor"></a><code><span><span class="keyword">val</span> (land) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x land y</code> is the bitwise logical and of <code>x</code> and <code>y</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(lor)"><a href="#val-(lor)" class="anchor"></a><code><span><span class="keyword">val</span> (lor) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x lor y</code> is the bitwise logical or of <code>x</code> and <code>y</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(lxor)"><a href="#val-(lxor)" class="anchor"></a><code><span><span class="keyword">val</span> (lxor) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x lxor y</code> is the bitwise logical exclusive or of <code>x</code> and <code>y</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lnot"><a href="#val-lnot" class="anchor"></a><code><span><span class="keyword">val</span> lnot : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>lnot x</code> is the bitwise logical negation of <code>x</code> (the bits of <code>x</code> are inverted).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(lsl)"><a href="#val-(lsl)" class="anchor"></a><code><span><span class="keyword">val</span> (lsl) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code> x lsl y</code> shifts <code>x</code> to the left by <code>y</code> bits, filling in with zeroes. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(lsr)"><a href="#val-(lsr)" class="anchor"></a><code><span><span class="keyword">val</span> (lsr) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x lsr y</code> shifts <code>x</code> to the right by <code>y</code> bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of <code>x</code>. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(asr)"><a href="#val-(asr)" class="anchor"></a><code><span><span class="keyword">val</span> (asr) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>x asr y</code> shifts <code>x</code> to the right by <code>y</code> bits. This is an arithmetic shift: the sign bit of <code>x</code> is replicated and inserted in the vacated bits. The result is unspecified if <code>y < 0</code> or <code>y >= 32</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><code><span><span class="keyword">val</span> (<>) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>)"><a href="#val-(>)" class="anchor"></a><code><span><span class="keyword">val</span> (>) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><code><span><span class="keyword">val</span> (<=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<)"><a href="#val-(<)" class="anchor"></a><code><span><span class="keyword">val</span> (<) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div></details></div></div></body></html> |