mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
137 lines
No EOL
25 KiB
HTML
137 lines
No EOL
25 KiB
HTML
<html><head>
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="Start" href="index.html">
|
|
<link title="Index of types" rel=Appendix href="index_types.html">
|
|
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
|
|
<link title="Index of values" rel=Appendix href="index_values.html">
|
|
<link title="Index of class methods" rel=Appendix href="index_methods.html">
|
|
<link title="Index of class types" rel=Appendix href="index_class_types.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="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCArray_slice" rel="Chapter" href="CCArray_slice.html">
|
|
<link title="CCListLabels" rel="Chapter" href="CCListLabels.html">
|
|
<link title="CCArrayLabels" rel="Chapter" href="CCArrayLabels.html">
|
|
<link title="CCEqual" rel="Chapter" href="CCEqual.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCSimple_queue" rel="Chapter" href="CCSimple_queue.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="CCZipper" rel="Chapter" href="CCZipper.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexp_lex" rel="Chapter" href="CCSexp_lex.html"><title>Containers doc : CCOpt</title>
|
|
</head>
|
|
<body>
|
|
<code class="code"><span class="keyword">sig</span><br>
|
|
<span class="keyword">type</span> <span class="keywordsign">'</span>a t = <span class="keywordsign">'</span>a option<br>
|
|
<span class="keyword">val</span> map : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> map_or : default:<span class="keywordsign">'</span>b <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b<br>
|
|
<span class="keyword">val</span> map_lazy : (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b<br>
|
|
<span class="keyword">val</span> is_some : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> bool<br>
|
|
<span class="keyword">val</span> is_none : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> bool<br>
|
|
<span class="keyword">val</span> compare : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> int) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> int<br>
|
|
<span class="keyword">val</span> equal : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> bool<br>
|
|
<span class="keyword">val</span> return : <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( >|= ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( >>= ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> flat_map : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> map2 : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="keywordsign">-></span> <span class="keywordsign">'</span>c) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>c <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> iter : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> unit<br>
|
|
<span class="keyword">val</span> fold : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="keywordsign">-></span> <span class="keywordsign">'</span>a) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br>
|
|
<span class="keyword">val</span> filter : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> if_ : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a option<br>
|
|
<span class="keyword">val</span> exists : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> bool<br>
|
|
<span class="keyword">val</span> for_all : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> bool<br>
|
|
<span class="keyword">val</span> get_or : default:<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br>
|
|
<span class="keyword">val</span> get_exn : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br>
|
|
<span class="keyword">val</span> get_lazy : (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br>
|
|
<span class="keyword">val</span> sequence_l : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> wrap : ?handler:(exn <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b option<br>
|
|
<span class="keyword">val</span> wrap2 :<br>
|
|
?handler:(exn <span class="keywordsign">-></span> bool) <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="keywordsign">-></span> <span class="keywordsign">'</span>c) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="keywordsign">-></span> <span class="keywordsign">'</span>c option<br>
|
|
<span class="keyword">val</span> pure : <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <*> ) : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <$> ) : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> or_ : else_:<span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> or_lazy : else_:(unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <+> ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> choice : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">module</span> <span class="constructor">Infix</span> :<br>
|
|
<span class="keyword">sig</span><br>
|
|
<span class="keyword">val</span> ( >|= ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( >>= ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t) <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <*> ) : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <$> ) : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> ( <+> ) : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">end</span><br>
|
|
<span class="keyword">val</span> to_list : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list<br>
|
|
<span class="keyword">val</span> of_list : <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> to_result : <span class="keywordsign">'</span>e <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a, <span class="keywordsign">'</span>e) <span class="constructor">Result</span>.result<br>
|
|
<span class="keyword">val</span> to_result_lazy : (unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>e) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a, <span class="keywordsign">'</span>e) <span class="constructor">Result</span>.result<br>
|
|
<span class="keyword">val</span> of_result : (<span class="keywordsign">'</span>a, <span class="keywordsign">'</span>b) <span class="constructor">Result</span>.result <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">type</span> <span class="keywordsign">'</span>a sequence = (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br>
|
|
<span class="keyword">type</span> <span class="keywordsign">'</span>a gen = unit <span class="keywordsign">-></span> <span class="keywordsign">'</span>a option<br>
|
|
<span class="keyword">type</span> <span class="keywordsign">'</span>a printer = <span class="constructor">Format</span>.formatter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit<br>
|
|
<span class="keyword">type</span> <span class="keywordsign">'</span>a random_gen = <span class="constructor">Random</span>.<span class="constructor">State</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a<br>
|
|
<span class="keyword">val</span> random : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.random_gen <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="constructor">CCOpt</span>.random_gen<br>
|
|
<span class="keyword">val</span> choice_seq : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="constructor">CCOpt</span>.sequence <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t<br>
|
|
<span class="keyword">val</span> to_gen : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.gen<br>
|
|
<span class="keyword">val</span> to_seq : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.sequence<br>
|
|
<span class="keyword">val</span> pp : <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.printer <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">CCOpt</span>.t <span class="constructor">CCOpt</span>.printer<br>
|
|
<span class="keyword">end</span></code></body></html> |