mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-19 09:06:43 -05:00
6 lines
No EOL
8.4 KiB
HTML
6 lines
No EOL
8.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>List (ocaml.Misc.Stdlib.List)</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">Misc</a> » <a href="../index.html">Stdlib</a> » List</nav><header class="odoc-preamble"><h1>Module <code><span>Stdlib.List</span></code></h1></header><div class="odoc-content"><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> <span>'a t</span></span><span> = <span><span class="type-var">'a</span> list</span></span></code></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><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> int)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>The lexicographic order supported by the provided order. There is no constraint on the relative lengths of the lists.</p></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><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Returns <code>true</code> if and only if the given lists have the same length and content with respect to the given equality function.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-some_if_all_elements_are_some"><a href="#val-some_if_all_elements_are_some" class="anchor"></a><code><span><span class="keyword">val</span> some_if_all_elements_are_some : <span><span><span><span class="type-var">'a</span> option</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> option</span></span></code></div><div class="spec-doc"><p>If all elements of the given list are <code>Some _</code> then <code>Some xs</code> is returned with the <code>xs</code> being the contents of those <code>Some</code>s, with order preserved. Otherwise return <code>None</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map2_prefix"><a href="#val-map2_prefix" class="anchor"></a><code><span><span class="keyword">val</span> map2_prefix : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <span class="arrow">-></span></span> <span class="type-var">'c</span>)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'c</span> <a href="#type-t">t</a></span> * <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>let r1, r2 = map2_prefix f l1 l2</code> If <code>l1</code> is of length n and <code>l2 = h2 @ t2</code> with h2 of length n, r1 is <code>List.map2 f l1 h1</code> and r2 is t2.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-split_at"><a href="#val-split_at" class="anchor"></a><code><span><span class="keyword">val</span> split_at : <span>int <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span> * <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>split_at n l</code> returns the pair <code>before, after</code> where <code>before</code> is the <code>n</code> first elements of <code>l</code> and <code>after</code> the remaining ones. If <code>l</code> has less than <code>n</code> elements, raises Invalid_argument.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_prefix"><a href="#val-is_prefix" class="anchor"></a><code><span><span class="keyword">val</span> is_prefix : <span>equal:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> <span>of_:<span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Returns <code>true</code> if and only if the given list, with respect to the given equality function on list members, is a prefix of the list <code>of_</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-longest_common_prefix_result"><a href="#type-longest_common_prefix_result" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a longest_common_prefix_result</span></span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-longest_common_prefix_result.longest_common_prefix" class="def record field anchored"><a href="#type-longest_common_prefix_result.longest_common_prefix" class="anchor"></a><code><span>longest_common_prefix : <span><span class="type-var">'a</span> list</span>;</span></code></li><li id="type-longest_common_prefix_result.first_without_longest_common_prefix" class="def record field anchored"><a href="#type-longest_common_prefix_result.first_without_longest_common_prefix" class="anchor"></a><code><span>first_without_longest_common_prefix : <span><span class="type-var">'a</span> list</span>;</span></code></li><li id="type-longest_common_prefix_result.second_without_longest_common_prefix" class="def record field anchored"><a href="#type-longest_common_prefix_result.second_without_longest_common_prefix" class="anchor"></a><code><span>second_without_longest_common_prefix : <span><span class="type-var">'a</span> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_and_chop_longest_common_prefix"><a href="#val-find_and_chop_longest_common_prefix" class="anchor"></a><code><span><span class="keyword">val</span> find_and_chop_longest_common_prefix :
|
||
<span>equal:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span>
|
||
<span>first:<span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span>
|
||
<span>second:<span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'a</span> <a href="#type-longest_common_prefix_result">longest_common_prefix_result</a></span></span></code></div><div class="spec-doc"><p>Returns the longest list that, with respect to the provided equality function, is a prefix of both of the given lists. The input lists, each with such longest common prefix removed, are also returned.</p></div></div></div></body></html> |