1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Stdlib.Format.html">
<link rel="next" href="Stdlib.Gc.html">
<link rel="Up" href="Stdlib.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of extensions" rel=Appendix href="index_extensions.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 modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Bool" rel="Chapter" href="Bool.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Bytes" rel="Chapter" href="Bytes.html">
<link title="BytesLabels" rel="Chapter" href="BytesLabels.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html">
<link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html">
<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Ephemeron" rel="Chapter" href="Ephemeron.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Float" rel="Chapter" href="Float.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Fun" rel="Chapter" href="Fun.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int" rel="Chapter" href="Int.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Ocaml_operators" rel="Chapter" href="Ocaml_operators.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Option" rel="Chapter" href="Option.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Result" rel="Chapter" href="Result.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Seq" rel="Chapter" href="Seq.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Spacetime" rel="Chapter" href="Spacetime.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Stdlib" rel="Chapter" href="Stdlib.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Uchar" rel="Chapter" href="Uchar.html">
<link title="Unit" rel="Chapter" href="Unit.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><link title="Combinators" rel="Section" href="#combinators">
<link title="Exception handling" rel="Section" href="#exception">
<title>Stdlib.Fun</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Stdlib.Format.html" title="Stdlib.Format">Previous</a>
<a class="up" href="Stdlib.html" title="Stdlib">Up</a>
<a class="post" href="Stdlib.Gc.html" title="Stdlib.Gc">Next</a>
</div>
<h1>Module <a href="type_Stdlib.Fun.html">Stdlib.Fun</a></h1>
<pre><span id="MODULEFun"><span class="keyword">module</span> Fun</span>: <code class="type"><a href="Fun.html">Fun</a></code></pre><hr width="100%">
<h2 id="combinators">Combinators</h2>
<pre><span id="VALid"><span class="keyword">val</span> id</span> : <code class="type">'a -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">id</code> is the identity function. For any argument <code class="code">x</code>, <code class="code">id x</code> is <code class="code">x</code>.</p>
</div>
</div>
<pre><span id="VALconst"><span class="keyword">val</span> const</span> : <code class="type">'a -> 'b -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">const c</code> is a function that always returns the value <code class="code">c</code>. For any
argument <code class="code">x</code>, <code class="code">(const c) x</code> is <code class="code">c</code>.</p>
</div>
</div>
<pre><span id="VALflip"><span class="keyword">val</span> flip</span> : <code class="type">('a -> 'b -> 'c) -> 'b -> 'a -> 'c</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">flip f</code> reverses the argument order of the binary function
<code class="code">f</code>. For any arguments <code class="code">x</code> and <code class="code">y</code>, <code class="code">(flip f) x y</code> is <code class="code">f y x</code>.</p>
</div>
</div>
<pre><span id="VALnegate"><span class="keyword">val</span> negate</span> : <code class="type">('a -> bool) -> 'a -> bool</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">negate p</code> is the negation of the predicate function <code class="code">p</code>. For any
argument <code class="code">x</code>, <code class="code">(negate p) x</code> is <code class="code">not (p x)</code>.</p>
</div>
</div>
<h2 id="exception">Exception handling</h2>
<pre><span id="VALprotect"><span class="keyword">val</span> protect</span> : <code class="type">finally:(unit -> unit) -> (unit -> 'a) -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">protect ~finally work</code> invokes <code class="code">work ()</code> and then <code class="code">finally ()</code>
before <code class="code">work ()</code> returns with its value or an exception. In the
latter case the exception is re-raised after <code class="code">finally ()</code>. If
<code class="code">finally ()</code> raises an exception, then the exception
<a href="Fun.html#EXCEPTIONFinally_raised"><code class="code"><span class="constructor">Fun</span>.<span class="constructor">Finally_raised</span></code></a> is raised instead.</p>
<p><code class="code">protect</code> can be used to enforce local invariants whether <code class="code">work ()</code>
returns normally or raises an exception. However, it does not
protect against unexpected exceptions raised inside <code class="code">finally ()</code>
such as <a href="Stdlib.html#EXCEPTIONOut_of_memory"><code class="code"><span class="constructor">Out_of_memory</span></code></a>, <a href="Stdlib.html#EXCEPTIONStack_overflow"><code class="code"><span class="constructor">Stack_overflow</span></code></a>, or
asynchronous exceptions raised by signal handlers
(e.g. <a href="Sys.html#EXCEPTIONBreak"><code class="code"><span class="constructor">Sys</span>.<span class="constructor">Break</span></code></a>).</p>
<p>Note: It is a <em>programming error</em> if other kinds of exceptions
are raised by <code class="code">finally</code>, as any exception raised in <code class="code">work ()</code> will
be lost in the event of a <a href="Fun.html#EXCEPTIONFinally_raised"><code class="code"><span class="constructor">Fun</span>.<span class="constructor">Finally_raised</span></code></a> exception. Therefore,
one should make sure to handle those inside the finally.</p>
</div>
</div>
<pre><span id="EXCEPTIONFinally_raised"><span class="keyword">exception</span> Finally_raised</span> <span class="keyword">of</span> <code class="type">exn</code></pre>
<div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Finally_raised</span> exn</code> is raised by <code class="code">protect ~finally work</code> when
<code class="code">finally</code> raises an exception <code class="code">exn</code>. This exception denotes either
an unexpected exception or a programming error. As a general rule,
one should not catch a <code class="code"><span class="constructor">Finally_raised</span></code> exception except as part of
a catch-all handler.</p>
</div>
</div>
</body></html>
|
