mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 08:06:43 -05:00
2 lines
No EOL
5.8 KiB
HTML
2 lines
No EOL
5.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bool (ocaml.Stdlib.Bool)</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">ocaml</a> » <a href="../index.html">Stdlib</a> » Bool</nav><header class="odoc-preamble"><h1>Module <code><span>Stdlib.Bool</span></code></h1><p>Boolean values.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08</li></ul></header><nav class="odoc-toc"><ul><li><a href="#bools">Booleans</a></li><li><a href="#preds">Predicates and comparisons</a></li><li><a href="#convert">Converting</a></li></ul></nav><div class="odoc-content"><h2 id="bools"><a href="#bools" class="anchor"></a>Booleans</h2><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> = bool</span><span> = </span></code><ol><li id="type-t.false" class="def variant constructor anchored"><a href="#type-t.false" class="anchor"></a><code><span>| </span><span><span class="constructor">false</span></span></code></li><li id="type-t.true" class="def variant constructor anchored"><a href="#type-t.true" class="anchor"></a><code><span>| </span><span><span class="constructor">true</span></span></code></li></ol></div><div class="spec-doc"><p>The type of booleans (truth values).</p><p>The constructors <code>false</code> and <code>true</code> are included here so that they have paths, but they are not intended to be used in user-defined data types.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-not"><a href="#val-not" class="anchor"></a><code><span><span class="keyword">val</span> not : <span>bool <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>not b</code> is the boolean negation of <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(&&)"><a href="#val-(&&)" class="anchor"></a><code><span><span class="keyword">val</span> (&&) : <span>bool <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>e0 && e1</code> is the lazy boolean conjunction of expressions <code>e0</code> and <code>e1</code>. If <code>e0</code> evaluates to <code>false</code>, <code>e1</code> is not evaluated. Right-associative operator at precedence level 3/11.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(||)"><a href="#val-(||)" class="anchor"></a><code><span><span class="keyword">val</span> (||) : <span>bool <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>e0 || e1</code> is the lazy boolean disjunction of expressions <code>e0</code> and <code>e1</code>. If <code>e0</code> evaluates to <code>true</code>, <code>e1</code> is not evaluated. Right-associative operator at precedence level 2/11.</p></div></div><h2 id="preds"><a href="#preds" class="anchor"></a>Predicates and comparisons</h2><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>bool <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>equal b0 b1</code> is <code>true</code> if and only if <code>b0</code> and <code>b1</code> are both <code>true</code> or both <code>false</code>.</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>bool <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>compare b0 b1</code> is a total order on boolean values. <code>false</code> is smaller than <code>true</code>.</p></div></div><h2 id="convert"><a href="#convert" class="anchor"></a>Converting</h2><div class="odoc-spec"><div class="spec value anchored" id="val-to_int"><a href="#val-to_int" class="anchor"></a><code><span><span class="keyword">val</span> to_int : <span>bool <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>to_int b</code> is <code>0</code> if <code>b</code> is <code>false</code> and <code>1</code> if <code>b</code> is <code>true</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_float"><a href="#val-to_float" class="anchor"></a><code><span><span class="keyword">val</span> to_float : <span>bool <span class="arrow">-></span></span> float</span></code></div><div class="spec-doc"><p><code>to_float b</code> is <code>0.</code> if <code>b</code> is <code>false</code> and <code>1.</code> if <code>b</code> is <code>true</code>.</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>bool <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_string b</code> is <code>"true"</code> if <code>b</code> is <code>true</code> and <code>"false"</code> if <code>b</code> is <code>false</code>.</p></div></div></div></body></html> |