simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-containers/3.4/containers/CCEither/index.html
Simon Cruanes 500c31d9bf doc for 3.4
2021-05-03 13:35:10 -04:00

2 lines
No EOL
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCEither (containers.CCEither)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> &#x00BB; CCEither</nav><h1>Module <code>CCEither</code></h1><h2 id="either-monad"><a href="#either-monad" class="anchor"></a>Either Monad</h2><p>Module that is compatible with Either form OCaml 4.12 but can be use with any ocaml version compatible with container</p><dl><dt>since</dt><dd>3.2</dd></dl><nav class="toc"><ul><li><a href="#basics">Basics</a></li><li><a href="#io">IO</a></li></ul></nav></header><dl><dt class="spec type" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span class="keyword">type</span> <span>'a iter</span></code><code> = <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec type" id="type-equal"><a href="#type-equal" class="anchor"></a><code><span class="keyword">type</span> <span>'a equal</span></code><code> = <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> bool</code></dt><dt class="spec type" id="type-ord"><a href="#type-ord" class="anchor"></a><code><span class="keyword">type</span> <span>'a ord</span></code><code> = <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int</code></dt><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type</span> <span>'a printer</span></code><code> = Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit</code></dt></dl><section><header><h3 id="basics"><a href="#basics" class="anchor"></a>Basics</h3></header><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <a href="../CCShimsEither_/index.html">CCShimsEither_</a></code></span></summary><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>('a, 'b) t</span></code><code> = </code><table class="variant"><tr id="type-t.Left" class="anchored"><td class="def constructor"><a href="#type-t.Left" class="anchor"></a><code>| </code><code><span class="constructor">Left</span> <span class="keyword">of</span> <span class="type-var">'a</span></code></td></tr><tr id="type-t.Right" class="anchored"><td class="def constructor"><a href="#type-t.Right" class="anchor"></a><code>| </code><code><span class="constructor">Right</span> <span class="keyword">of</span> <span class="type-var">'b</span></code></td></tr></table></dt></dl></details></div></div></div><dl><dt class="spec value" id="val-left"><a href="#val-left" class="anchor"></a><code><span class="keyword">val</span> left : <span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p><code>left l</code> is <code>Left l</code></p></dd></dl><dl><dt class="spec value" id="val-right"><a href="#val-right" class="anchor"></a><code><span class="keyword">val</span> right : <span class="type-var">'b</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p><code>right r</code> is <code>Right r</code></p></dd></dl><dl><dt class="spec value" id="val-is_left"><a href="#val-is_left" class="anchor"></a><code><span class="keyword">val</span> is_left : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p><code>is_left x</code> checks if <code>x = Left _</code></p></dd></dl><dl><dt class="spec value" id="val-is_right"><a href="#val-is_right" class="anchor"></a><code><span class="keyword">val</span> is_right : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p><code>is_right x</code> checks if <code>x = Right _</code></p></dd></dl><dl><dt class="spec value" id="val-find_left"><a href="#val-find_left" class="anchor"></a><code><span class="keyword">val</span> find_left : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dd><p><code>find_left x</code> returns <code>l</code> if <code>x = Left l</code> and <code>None</code> otherwise.</p></dd></dl><dl><dt class="spec value" id="val-find_right"><a href="#val-find_right" class="anchor"></a><code><span class="keyword">val</span> find_right : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> option</span></code></dt><dd><p><code>find_right x</code> returns <code>r</code> if <code>x = Left r</code> and <code>None</code> otherwise.</p></dd></dl><dl><dt class="spec value" id="val-map_left"><a href="#val-map_left" class="anchor"></a><code><span class="keyword">val</span> map_left : <span>(<span class="type-var">'a1</span> <span>&#45;&gt;</span> <span class="type-var">'a2</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a1</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a2</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map of the Left variant.</p></dd></dl><dl><dt class="spec value" id="val-map_right"><a href="#val-map_right" class="anchor"></a><code><span class="keyword">val</span> map_right : <span>(<span class="type-var">'b1</span> <span>&#45;&gt;</span> <span class="type-var">'b2</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b1</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b2</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map of the Right variant.</p></dd></dl><dl><dt class="spec value" id="val-map"><a href="#val-map" class="anchor"></a><code><span class="keyword">val</span> map : <span>left:<span>(<span class="type-var">'a1</span> <span>&#45;&gt;</span> <span class="type-var">'a2</span>)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b1</span> <span>&#45;&gt;</span> <span class="type-var">'b2</span>)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a1</span>, <span class="type-var">'b1</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a2</span>, <span class="type-var">'b2</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map using <code>left</code> or <code>right</code>.</p></dd></dl><dl><dt class="spec value" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span class="keyword">val</span> fold : <span>left:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'c</span>)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'c</span>)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'c</span></code></dt><dd><p>Fold using <code>left</code> or <code>right</code>.</p></dd></dl><dl><dt class="spec value" id="val-iter"><a href="#val-iter" class="anchor"></a><code><span class="keyword">val</span> iter : <span>left:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> unit)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Iter using <code>left</code> or <code>right</code>.</p></dd></dl><dl><dt class="spec value" id="val-for_all"><a href="#val-for_all" class="anchor"></a><code><span class="keyword">val</span> for_all : <span>left:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Check some property on <code>Left</code> or <code>Right</code> variant.</p></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <span>left:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <span>left:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int)</span></span> <span>&#45;&gt;</span> <span>right:<span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> int)</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int</code></dt></dl></section><section><header><h3 id="io"><a href="#io" class="anchor"></a>IO</h3></header><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <span>left:<span><span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></span></span> <span>&#45;&gt;</span> <span>right:<span><span class="type-var">'b</span> <a href="index.html#type-printer">printer</a></span></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="index.html#type-t">t</a></span> <a href="index.html#type-printer">printer</a></span></code></dt><dd><p>Pretty printer.</p></dd></dl></section></div></body></html>
Reference in a new issue View git blame Copy permalink