1Lazy(3)                          OCaml library                         Lazy(3)
2
3
4

NAME

6       Lazy - Deferred computations.
7

Module

9       Module   Lazy
10

Documentation

12       Module Lazy
13        : sig end
14
15
16       Deferred computations.
17
18
19
20
21
22       type 'a t = 'a CamlinternalLazy.t
23
24
25       A  value  of type 'a Lazy.t is a deferred computation, called a suspen‐
26       sion, that has a result of type 'a .   The  special  expression  syntax
27       lazy  (expr)  makes  a  suspension of the computation of expr , without
28       computing expr itself yet.  "Forcing" the suspension will then  compute
29       expr and return its result. Matching a suspension with the special pat‐
30       tern syntax lazy(pattern) also computes the underlying  expression  and
31       tries to bind it to pattern :
32
33
34           let lazy_option_map f x =
35           match x with
36           | lazy (Some x) -> Some (Lazy.force f x)
37           | _ -> None
38
39
40       Note:  If lazy patterns appear in multiple cases in a pattern-matching,
41       lazy expressions may be forced even  outside  of  the  case  ultimately
42       selected  by the pattern matching. In the example above, the suspension
43       x is always computed.
44
45       Note: lazy_t is the built-in type constructor used by the compiler  for
46       the  lazy  keyword.  You should not use it directly.  Always use Lazy.t
47       instead.
48
49       Note: Lazy.force is not thread-safe.  If  you  use  this  module  in  a
50       multi-threaded program, you will need to add some locks.
51
52       Note: if the program is compiled with the -rectypes option, ill-founded
53       recursive definitions of the form let rec x = lazy x or  let  rec  x  =
54       lazy(lazy(...(lazy x))) are accepted by the type-checker and lead, when
55       forced, to ill-formed values that trigger infinite loops in the garbage
56       collector  and  other  parts of the run-time system.  Without the -rec‐
57       types option, such ill-founded recursive definitions  are  rejected  by
58       the type-checker.
59
60
61
62       exception Undefined
63
64
65
66
67
68       val force : 'a t -> 'a
69
70
71       force  x  forces  the  suspension  x  and returns its result.  If x has
72       already been forced, Lazy.force x returns the same value again  without
73       recomputing  it.   If  it  raised  an  exception, the same exception is
74       raised again.  Raise Lazy.Undefined if the forcing of x tries to  force
75       x itself recursively.
76
77
78
79       val force_val : 'a t -> 'a
80
81
82       force_val  x  forces the suspension x and returns its result.  If x has
83       already been forced, force_val x returns the same value  again  without
84       recomputing  it.   Raise  Lazy.Undefined  if  the forcing of x tries to
85       force x itself recursively.  If the computation of x raises  an  excep‐
86       tion,  it  is unspecified whether force_val x raises the same exception
87       or Lazy.Undefined .
88
89
90
91       val from_fun : (unit -> 'a) -> 'a t
92
93
94       from_fun f is the same as lazy (f ()) but slightly more efficient.
95
96
97       from_fun should only be used if the function f is already defined.   In
98       particular  it  is  always  less efficient to write from_fun (fun () ->
99       expr) than lazy expr .
100
101
102       Since 4.00.0
103
104
105
106       val from_val : 'a -> 'a t
107
108
109       from_val v returns an already-forced suspension of v  .   This  is  for
110       special purposes only and should not be confused with lazy (v) .
111
112
113       Since 4.00.0
114
115
116
117       val is_val : 'a t -> bool
118
119
120       is_val x returns true if x has already been forced and did not raise an
121       exception.
122
123
124       Since 4.00.0
125
126
127
128       val lazy_from_fun : (unit -> 'a) -> 'a t
129
130       Deprecated.  synonym for from_fun .
131
132
133
134       val lazy_from_val : 'a -> 'a t
135
136       Deprecated.  synonym for from_val .
137
138
139
140       val lazy_is_val : 'a t -> bool
141
142       Deprecated.  synonym for is_val .
143
144
145
146
147
148OCamldoc                          2020-02-27                           Lazy(3)