568fc812dc66802eb89122197277c6f1a16e2995
[lambda.git] / week9.mdwn
1 [[!toc]]
2
3 The seminar is now going to begin talking about more **imperatival** or **effect**-like elements in programming languages. The only effect-like element we've encountered so far is the possibility of divergence, in languages that permit fixed point combinators and so have the full power of recursion. What it means for something to be effect-like, and why this counts as an example of such, will emerge.
4
5 Other effect-like elements in a language include: printing (recall the [[damn]] example at the start of term); continuations (also foreshadowed in the [[damn]] example) and exceptions (foreshadowed in our discussion of abortable list traversals in [[week4]]); and **mutation**. This last notion is our topic this week.
6
7
8 ## Mutation##
9
10 What is mutation? It's helpful to build up to this in a series of fragments. For pedagogical purposes, we'll be using a made-up language that's syntactically similar to, but not quite the same as, OCaml.
11
12 Recall from earlier discussions that the following two forms are equivalent:
13
14         [A] let x be EXPRESSION in
15                   BODY
16
17                 (lambda (x) -> BODY) (EXPRESSION)
18
19 This should seem entirely familiar:
20
21         [B] let x be 1 + 2 in
22                   let y be 10 in
23                         (x + y, x + 20)
24                                                                 ; evaluates to (13, 23)
25
26 In fragment [B], we bound the variables `x` and `y` to `int`s. We can also bind variables to function values, as here:
27
28         [C] let f be (lambda (x, y) -> x + y + 1) in
29                   (f (10, 2), f (20, 2))
30                                                                 ; evaluates to (13, 23)
31
32 If the expression that evaluates to a function value has a free variable in it, like `y` in the next fragment, it's interpreted as bound to whatever value `y` has in the surrounding lexical context:
33
34         [D] let y be 3 in
35                   let f be (lambda (x) -> x + y) in
36                         (f (10), f (20))
37                                                                 ; evaluates to (13, 23)
38
39 Other choices about how to interpret free variables are also possible (you can read about "lexical scope" versus "dynamic scope"), but what we do here is the norm in functional programming languages, and seems to be easiest for programmers to reason about.
40
41 In our next fragment, we re-use a variable that had been bound to another value in a wider context:
42
43         [E] let y be 2 in
44                   let y be 3 in
45                         (y + 10, y + 20)
46                                                                 ; evaluates to (13, 23)
47
48 As you can see, the narrowest assignment is what's effective. This is just like in predicate logic: consider <code>&exist;y (Fy and &exist;y ~Fy)</code>. The computer-science terminology to describe this is that the narrower assignment of `y` to the value 3 **shadows** the wider assignment to 2.
49
50 I call attention to this because you might casually describe it as "changing the value that y is assigned to." What we'll go on to see is a more exotic phenomenon that merits that description better.
51
52 Sometimes the shadowing is merely temporary, as here:
53
54         [F] let y be 2 in
55                   let f be (lambda (x) ->
56                         let y be 3 in
57                           ; here the most local assignment to y applies
58                           x + y
59                   ) in
60                         ; here the assignment of 3 to y has expired
61                         (f (10), y, f (20))
62                                                                 ; evaluates to (13, 2, 23)
63
64 OK, now we're ready for our main event, **mutable variables.** We'll introduce new syntax to express an operation where we're not shadowing a wider assignment, but *changing* the original assignment:
65
66         [G] let y be 2 in
67                   let f be (lambda (x) ->
68                         change y to 3 then
69                           x + y
70                   ) in
71                         ; here the change in what value y was assigned *sticks*
72                         ; because we *updated* the value of the original variable y
73                         ; instead of introducing a new y with a narrower scope
74                         (f (10), y, f (19))
75                                                                 ; evaluates to (13, 3, 23)
76
77 In languages that have native syntax for this, there are two styles in which it can be expressed. The *implicit style* is exemplified in fragment [G] above, and also in languages like C:
78
79         {
80                 int y = 2;    // this is like "let y be 2 in ..."
81                 ...
82                 y = 3;        // this is like "change y to 3 then ..."
83                 return x + y; // this is like "x + y"
84         }
85
86 A different possibility is the *explicit style* for handling mutation. Here we explicitly create and refer to new "reference cells" to hold our values. When we change a variable's value, the variable stays associated with the same reference cell, but that reference cell's contents get modified. The same thing happens in the semantic machinery underlying implicit-style mutable variables, but there it's implicit---the reference cells aren't themselves expressed by any term in the object language. In explicit-style mutation, they are. OCaml has explicit-style mutation. It looks like this:
87
88         let ycell = ref 2       (* this creates a new reference cell *)
89         ...
90         in let () = ycell := 3  (* this changes the contents of that cell to 3 *)
91                                                         (* the return value of doing so is () *)
92                                                         (* other return values could also be reasonable: *)
93                                                         (* such as the old value of ycell, the new value, an arbitrary int, and so on *)
94         in x + !ycell;;                 (* the !ycell operation "dereferences" the cell---it retrieves the value it contains *)
95
96 Scheme is similar. There are various sorts of reference cells available in Scheme. The one most like OCaml's `ref` is a `box`. Here's how we'd write the same fragment in Scheme:
97
98         (let ([ycell (box 2)])
99                 ...
100                 (set-box! ycell 3)
101                 (+ x (unbox ycell)))
102
103 (C has explicit-style mutable variables, too, which it calls *pointers*. But simple variables in C are already mutable, in the implicit style.)
104
105 When dealing with explicit-style mutation, there's a difference between the types and values of `ycell` and `!ycell` (or in Scheme, `(unbox ycell)`). The former has the type `int ref`: the variable `ycell` is assigned a reference cell that contains an `int`. The latter has the type `int`, and has whatever value is now stored in the relevant reference cell. In an implicit-style framework though, we only have the resources to refer to the contents of the relevant reference cell. `y` in fragment [G] or the C snippet above has the type `int`, and only ever evaluates to `int` values.
106
107
108 ##Controlling order##
109
110 When we're dealing with mutable variables (or any other kind of effect), order matters. For example, it would make a big difference whether I evaluated `let z = !ycell` before or after evaluating `ycell := !ycell + 1`. Before this point, order never mattered except sometimes it played a role in avoiding divergence.
111
112 OCaml does *not* guarantee what order expressions will be evaluated in arbitrary contexts. For example, in the following fragment, you cannot rely on `expression_a` being evaluated before `expression_b` before `expression_c`:
113
114         let triple = (expression_a, expression_b, expression_c)
115
116 OCaml does however guarantee that different let-expressions are evaluated in the order they lexically appear. So in the following fragment, `expression_a` *will* be evaluated before `expression_b` and that before `expression_c`:
117
118         let a = expression_a
119                 in let b = expression_b
120                         in expression_c
121
122 Scheme does the same. (*If* you use Scheme's `let*`, but not if you use its `let`. I agree this is annoying.)
123
124 If `expression_a` and `expression_b` evaluate to (), for instance if they're something like `ycell := !ycell + 1`, that can also be expressed in OCaml as:
125
126         let () = expression_a
127                 in let () = expression_b
128                         in expression_c
129
130 And OCaml has a syntactic shorthand for this form, namely to use semi-colons:
131
132         expression_a; expression_b; expression_c
133
134 This is not the same role that semi-colons play in list expressions, like `[1; 2; 3]`. To be parsed correctly, these semi-colon'ed complexes sometimes need to be enclosed in parentheses or a `begin ... end` construction:
135
136         (expression_a; expression_b; expression_c)
137
138         begin expression_a; expression_b; expression_c end
139
140 Scheme has a construction similar to the latter:
141
142         (begin (expression_a) (expression_b) (expression_c))
143
144 Though often in Scheme, the `(begin ...)` is implicit and doesn't need to be explicitly inserted, as here:
145
146         (lambda (x) (expression_a) (expression_b) (expression_c))
147
148 Another way to control evaluation order, you'll recall from [[week6]], is to use **thunks**. These are functions that only take the uninformative `()` as an argument, such as this:
149
150         let f () = ...
151
152 or this:
153
154         let f = fun () -> ...
155
156 In Scheme these are written as functions that take 0 arguments:
157
158         (lambda () ...)
159
160 or:
161
162         (define (f) ...)
163
164 How could such functions be useful? Well, as always, the context in which you build a function need not be the same as the one in which you apply it to some arguments. So for example:
165
166         let ycell = ref 1
167         in let f () = ycell := !ycell + 1
168         in let z = !ycell
169         in f ()
170         in z;;
171
172 We don't apply (or call or execute or however you want to say it) the function `f` until after we've extracted `ycell`'s value and assigned it to `z`. So `z` will get assigned 1. If on the other hand we called `f ()` before evaluating `let z = !ycell`, then `z` would have gotten assigned a different value.
173
174 In languages with mutable variables, the free variables in a function definition are usually taken to refer back to the same *reference cells* they had in their lexical contexts, and not just their original value. So if we do this for instance:
175
176         let factory (starting_value : int) =
177                 let free_var = ref starting_value
178                 in let getter () =
179                         !free_var
180                 in let setter (new_value : int) =
181                         free_var := new_value
182                 in (getter, setter)
183         in let (getter, setter) = factory 1
184         in let first = getter ()
185         in let () = setter 2
186         in let second = getter ()
187         in let () = setter 3
188         in let third = getter ()
189         in (first, second, third)
190         
191 At the end, we'll get `(1, 2, 3)`. The reference cell that gets updated when we call `setter` is the same one that gets fetched from when we call `getter`. This should seem very intuitive here, since we're working with explicit-style mutation. When working with a language with implicit-style mutation, it can be more surprising. For instance, here's the same fragment in Python, which has implicit-style mutation:
192
193         def factory (starting_value):
194                 free_var = starting_value
195                 def getter ():
196                         return free_var
197                 def setter (new_value):
198                         # the next line indicates that we're using the
199                         # free_var from the surrounding function, not
200                         # introducing a new local variable with the same name
201                         nonlocal free_var
202                         free_var = new_value
203                 return getter, setter
204         getter, setter = factory (1)
205         first = getter ()
206         setter (2)
207         second = getter ()
208         setter (3)
209         third = getter ()
210         (first, second, third)
211
212 Here, too, just as in the OCaml fragment, all the calls to getter and setter are working with a single mutable variable `free_var`.
213
214 If however you called `factory` twice, you'd have different `getter`/`setter` pairs, each of which had their own, independent `free_var`. In OCaml:
215
216         let factory (starting_val : int) =
217         ... (* as above *)
218         in let (getter, setter) = factory 1
219         in let (getter', setter') = factory 1
220         in let () = setter 2
221         in getter' ()
222
223 Here, the call to `setter` only mutated the reference cell associated with the `getter`/`setter` pair. The reference cell associated with `getter'` hasn't changed, and so `getter' ()` will still evaluate to 1.
224
225 Notice in these fragments that once we return from inside the call to `factory`, the `free_var` mutable variable is no longer accessible, except through the helper functions `getter` and `setter` that we've provided. This is another way in which a thunk like `getter` can be useful: it still has access to the `free_var` reference cell that was created when it was, because its free variables are interpreted relative to the context in which `getter` was built, even if that context is otherwise no longer accessible. What `getter ()` evaluates to, however, will very much depend on *when* we evaluate it---in particular, it will depend on which calls to the corresponding `setter` were evaluated first.
226
227 ##Referential opacity##
228
229 In addition to order-sensitivity, when you're dealing with mutable variables you also give up a property that computer scientists call "referential transparency." It's not obvious whether they mean exactly the same by that as philosophers and linguists do, or only something approximately the same.
230
231 The core idea to referential transparency is that when the same value is supplied to a context, the whole should always evaluate the same way. Mutation makes it possible to violate this. Consider:
232
233         let ycell = ref 1
234                 in let f x = x + !ycell
235                         in let first = f 1      (* first is assigned the value 2 *)
236                                 in ycell := 2; let second = f 1 (* second is assigned the value 3 *)
237                                         in first = second;; (* not true! *)
238
239 Notice that the two invocations of `f 1` yield different results, even though the same value is being supplied as an argument to the same function.
240
241 Similarly, functions like these:
242
243         let f cell = !cell;;
244
245         let g cell = cell := !cell + 1; !cell;;
246
247 may return different results each time they're invoked, even if they're always supplied one and the same reference cell as argument.
248
249 Computer scientists also associate referential transparency with a kind of substitution principle, illustrated here:
250
251         let x = 1
252                 in (x, x)
253
254 should evaluate the same as:
255
256         let x = 1
257                 in (x, 1)
258
259 or:
260
261         (1, 1)
262
263 Notice, however, that when mutable variables are present, the same substitution patterns can't always be relied on:
264
265         let ycell = ref 1
266                 in ycell := 2; !ycell
267         (* evaluates to 2 *)
268
269         (ref 1) := 2; !(ref 1)
270         (* creates a ref 1 cell and changes its contents *)
271         (* then creates a *new* ref 1 cell and returns *its* contents *)
272
273
274
275
276 ##How to implement explicit-style mutable variables##
277
278 We'll think about how to implement explicit-style mutation first. We suppose that we add some new syntactic forms to a language, let's call them `newref`, `deref`, and `setref`. And now we want to expand the semantics for the language so as to interpret these new forms.
279
280 Well, part of our semantic machinery will be an assignment function, call it `g`. Somehow we should keep track of the types of the variables and values we're working with, but we won't pay much attention to that now. In fact, we won't even bother much at this point with the assignment function. Below we'll pay more attention to it.
281
282 In addition to the assignment function, we'll also need a way to keep track of how many reference cells have been "allocated" (using `newref`), and what their current values are. We'll suppose all the reference cells are organized in a single data structure we'll call a **store**. This might be a big heap of memory. For our purposes, we'll suppose that reference cells only ever contain `int`s, and we'll let the store be a list of `int`s.
283
284 In many languages, including OCaml, the first position in a list is indexed `0`, the second is indexed `1` and so on. If a list has length 2, then there won't be any value at index `2`; that will be the "next free location" in the list.
285
286 Before we brought mutation on the scene, our language's semantics will have looked something like this:
287
288 >       \[[expression]]<sub>g</sub> = value
289
290 Now we're going to relativize our interpretations not only to the assignment function `g`, but also to the current store, which I'll label `s`. Additionally, we're going to want to allow that evaluating some functions might *change* the store, perhaps by allocating new reference cells or perhaps by updating the contents of some existing cells. So the interpretation of an expression won't just return a value; it will also return a possibly updated store. We'll suppose that our interpretation function does this quite generally, even though for many expressions in the language, the store that's returned will be the same one that the interpretation function started with:
291
292 >       \[[expression]]<sub>g s</sub> = (value, s')
293
294 For expressions we already know how to interpret, `s'` will usually just be `s`. One exception is complex expressions like `let var = expr1 in expr2`. Part of interpreting this will be to interpret the sub-expression `expr1`, and we have to allow that in doing that, the store may have already been updated. We want to use that possibly updated store when interpreting `expr2`. Like this:
295
296         let rec eval expression g s =
297                 match expression with
298                 ...
299                 | Let (c, expr1, expr2) ->
300                         let (value, s') = eval expr1 g s
301                         (* s' may be different from s *)
302                         (* now we evaluate expr2 in a new environment where c has been associated
303                            with the result of evaluating expr1 in the current environment *)
304                         eval expr2 ((c, value) :: g) s'
305                 ...
306
307 Similarly:
308
309                 ...
310                 | Addition (expr1, expr2) ->
311                         let (value1, s') = eval expr1 g s
312                         in let (value2, s'') = eval expr2 g s'
313                         in (value1 + value2, s'')
314                 ...
315
316 Let's consider how to interpet our new syntactic forms `newref`, `deref`, and `setref`:
317
318
319 1.      \[[newref starting_val]] should allocate a new reference cell in the store and insert `starting_val` into that cell. It should return some "key" or "index" or "pointer" to the newly created reference cell, so that we can do things like:
320
321                 let ycell = newref 1
322                 in ...
323
324         and be able to refer back to that cell later by using the value that we assigned to the variable `ycell`. In our simple implementation, we're letting the store just be an `int list`, and we can let the "keys" be indexes in that list, which are (also) just `int`s. Somehow we should keep track of which variables are assigned `int`s as `int`s and which are assigned `int`s as indexes into the store. So we'll create a special type to wrap the latter:
325
326                 type store_index = Index of int;;
327
328         Our interpretation function will look something like this:
329                 
330                 let rec eval expression g s =
331                         match expression with
332                         ...
333                         | Newref (expr) ->
334                                 let (starting_val, s') = eval expr g s
335                                 (* note that s' may be different from s, if expr itself contained any mutation operations *)
336                                 (* now we want to retrieve the next free index in s' *)
337                                 in let new_index = List.length s'
338                                 (* now we want to insert starting_val there; the following is an easy but inefficient way to do it *)
339                                 in let s'' = List.append s' [starting_val]
340                                 (* now we return a pair of a wrapped new_index, and the new store *)
341                                 in (Index new_index, s'')
342                         ... 
343
344 2.      When `expr` evaluates to a `store_index`, then `deref expr` should evaluate to whatever value is at that index in the current store. (If `expr` evaluates to a value of another type, `deref expr` is undefined.) In this operation, we don't change the store at all; we're just reading from it. So we'll return the same store back unchanged (assuming it wasn't changed during the evaluation of `expr`).
345
346                 let rec eval expression g s =
347                         match expression with
348                         ...
349                         | Deref (expr) ->
350                                 let (Index n, s') = eval expr g s
351                                 (* note that s' may be different from s, if expr itself contained any mutation operations *)
352                                 in (List.nth s' n, s')
353                         ...
354
355 3.      When `expr1` evaluates to a `store_index` and `expr2` evaluates to an `int`, then `setref expr1 expr2` should have the effect of changing the store so that the reference cell at that index now contains that `int`. We have to make a decision about what value the `setref ...` call should itself evaluate to; OCaml makes this `()` but other choices are also possible. Here I'll just suppose we've got some appropriate value in the variable `dummy`.
356
357                 let rec eval expression g s =
358                         match expression with
359                         ...
360                         | Setref (expr1, expr2) ->
361                                 let (Index n, s') = eval expr1 g s
362                                 (* note that s' may be different from s, if expr1 itself contained any mutation operations *)
363                                 in let (new_value, s'') = eval expr2 g s'
364                                 (* now we create a list which is just like s'' except it has new_value in index n *)
365                                 in let rec replace_nth lst m =
366                                         match lst with
367                                         | [] -> failwith "list too short"
368                                         | x::xs when m = 0 -> new_value :: xs
369                                         | x::xs -> x :: replace_nth xs (m - 1)
370                                 in let s''' = replace_nth s'' n
371                                 in (dummy, s''')
372                         ...
373
374
375
376
377
378 ##How to implement implicit-style mutable variables##
379
380 With implicit-style mutation, we don't have new syntactic forms like `newref` and `deref`. Instead, we just treat ordinary variables as being mutable. You could if you wanted to have some variables be mutable and others not; perhaps the first sort are written in Greek and the second in Latin. But we will suppose all variables in our language are mutable.
381
382 We will still need a store to keep track of reference cells and their current values, just as in the explicit-style implementation. This time, every variable will be associated with an index into the store. So this is what we'll have our assignment function keep track of. The assignment function will bind variables to indexes into the store, rather than to the variables' current values. The variables will only indirectly be associated with "their values" by virtue of the joint work of the assignment function and the store.
383
384 This brings up an interesting conceptual distinction. Formerly, we'd naturally think that a variable `x` is associated with only one type, and that that's the type that the expression `x` would *evaluate to*, and also the type of value that the assignment function *bound* `x` to. However, in the current framework these two types come apart. The assignment function binds `x` to an index into the store, and what the expression `x` evaluates to will be the value at that location in the store, which will usually be some type other than an index into a store, such as a `bool` or a `string`.
385
386 To handle implicit-style mutation, we'll need to re-implement the way we interpret expressions like `x` and `let x = expr1 in expr2`. We will also have just one new syntactic form, `change x to expr1 then expr2`.
387
388 Here's how to implement these. We'll suppose that our assignment function is list of pairs, as in [week7](/reader_monad_for_variable_binding).
389
390         let rec eval expression g s =
391                 match expression with
392                 ...
393                 | Var (c : char) ->
394                         let index = List.assoc c g
395                         (* retrieve the value at that index in the current store *)
396                         in let value = List.nth s index
397                         in (value, s)
398
399                 | Let ((c : char), expr1, expr2) ->
400                         let (starting_val, s') = eval expr1 g s
401                         (* get next free index in s' *)
402                         in let new_index = List.length s'
403                         (* insert starting_val there *)
404                         in let s'' = List.append s' [starting_val]
405                         (* evaluate expr2 using a new assignment function and store *)
406                         in eval expr2 ((c, new_index) :: g) s''
407
408                 | Change ((c : char), expr1, expr2) ->
409                         let (new_value, s') = eval expr1 g s
410                         (* lookup which index is associated with Var c *)
411                         in let index = List.assoc c g
412                         (* now we create a list which is just like s' except it has new_value at index *)
413                         in let rec replace_nth lst m =
414                                 match lst with
415                                 | [] -> failwith "list too short"
416                                 | x::xs when m = 0 -> new_value :: xs
417                                 | x::xs -> x :: replace_nth xs (m - 1)
418                         in let s'' = replace_nth s' index
419                         (* evaluate expr2 using original assignment function and new store *)
420                         in eval expr2 g s''
421
422
423 ##How to implement mutation with a State monad##
424
425 It's possible to do all of this monadically, and so using a language's existing resources, instead of adding new syntactic forms and new interpretation rules to the semantics. The patterns we use to do this in fact closely mirror the machinery described above.
426
427 We call this a State monad. It's a lot like the Reader monad, except that with the Reader monad, we could only read from the environment. We did have the possibility of interpreting sub-expressions inside a "shifted" environment, but as you'll see, that corresponds to the "shadowing" behavior described before, not to the mutation behavior that we're trying to implement now.
428
429 With a State monad, we call our book-keeping apparatus a "state" or "store" instead of an environment, and this time we are able to both read from it and write to it. To keep things simple, we'll work here with the simplest possible kind of store, which only holds a single value. One could also have stores that were composed of a list of values, of a length that could expand or shrink, or even more complex structures.
430
431 Here's the implementation of the State monad, together with an implementation of the Reader monad for comparison:
432
433         type env = (char * int) list;;
434         (* alternatively, an env could be implemented as type char -> int *)
435
436         type 'a reader = env -> 'a;;
437         let unit_reader (value : 'a) : 'a reader =
438                 fun e -> value;;
439         let bind_reader (u : 'a reader) (f : 'a -> 'b reader) : 'b reader =
440                 fun e -> let a = u e
441                                  in let u' = f a
442                                  in u' e;;
443
444         type store = int;;
445         (* very simple store, holds only a single int *)
446         (* this corresponds to having only a single mutable variable *)
447
448         type 'a state = store -> ('a, store);;
449         let unit_state (value : 'a) : 'a state =
450                 fun s -> (value, s);;
451         let bind_state (u : 'a state) (f : 'a -> 'b state) : 'b state =
452                 fun s -> let (a, s') = u s
453                                  in let u' = f a
454                                  in u' s';;
455
456 Notice the similarities (and differences) between the implementation of these two monads.
457
458 With the Reader monad, we also had some special-purpose operations, beyond its general monadic operations. These were `lookup` and `shift`. With the State monad, we'll also have some special-purpose operations. We'll consider two basic ones here. One will be to retrieve what is the current store. This is like the Reader monad's `lookup`, except in this simple implementation there's only a single location for a value to be looked up from. Here's how we'll do it:
459
460         let get_state : store state =
461                         fun s -> (s, s);;
462
463 This passes through the current store unaltered, and also returns a copy of the store as its value. We can use this operation like this:
464
465         some_existing_state_monad_box >>= fun _ -> get_state >>= (fun cur_store -> ...)
466
467 The `fun _ ->` part here discards the value wrapped by `some_existing_state_monad_box`. We're only going to pass through, unaltered, whatever *store* is generated by that monadic box. We also wrap that store as *our own value*, which can be retrieved by further operations in the `... >>= ...` chain, such as `(fun cur_store -> ...)`.
468
469 The other operation for the State monad will be to update the existing store to a new one. This operation looks like this:
470
471         let set_state (new_store : int) : dummy state =
472                 fun s -> (dummy, new_store);;
473
474 If we want to stick this in a `... >>= ...` chain, we'll need to prefix it with `fun _ ->` too, like this:
475
476         some_existing_state_monad_box >>= fun _ -> set_state 100 >>= ...
477
478 In this usage, we don't care what value is wrapped by `some_existing_state_monad_box`. We don't even care what store it generates, since we're going to replace that store with our own new store. A more complex kind of `set_state` operation might insert not just some constant value as the new store, but rather the result of applying some function to the existing store. For example, we might want to increment the current store. Here's how we could do that:
479
480         some_existing_state_monad_box >>= fun _ -> get_state >>= (fun cur_store -> set_state (cur_store + 1) >>= ...
481
482 We can of course define more complex functions that perform the `get_state >>= (fun cur_store -> set_state (cur_store + 1)` as a single operation.
483
484 In general, a State monadic **box** (type `'a state`, what appears at the start of a `... >>= ... >>= ...` chain) is an operation that accepts some starting store as input---where the store might be simple as it is here, or much more complex---and returns a value plus a possibly modified store. This can be thought of as a static encoding of some computation on a store, which encoding is used as a box wrapped around a value of type `'a`. (And also it's a burrito.)
485
486 State monadic **operations** (type `'a -> 'b state`, what appears anywhere in the middle or end of a `... >>= ... >>= ...` chain) are operations that generate new State monad boxes, based on what value was wrapped by the preceding elements in the `... >>= ... >>= ...` chain. The computations on a store that these encode (which their values may or may not be sensitive to) will be chained in the order given by their position in the `... >>= ... >>= ...` chain. That is, the computation encoded by the first element in the chain will accept a starting store s0 as input, and will return (a value and) a new store s1 as output, the next computation will get s1 as input and will return s2 as output, the next computation will get s2 as input, ... and so on.
487
488 To get the whole process started, the complex computation so defined will need to be given a starting store. So we'd need to do something like this:
489
490         let computation = some_state_monadic_box >>= operation >>= operation
491         in computation initial_store;;
492
493
494
495 ##Aliasing or Passing by reference##
496
497 -- FIXME --
498
499     [H] ; *** aliasing ***
500         let y be 2 in
501           let x be y in
502             let w alias y in
503               (y, x, w)           ==> (2, 2, 2)
504
505     [I] ; mutation plus aliasing
506         let y be 2 in
507           let x be y in
508             let w alias y in
509               change y to 3 then
510                 (y, x, w)         ==> (3, 2, 3)
511
512     [J] let f be (lambda (y) -> BODY) in  ; a
513           ... f (EXPRESSION) ...
514
515         (lambda (y) -> BODY) EXPRESSION
516
517         let y be EXPRESSION in            ; b
518           ... BODY ...
519
520     [K] ; *** passing "by reference" ***
521         let f be (lambda (alias w) ->     ; ?
522           BODY
523         ) in
524           ... f (y) ...
525
526         let w alias y in                  ; d
527           ... BODY ...
528
529     [L] let f be (lambda (alias w) ->
530           change w to 2 then
531             w + 2
532         ) in
533           let y be 1 in
534             let z be f (y) in
535               ; y is now 2, not 1
536               (z, y)              ==> (4, 2)
537
538     [M] ; hyper-evaluativity
539         let h be 1 in
540           let p be 1 in
541             let f be (lambda (alias x, alias y) ->
542               ; contrast here: "let z be x + y + 1"
543               change y to y + 1 then
544                 let z be x + y in
545                   change y to y - 1 then
546                     z
547             ) in
548               (f (h, p), f (h, h))
549                                   ==> (3, 4)
550
551     Notice: h, p have same value (1), but f (h, p) and f (h, h) differ
552
553
554 Fine and Pryor on "coordinated contents" (see, e.g., [Hyper-Evaluativity](http://www.jimpryor.net/research/papers/Hyper-Evaluativity.txt))
555
556
557 ##Five grades of mutation involvement##
558
559 -- FIXME --
560
561     0. Purely functional languages
562     1. Passing by reference
563        need primitive hyper-evaluative predicates for it to make a difference
564     2. mutable variables
565     3. mutable values
566         - numerically distinct but indiscernible values
567         - two equality predicates
568         - examples: closures with currently-indiscernible but numerically distinct
569           environments, mutable lists
570     4. "references" as first-class values
571         - x not the same as !x, explicit deref operation
572         - can not only be assigned and passed as arguments, also returned (and manipulated?)
573         - can be compared for qualitative equality
574     5. structured references
575         (a) if `a` and `b` are mutable variables that uncoordinatedly refer to numerically the same value
576             then mutating `b` won't affect `a` or its value
577         (b) if however their value has a mutable field `f`, then mutating `b.f` does
578             affect their shared value; will see a difference in what `a.f` now evaluates to
579
580
581 ##Miscellany##
582
583 *       When using mutable variables, programmers will sometimes write using *loops* that repeatedly mutate a variable, rather than the recursive techniques we've been using so far. For example, we'd define the factorial function like this:
584
585                 let rec factorial n =
586                         if n = 0 then 1 else n * factorial (n - 1)
587
588         or like this:
589
590                 let factorial n =
591                         let rec helper n sofar =
592                                 if n = 0 then sofar else helper (n - 1) (n * sofar)
593                         in helper n 1
594
595         (The second version is more efficient than the first; so you may sometimes see this programming style. But for our purposes, these can be regarded as equivalent.)
596
597         When using mutable variables, on the other hand, this may be written as:
598
599                 let factorial n =
600                         let current = ref n
601                         in let total = ref 1
602                         in while !current > 0 do
603                                 total := !total * !current; current := !current - 1
604                         done; !total
605
606
607 *       Mutable variables also give us a way to achieve recursion, in a language that doesn't already have it. For example:
608
609                 let fact_cell = ref None
610                 in let factorial n =
611                         if n = 0 then 1 else match !fact_cell with
612                                 | Some fact -> n * fact (n - 1)
613                                 | None -> failwith "can't happen"
614                 in let () = fact_cell := Some factorial
615                 in ...
616
617         We use the `None`/`Some factorial` option type here just as a way to ensure that the contents of `fact_cell` are of the same type both at the start and the end of the block.
618
619
620 ##Offsite Reading##
621
622 *       [[!wikipedia Declarative programming]]
623 *       [[!wikipedia Functional programming]]
624 *       [[!wikipedia Purely functional]]
625 *       [[!wikipedia Side effect (computer science) desc="Side effects"]]
626 *       [[!wikipedia Referential transparency (computer science)]]
627 *       [[!wikipedia Imperative programming]]
628 *       [[!wikipedia Reference (computer science) desc="References"]]
629 *       [[!wikipedia Pointer (computing) desc="Pointers"]]
630 *       [Pointers in OCaml](http://caml.inria.fr/resources/doc/guides/pointers.html)
631
632 <!--
633 # General issues about variables and scope in programming languages #
634
635 *       [[!wikipedia Variable (programming) desc="Variables"]]
636 *       [[!wikipedia Free variables and bound variables]]
637 *       [[!wikipedia Variable shadowing]]
638 *       [[!wikipedia Name binding]]
639 *       [[!wikipedia Name resolution]]
640 *       [[!wikipedia Parameter (computer science) desc="Function parameters"]]
641 *       [[!wikipedia Scope (programming) desc="Variable scope"]]
642 *       [[!wikipedia Closure (computer science) desc="Closures"]]
643
644 -->
645