mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
12 KiB
HTML
2 lines
No EOL
12 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCInt32.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><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> » <a href="../index.html">CCInt32</a> » Infix</nav><header class="odoc-preamble"><h1>Module <code><span>CCInt32.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-(+)" class="anchored"><a href="#val-(+)" class="anchor"></a><code><span><span class="keyword">val</span> (+) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(-)" class="anchored"><a href="#val-(-)" class="anchor"></a><code><span><span class="keyword">val</span> (-) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(~-)" class="anchored"><a href="#val-(~-)" class="anchor"></a><code><span><span class="keyword">val</span> (~-) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(*)" class="anchored"><a href="#val-(*)" class="anchor"></a><code><span><span class="keyword">val</span> (*) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(/)" class="anchored"><a href="#val-(/)" class="anchor"></a><code><span><span class="keyword">val</span> (/) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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 <code>Stdlib</code>.(/).</p></div></div><div class="odoc-spec"><div class="spec value" id="val-(mod)" class="anchored"><a href="#val-(mod)" class="anchor"></a><code><span><span class="keyword">val</span> (mod) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(**)" class="anchored"><a href="#val-(**)" class="anchor"></a><code><span><span class="keyword">val</span> (**) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p>Alias to <a href="../index.html#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" id="val-(--)" class="anchored"><a href="#val-(--)" class="anchor"></a><code><span><span class="keyword">val</span> (--) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <a href="../index.html#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="../index.html#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" id="val-(--^)" class="anchored"><a href="#val-(--^)" class="anchor"></a><code><span><span class="keyword">val</span> (--^) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <a href="../index.html#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="../index.html#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" id="val-(land)" class="anchored"><a href="#val-(land)" class="anchor"></a><code><span><span class="keyword">val</span> (land) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(lor)" class="anchored"><a href="#val-(lor)" class="anchor"></a><code><span><span class="keyword">val</span> (lor) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(lxor)" class="anchored"><a href="#val-(lxor)" class="anchor"></a><code><span><span class="keyword">val</span> (lxor) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-lnot" class="anchored"><a href="#val-lnot" class="anchor"></a><code><span><span class="keyword">val</span> lnot : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(lsl)" class="anchored"><a href="#val-(lsl)" class="anchor"></a><code><span><span class="keyword">val</span> (lsl) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(lsr)" class="anchored"><a href="#val-(lsr)" class="anchor"></a><code><span><span class="keyword">val</span> (lsr) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(asr)" class="anchored"><a href="#val-(asr)" class="anchor"></a><code><span><span class="keyword">val</span> (asr) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <a href="../index.html#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" id="val-(=)" class="anchored"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(<>)" class="anchored"><a href="#val-(<>)" class="anchor"></a><code><span><span class="keyword">val</span> (<>) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(>)" class="anchored"><a href="#val-(>)" class="anchor"></a><code><span><span class="keyword">val</span> (>) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(>=)" class="anchored"><a href="#val-(>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>=) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(<=)" class="anchored"><a href="#val-(<=)" class="anchor"></a><code><span><span class="keyword">val</span> (<=) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(<)" class="anchored"><a href="#val-(<)" class="anchor"></a><code><span><span class="keyword">val</span> (<) : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div></div></body></html> |