simon/iter
1
0
Fork 0
mirror of https://github.com/c-cube/iter.git synced 2025-12-06 03:05:29 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
iter/api/index_values.html
Simon Cruanes b45371d06d update of API
2013-03-11 00:28:07 +01:00

426 lines
No EOL
18 KiB
HTML
Raw Blame History

<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Sequence" rel="Chapter" href="Sequence.html"><title>Index of values</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of values</h1>
<table>
<tr><td align="left"><br></td></tr>
<tr><td><a href="Sequence.Infix.html#VAL(--)">(--)</a> [<a href="Sequence.Infix.html">Sequence.Infix</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.Infix.html#VAL(@@)">(@@)</a> [<a href="Sequence.Infix.html">Sequence.Infix</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.Infix.html#VAL(|>)">(|&gt;)</a> [<a href="Sequence.Infix.html">Sequence.Infix</a>]</td>
<td></td></tr>
<tr><td align="left"><br>A</td></tr>
<tr><td><a href="Sequence.html#VALappend">append</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Append two sequences
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALarray_slice">array_slice</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
<code class="code">array_slice a i j</code> Sequence of elements whose indexes range
from <code class="code">i</code> to <code class="code">j</code>
</div>
</td></tr>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="Sequence.html#VALconcat">concat</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Concatenate a sequence of sequences into one sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALcycle">cycle</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Cycle forever through the given sequence.
</div>
</td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Sequence.html#VALdrop">drop</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Drop the <code class="code">n</code> first elements of the sequence
</div>
</td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Sequence.html#VALempty">empty</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Empty sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALempty2">empty2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALexists">exists</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Exists there some element satisfying the predicate?
</div>
</td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Sequence.html#VALfilter">filter</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Filter on elements of the sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALflatMap">flatMap</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Monadic bind.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALflatten">flatten</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Alias for <a href="Sequence.html#VALconcat"><code class="code">Sequence.concat</code></a>
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALfold">fold</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Fold over elements of the sequence, consuming it
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALfold2">fold2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALfoldi">foldi</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Fold over elements of the sequence and their index, consuming it
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALfor_all">for_all</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Do all elements satisfy the predicate?
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALforever">forever</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence that calls the given function to produce elements
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALfrom_fun">from_fun</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Call the function repeatedly until it returns None.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALfrom_iter">from_iter</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Build a sequence from a iter function
</div>
</td></tr>
<tr><td align="left"><br>G</td></tr>
<tr><td><a href="Sequence.html#VALgroup">group</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Group equal consecutive elements.
</div>
</td></tr>
<tr><td align="left"><br>H</td></tr>
<tr><td><a href="Sequence.html#VALhashtbl_add">hashtbl_add</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Add elements of the sequence to the hashtable, with
Hashtbl.add
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALhashtbl_keys">hashtbl_keys</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALhashtbl_replace">hashtbl_replace</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Add elements of the sequence to the hashtable, with
Hashtbl.replace (erases conflicting bindings)
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALhashtbl_values">hashtbl_values</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="Sequence.html#VALint_range">int_range</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Iterator on integers in <code class="code">start...stop</code> by steps 1
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALintersperse">intersperse</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Insert the second element between every element of the sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALis_empty">is_empty</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Is the sequence empty?
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALis_empty2">is_empty2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALiter">iter</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Consume the sequence, passing all its arguments to the function
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALiter2">iter2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.TypeClass.html#VALiterable">iterable</a> [<a href="Sequence.TypeClass.html">Sequence.TypeClass</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALiterate">iterate</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
<code class="code">iterate f x</code> is the infinite sequence (x, f(x), f(f(x)), ...)
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALiteri">iteri</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Iterate on elements and their index in the sequence
</div>
</td></tr>
<tr><td align="left"><br>J</td></tr>
<tr><td><a href="Sequence.html#VALjoin">join</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
<code class="code">join ~join_row a b</code> combines every element of <code class="code">a</code> with every
element of <code class="code">b</code> using <code class="code">join_row</code>.
</div>
</td></tr>
<tr><td align="left"><br>K</td></tr>
<tr><td><a href="Sequence.Map.S.html#VALkeys">keys</a> [<a href="Sequence.Map.S.html">Sequence.Map.S</a>]</td>
<td></td></tr>
<tr><td align="left"><br>L</td></tr>
<tr><td><a href="Sequence.html#VALlength">length</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
How long is the sequence?
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALlength2">length2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td align="left"><br>M</td></tr>
<tr><td><a href="Sequence.html#VALmap">map</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Map objects of the sequence into other elements, lazily
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALmap2">map2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALmap2_2">map2_2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
<code class="code">map2_2 f g seq2</code> maps each <code class="code">x, y</code> of seq2 into <code class="code">f x y, g x y</code>
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALmapi">mapi</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Map objects, along with their index in the sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALmax">max</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Max element of the sequence, using the given comparison
function.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALmin">min</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Min element of the sequence, using the given comparison function
</div>
</td></tr>
<tr><td><a href="Sequence.TypeClass.html#VALmonoid">monoid</a> [<a href="Sequence.TypeClass.html">Sequence.TypeClass</a>]</td>
<td></td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Sequence.html#VALof_array">of_array</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_array2">of_array2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_array_i">of_array_i</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Elements of the array, with their index
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALof_hashtbl">of_hashtbl</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of key/value pairs from the hashtable
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALof_hashtbl2">of_hashtbl2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of key/value pairs from the hashtable
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALof_in_channel">of_in_channel</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.TypeClass.html#VALof_iterable">of_iterable</a> [<a href="Sequence.TypeClass.html">Sequence.TypeClass</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_list">of_list</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_queue">of_queue</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of elements contained in the queue, FIFO order
</div>
</td></tr>
<tr><td><a href="Sequence.Map.S.html#VALof_seq">of_seq</a> [<a href="Sequence.Map.S.html">Sequence.Map.S</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.Set.S.html#VALof_seq">of_seq</a> [<a href="Sequence.Set.S.html">Sequence.Set.S</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_set">of_set</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Convert the given set to a sequence.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALof_stack">of_stack</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of elements of the stack (same order as <code class="code">Stack.iter</code>)
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALof_str">of_str</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALof_stream">of_stream</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of elements of a stream (usable only once)
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Sequence.html#VALpersistent">persistent</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Iterate on the sequence, storing elements in a data structure.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALpp_seq">pp_seq</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Pretty print a sequence of <code class="code">'a</code>, using the given pretty printer
to print each elements.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALproduct">product</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Cartesian product of the sequences.
</div>
</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Sequence.html#VALrandom_array">random_array</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of choices of an element in the array
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALrandom_bool">random_bool</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALrandom_float">random_float</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALrandom_int">random_int</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALrandom_list">random_list</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALrepeat">repeat</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Infinite sequence of the same element
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALrev">rev</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Reverse the sequence.
</div>
</td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Sequence.html#VALscan">scan</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sequence of intermediate results
</div>
</td></tr>
<tr><td><a href="Sequence.TypeClass.html#VALsequenceable">sequenceable</a> [<a href="Sequence.TypeClass.html">Sequence.TypeClass</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALsingleton">singleton</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Singleton sequence
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALsort">sort</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sort the sequence.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALsort_uniq">sort_uniq</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Sort the sequence and remove duplicates.
</div>
</td></tr>
<tr><td align="left"><br>T</td></tr>
<tr><td><a href="Sequence.html#VALtake">take</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Take at most <code class="code">n</code> elements from the sequence
</div>
</td></tr>
<tr><td><a href="Sequence.TypeClass.html#VALto_addable">to_addable</a> [<a href="Sequence.TypeClass.html">Sequence.TypeClass</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALto_array">to_array</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Convert to an array.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_buffer">to_buffer</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Copy content of the sequence into the buffer
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_hashtbl">to_hashtbl</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Build a hashtable from a sequence of key/value pairs
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_hashtbl2">to_hashtbl2</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Build a hashtable from a sequence of key/value pairs
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_list">to_list</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALto_queue">to_queue</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Push elements of the sequence into the queue
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_rev_list">to_rev_list</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Get the list of the reversed sequence (more efficient)
</div>
</td></tr>
<tr><td><a href="Sequence.Map.S.html#VALto_seq">to_seq</a> [<a href="Sequence.Map.S.html">Sequence.Map.S</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.Set.S.html#VALto_seq">to_seq</a> [<a href="Sequence.Set.S.html">Sequence.Set.S</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALto_set">to_set</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Convert the sequence to a set, given the proper set module
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_stack">to_stack</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Push elements of the sequence on the stack
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALto_str">to_str</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALto_stream">to_stream</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Convert to a stream.
</div>
</td></tr>
<tr><td align="left"><br>U</td></tr>
<tr><td><a href="Sequence.html#VALunfoldr">unfoldr</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
<code class="code">unfoldr f b</code> will apply <code class="code">f</code> to <code class="code">b</code>.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALuniq">uniq</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Remove consecutive duplicate elements.
</div>
</td></tr>
<tr><td><a href="Sequence.html#VALunzip">unzip</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td align="left"><br>V</td></tr>
<tr><td><a href="Sequence.Map.S.html#VALvalues">values</a> [<a href="Sequence.Map.S.html">Sequence.Map.S</a>]</td>
<td></td></tr>
<tr><td align="left"><br>Z</td></tr>
<tr><td><a href="Sequence.html#VALzip">zip</a> [<a href="Sequence.html">Sequence</a>]</td>
<td></td></tr>
<tr><td><a href="Sequence.html#VALzip_i">zip_i</a> [<a href="Sequence.html">Sequence</a>]</td>
<td><div class="info">
Zip elements of the sequence with their index in the sequence
</div>
</td></tr>
</table>
</body>
</html>
Reference in a new issue View git blame Copy permalink