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
|
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="Int64.html">
<link rel="next" href="Lexing.html">
<link rel="Up" 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 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="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.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="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.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="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.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="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.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="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>Lazy</title>
</head>
<body>
<div class="navbar"><a href="Int64.html">Previous</a>
<a href="index.html">Up</a>
<a href="Lexing.html">Next</a>
</div>
<center><h1>Module <a href="type_Lazy.html">Lazy</a></h1></center>
<br>
<pre><span class="keyword">module</span> Lazy: <code class="code"><span class="keyword">sig</span></code> <a href="Lazy.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Deferred computations.<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type">'a</code> t = <code class="type">'a lazy_t</code> </pre>
<div class="info">
A value of type <code class="code"><span class="keywordsign">'</span>a <span class="constructor">Lazy</span>.t</code> is a deferred computation, called
a suspension, that has a result of type <code class="code"><span class="keywordsign">'</span>a</code>. The special
expression syntax <code class="code"><span class="keyword">lazy</span> (expr)</code> makes a suspension of the
computation of <code class="code">expr</code>, without computing <code class="code">expr</code> itself yet.
"Forcing" the suspension will then compute <code class="code">expr</code> and return its
result.
<p>
Note: <code class="code">lazy_t</code> is the built-in type constructor used by the compiler
for the <code class="code"><span class="keyword">lazy</span></code> keyword. You should not use it directly. Always use
<code class="code"><span class="constructor">Lazy</span>.t</code> instead.
<p>
Note: if the program is compiled with the <code class="code">-rectypes</code> option,
ill-founded recursive definitions of the form <code class="code"><span class="keyword">let</span> <span class="keyword">rec</span> x = <span class="keyword">lazy</span> x</code>
or <code class="code"><span class="keyword">let</span> <span class="keyword">rec</span> x = <span class="keyword">lazy</span>(<span class="keyword">lazy</span>(...(<span class="keyword">lazy</span> x)))</code> are accepted by the type-checker
and lead, when forced, to ill-formed values that trigger infinite
loops in the garbage collector and other parts of the run-time system.
Without the <code class="code">-rectypes</code> option, such ill-founded recursive definitions
are rejected by the type-checker.<br>
</div>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONUndefined"></a>Undefined</pre>
<pre><span class="keyword">val</span> <a name="VALforce"></a>force : <code class="type">'a <a href="Lazy.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">force x</code> forces the suspension <code class="code">x</code> and returns its result.
If <code class="code">x</code> has already been forced, <code class="code"><span class="constructor">Lazy</span>.force x</code> returns the
same value again without recomputing it. If it raised an exception,
the same exception is raised again.
Raise <code class="code"><span class="constructor">Undefined</span></code> if the forcing of <code class="code">x</code> tries to force <code class="code">x</code> itself
recursively.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALforce_val"></a>force_val : <code class="type">'a <a href="Lazy.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">force_val x</code> forces the suspension <code class="code">x</code> and returns its
result. If <code class="code">x</code> has already been forced, <code class="code">force_val x</code>
returns the same value again without recomputing it.
Raise <code class="code"><span class="constructor">Undefined</span></code> if the forcing of <code class="code">x</code> tries to force <code class="code">x</code> itself
recursively.
If the computation of <code class="code">x</code> raises an exception, it is unspecified
whether <code class="code">force_val x</code> raises the same exception or <code class="code"><span class="constructor">Undefined</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlazy_from_fun"></a>lazy_from_fun : <code class="type">(unit -> 'a) -> 'a <a href="Lazy.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">lazy_from_fun f</code> is the same as <code class="code"><span class="keyword">lazy</span> (f ())</code> but slightly more
efficient.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlazy_from_val"></a>lazy_from_val : <code class="type">'a -> 'a <a href="Lazy.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">lazy_from_val v</code> returns an already-forced suspension of <code class="code">v</code>
This is for special purposes only and should not be confused with
<code class="code"><span class="keyword">lazy</span> (v)</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlazy_is_val"></a>lazy_is_val : <code class="type">'a <a href="Lazy.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<code class="code">lazy_is_val x</code> returns <code class="code"><span class="keyword">true</span></code> if <code class="code">x</code> has already been forced and
did not raise an exception.<br>
</div>
</body></html>
|
