tweak calc improvements
[lambda.git] / advanced_topics / calculator_improvements.mdwn
index f50a4be..d3beef1 100644 (file)
@@ -18,11 +18,12 @@ Then the interpreter (or "evaluator") would convert that AST into an "expressed
 
 The language we had in week 7 looked like this:
 
-       type term = Constant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
+       type term =
+         Constant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
        ;;
 
 and the evaluation function looked like this:
@@ -60,25 +61,27 @@ We'd then want to add the ability to construct pairs, and extract their componen
 
 We won't try here to catch any type errors, such as attempts to add a `bool` to an `int`, or attempts to check whether a `bool` iszero. Neither will we try here to monadize anything: these will be implementations of a calculator with all the plumbing exposed. What we will do is add more and more features to the calculator.
 
-We'll switch over to using variable `g` for assignment functions, which is a convention many of you seem familiar with. As we mentioned a few times in week 9, for some purposes it's easier to implement environment or assignment functions as functions from `char`s to `int`s (or whatever variables are bound to), rather than as lists of pairs. However, we'll stick with this implementation for now. We will however abstract out the type that the variables are bound to. For now, we'll suppose that they're bound to the same types that terms can express.
+We'll switch over to using variable `g` for assignment functions, which is a convention many of you seem familiar with. As we mentioned a few times in [[week9]], for some purposes it's easier to implement environment or assignment functions as functions from `char`s to `int`s (or whatever variables are bound to), rather than as lists of pairs. However, we'll stick with this implementation for now. We will however abstract out the type that the variables are bound to. For now, we'll suppose that they're bound to the same types that terms can express.
 
        type bound_value = expressed_value;;
        type assignment = (char * bound_value) list;;
 
-Here's where we should be now. We expand some of the clauses in the `eval` function for clarity, and we rename a few variables:
+Here's where we should be now. We'll work with the language:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
        ;;
 
+Here is our evaluation function. We expand some of the clauses and rename a few variables for clarity. Our implementation should make it clear how to add additional constants or native predicates, such as a `Second` predicate for extracting the second element of a pair.
+
        let rec eval (t : term) (g : assignment) = match t with
          Intconstant x -> Int x
        | Multiplication (t1, t2) ->
@@ -133,17 +136,17 @@ What changes do we need to handle this?
 We can begin with our language:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
        ;;
 
 Next, we need to expand our stock of `expressed_value`s to include function values as well. How should we think of these? We've several times mentioned the issue of how to handle free variables in a function's body, like the `x` in `lambda y -> y + x`. We'll follow the usual functional programming standard for these (known as "lexical scoping"), which keeps track of what value `x` has in the function declaration's lexical environment. That shouldn't get shadowed by any different value `x` may have when the function value is later applied. So:
@@ -202,18 +205,18 @@ where the AST would be:
 Here is the expanded definition for our language type:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
-               | Letrec of (char * term * term)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
+       | Letrec of (char * term * term)
        ;;
 
 Now consider what we'll need to do when evaluating a term like `Letrec ('f', Lambda (...), t2)`. The subterm `Lambda (...)` will evaluate to something of the form `Closure ('y', body, savedg)`, where `Variable 'f'` may occur free in `body`. What we'll want to do is to ensure that when `body` is applied, it's applied using not the assignment `savedg` but a modified assignment `savedg'` which binds `'f'` to this very function value. That is, we want to bind `'f'` not to:
@@ -333,21 +336,21 @@ Next, we'll add mutable cells (explicit-style mutation) to our calculator, as we
 We'll add a few more syntactic forms to the language:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
-               | Letrec of (char * term * term)
-               | Newref of term
-               | Deref of term
-               | Setref of (term * term)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
+       | Letrec of (char * term * term)
+       | Newref of term
+       | Deref of term
+       | Setref of (term * term)
        ;;
 
 And we now have to allow for `Mutcell`s as an additional kind of `expressed_value`. These are implemented as wrappers around an index into a `store`:
@@ -366,7 +369,7 @@ Our evaluation function will now expect a `store` argument as well as an `assign
        let rec eval (t : term) (g : assignment) (s : store) = match t with
          Intconstant x -> (Int x, s)
          ...
-       | Variable (var) -> (
+       | Variable (var) -> ((
                (* we don't handle cases where g doesn't bind var to any value *)
                match List.assoc var g with
           | Nonrecursive value -> value
@@ -374,7 +377,7 @@ Our evaluation function will now expect a `store` argument as well as an `assign
                          (* we update savedg to bind self_var to rec_closure here *)
               let savedg' = (self_var, rec_closure) :: savedg
               in Closure (arg_var, body, savedg')
-        ), s
+        ), s)
          ...
        | Lambda (arg_var, t2) -> (Closure (arg_var, t2, g), s)
          ...
@@ -445,12 +448,12 @@ Now we need to formulate the clauses for evaluating the new forms `Newref (...)`
 
        ...
        | Newref (t1) ->
-               let (starting_val, s') = eval t1 g s
+               let (value1, s') = eval t1 g s
                (* note that s' may be different from s, if t1 itself contained any mutation operations *)
                (* now we want to retrieve the next free index in s' *)
                in let new_index = List.length s'
-               (* now we want to insert starting_val there; the following is an easy but inefficient way to do it *)
-               in let s'' = List.append s' [starting_val]
+               (* now we want to insert value1 there; the following is an easy but inefficient way to do it *)
+               in let s'' = List.append s' [value1]
                (* now we return a pair of a wrapped new_index, and the new store *)
                in (Mutcell new_index, s'')
        | Deref (t1) ->
@@ -462,12 +465,12 @@ Now we need to formulate the clauses for evaluating the new forms `Newref (...)`
                (* we don't handle cases where t1 doesn't evaluate to a Mutcell *)
                let (Mutcell index1, s') = eval t1 g s
                (* note that s' may be different from s, if t1 itself contained any mutation operations *)
-               in let (new_value, s'') = eval t2 g s'
-               (* now we create a list which is just like s'' except it has new_value in index1 *)
+               in let (value2, s'') = eval t2 g s'
+               (* now we create a list which is just like s'' except it has value2 in index1 *)
                in let rec replace_nth lst m =
                        match lst with
                        | [] -> failwith "list too short"
-                       | x::xs when m = 0 -> new_value :: xs
+                       | x::xs when m = 0 -> value2 :: xs
                        | x::xs -> x :: replace_nth xs (m - 1)
                in let s''' = replace_nth s'' index1
                (* we'll arbitrarily return Int 42 as the expressed_value of a Setref operation *)
@@ -487,19 +490,19 @@ To keep our codebase smaller, we'll implement mutable pairs instead of, not in a
 This implementation will largely parallel the previous one. Here are the differences. First, we remove the `Newref`, `Deref`, and `Setref` forms from the language. Our existing form `Makepair` will serve to create mutable pairs, and so will take over a role analogous to `Newref`. Our existing form `First` will take over a role analogous to `Deref`. We'll introduce one new form `Setfirst` that will take over a role analogous to `Setref`:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
-               | Letrec of (char * term * term)
-        | Setfirst of (term * term)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
+       | Letrec of (char * term * term)
+       | Setfirst of (term * term)
        ;;
 
 Our `expressed_value` type changes in two ways: first, we eliminate the `Mutcell` variant added in the previous implementation. Instead, we now have our `Pair` variant wrap `index`es into the `store`:
@@ -535,12 +538,12 @@ Finally, here are the changed or added clauses to the evaluation function:
         (* we don't handle cases where t1 doesn't evaluate to a Pair *)
         let (Pair (index1, index2), s') = eval t1 g s
         (* note that s' may be different from s, if t1 itself contained any mutation operations *)
-        in let (new_value, s'') = eval t2 g s'
-        (* now we create a list which is just like s'' except it has new_value in index1 *)
+        in let (value2, s'') = eval t2 g s'
+        (* now we create a list which is just like s'' except it has value2 in index1 *)
         in let rec replace_nth lst m =
             match lst with
             | [] -> failwith "list too short"
-            | x::xs when m = 0 -> new_value :: xs
+            | x::xs when m = 0 -> value2 :: xs
             | x::xs -> x :: replace_nth xs (m - 1)
         in let s''' = replace_nth s'' index1
         in (Int 42, s''')
@@ -557,19 +560,19 @@ Next we implement implicit-style mutation, as we did in [[week9]]. Here we don't
 Our language for the present implementation will be the language for the calculator with recursive functions, with one added syntactic form, `Change (...)`:
 
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
-               | Letrec of (char * term * term)
-               | Change of (char * term * term)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
+       | Letrec of (char * term * term)
+       | Change of (char * term * term)
        ;;
 
 In the present implementation, we separate the roles of the `bound_value` and `expressed_value` types. As we discussed in [[week9]], our assignment will bind all variables to indexes in the store, and the latter will contain the `expressed_value`s that the variables evaluate to. A consequence of this is that our definitions of the `bound_value` and `expressed_value` types no longer need to be mutually recursive:
@@ -582,116 +585,158 @@ In the present implementation, we separate the roles of the `bound_value` and `e
         
        type store = expressed_value list;;
 
-Our evaluation function still interacts with a `store` argument in much the same way it did with explicit-style mutation. The clause for `Variable ...` works differently, because all `expressed_value`s now need to be retrieved from the `store`:
+Our evaluation function still interacts with a `store` argument in much the same way it did with explicit-style mutation. The clause for `Variable (...)` works differently, because all `expressed_value`s now need to be retrieved from the `store`:
         
        let rec eval (t : term) (g : assignment) (s : store) = match t with
-               ...
-               | Variable (var) ->
-                       (* we don't handle cases where g doesn't bind var to any value *)
-                       let index = List.assoc var g
-                       (* get value stored at location index in s *)
-                       in let value = List.nth s index
-                       in (value, s)
-               ...
+       ...
+       | Variable (var) ->
+               (* we don't handle cases where g doesn't bind var to any value *)
+               let index = List.assoc var g
+               (* get value stored at location index in s *)
+               in let value = List.nth s index
+               in (value, s)
+       ...
 
 So this clause takes over the roles that were separately played by `Variable` and `Deref` in the calculator with mutable cells. The role played by `Newref` is absorbed into `Let`, `Letrec`, and `Apply`:
 
-               ...
-               | Let (var_to_bind, t2, t3) ->
-                       let (value2, s') = eval t2 g s
-                       (* note that s' may be different from s, if t2 itself contained any mutation operations *)
-                       (* get next free index in s' *)
-                       in let new_index = List.length s'
-                       (* now we want to insert value2 there; the following is an easy but inefficient way to do it *)
-                       in let s'' = List.append s' [value2]
-                       (* bind var_to_bind to location new_index in the store *)
-                       in let g' = ((var_to_bind, new_index) :: g)
-                       in eval t3 g' s''
-               ...
-               | Apply (t1, t2) ->
-                       (* we don't handle cases where t1 doesn't evaluate to a function value *)
-                       let (Closure (arg_var, body, savedg), s') = eval t1 g s
-                       in let (value2, s'') = eval t2 g s'
-                       (* evaluate body under savedg, except with arg_var bound to a new location containing value2 *)
-                       in let new_index = List.length s''
-                       in let s''' = List.append s'' [value2]
-                       in let savedg' = (arg_var, new_index) :: savedg
-                       in eval body savedg' s'''
-               ...
+       ...
+       | Let (var_to_bind, t2, t3) ->
+               let (value2, s') = eval t2 g s
+               (* note that s' may be different from s, if t2 itself contained any mutation operations *)
+               (* get next free index in s' *)
+               in let new_index = List.length s'
+               (* now we want to insert value2 there; the following is an easy but inefficient way to do it *)
+               in let s'' = List.append s' [value2]
+               (* bind var_to_bind to location new_index in the store *)
+               in let g' = ((var_to_bind, new_index) :: g)
+               in eval t3 g' s''
+       ...
+       | Apply (t1, t2) ->
+               (* we don't handle cases where t1 doesn't evaluate to a function value *)
+               let (Closure (arg_var, body, savedg), s') = eval t1 g s
+               in let (value2, s'') = eval t2 g s'
+               (* evaluate body under savedg, except with arg_var bound to a new location containing value2 *)
+               in let new_index = List.length s''
+               in let s''' = List.append s'' [value2]
+               in let savedg' = (arg_var, new_index) :: savedg
+               in eval body savedg' s'''
+       ...
 
 `Letrec` requires some reworking from what we had before. Earlier, we resorted to a `Recursive_Closure` variant on `bound_value`s because it gave us a non-exotic way to update the `savedg` component of a `Closure` to refer to a `new_closure` that contained that very updated `savedg`. Now that we we've got a mutation-supporting infrastructure in place, we can do this directly, without needing the unwieldy `Recursive_Closure` wrapper:
 
-               ...
-               | Letrec (var_to_bind, t2, t3) ->
-                       (* we don't handle cases where t2 doesn't evaluate to a function value *)
-                       let (Closure (arg_var, body, savedg), s') = eval t2 g s
-                       in let new_index = List.length s'
-                       in let savedg' = (var_to_bind, new_index) :: savedg
-                       in let new_closure = Closure (arg_var, body, savedg')
-                       in let s'' = List.append s' [new_closure]
-                       in let g' = (var_to_bind, new_index) :: g
-                       in eval t3 g' s''
-               ...
+       ...
+       | Letrec (var_to_bind, t2, t3) ->
+               (* we don't handle cases where t2 doesn't evaluate to a function value *)
+               let (Closure (arg_var, body, savedg), s') = eval t2 g s
+               in let new_index = List.length s'
+               in let savedg' = (var_to_bind, new_index) :: savedg
+               in let new_closure = Closure (arg_var, body, savedg')
+               in let s'' = List.append s' [new_closure]
+               in let g' = (var_to_bind, new_index) :: g
+               in eval t3 g' s''
+       ...
 
 Finally, here is the clause for `Change (...)`, which takes over the role earlier played by `Setref`: 
 
-               | Change (var, t2, t3) ->
-                       (* we don't handle cases where g doesn't bind var to any value *)
-                       let index = List.assoc var g
-                       in let (value2, s') = eval t2 g s
-                       (* note that s' may be different from s, if t2 itself contained any mutation operations *)
-                       (* now we create a list which is just like s' except it has value2 at index *)
-                       in let rec replace_nth lst m =
-                               match lst with
-                               | [] -> failwith "list too short"
-                               | x::xs when m = 0 -> value2 :: xs
-                               | x::xs -> x :: replace_nth xs (m - 1)
-                       in let s'' = replace_nth s' index
-                       (* evaluate t3 using original assignment function and new store *)
-                       in eval t3 g s''
-               ;;
-
-Note that because the `savedg` component of a `Closure` keeps track of which `index`es in the store free variables were bound to, the values at those `index`es can later be changed, and later applications of the `Closure` will use the changed values.
+       ...
+       | Change (var, t2, t3) ->
+               (* we don't handle cases where g doesn't bind var to any value *)
+               let index = List.assoc var g
+               in let (value2, s') = eval t2 g s
+               (* note that s' may be different from s, if t2 itself contained any mutation operations *)
+               (* now we create a list which is just like s' except it has value2 at index *)
+               in let rec replace_nth lst m =
+                       match lst with
+                       | [] -> failwith "list too short"
+                       | x::xs when m = 0 -> value2 :: xs
+                       | x::xs -> x :: replace_nth xs (m - 1)
+               in let s'' = replace_nth s' index
+               (* evaluate t3 using original assignment function and new store *)
+               in eval t3 g s''
+       ;;
+
+Note that because the `savedg` component of a `Closure` keeps track of which `index`es in the store---rather than which values---free variables were bound to, the values at those `index`es can later be changed, and later applications of the `Closure` will use the changed values.
 
 The complete code is available [here](/code/calculator/calc6.ml).
 
 ##Adding Aliasing and Passing by Reference##
 
+Next we'll add aliasing as described at the end of [[week9]]. We'll also add the ability to pass (implicit) reference cells as arguments to a function, which lets changes made within the function body be effective in the outside environment. When we discussed this in [[week9]], we proposed a different syntactic form for the function values that get called in this way. Instead of:
+
+       let f = lambda (y) -> ...
+       ...
+       in f x
+
+one would write:
+
+       let f = lambda (alias y) -> ...
+       ...
+       in f x
+
+Real programming languages that have this ability, such as C++, do something analagous. Here the function is declared so that *all* of its applications are expected to alias the supplied argument. You can always work around that in a particular case, though, like this:
+
+       let f = lambda (alias y) -> ...
+       ...
+       in let y = x ; creates new (implicit) reference cell with x's value
+       in f y
+
+In our present framework, it will be easier to do things differently. We will
+introduce a new syntactic form at the location where a function value is
+applied, rather than in the function's declaration. We say:
+
+       Let ('f',
+               Lambda ('y', ...),
+               ...
+               Apply(Variable 'f', Variable 'x')...)
+
+for the familiar, passing-by-value behavior, and will instead say:
+
+       Let ('f',
+               Lambda ('y', ...),
+               ...
+               Applyalias(Variable 'f', 'x')...)
+
+for the proposed new, passing-by-reference behavior. (Besides being easier to implement here, this strategy also has the advantage of more closely aligning with the formal system Jim discusses in his "Hyper-evaluativity" paper.) Note that the second parameter to the `Applyalias` form is just `'x'`, not `Variable 'x'`. This is because (1) only variables are acceptable there, not arbitrary expressions, and (2) we don't need at that point to compute the variable's present value.
+
+Here is our expanded language:
+
        type term =
-                 Intconstant of int
-               | Multiplication of (term * term)
-               | Addition of (term * term)
-               | Variable of char
-               | Let of (char * term * term)
-               | Iszero of term
-               | If of (term * term * term)
-               | Makepair of (term * term)
-               | First of term
-               | Lambda of (char * term)
-               | Apply of (term * term)
-               | Letrec of (char * term * term)
-               | Change of (char * term * term)
-               | Alias of (char * char * term)
-               | Applyalias of (term * char)
+         Intconstant of int
+       | Multiplication of (term * term)
+       | Addition of (term * term)
+       | Variable of char
+       | Let of (char * term * term)
+       | Iszero of term
+       | If of (term * term * term)
+       | Makepair of (term * term)
+       | First of term
+       | Lambda of (char * term)
+       | Apply of (term * term)
+       | Letrec of (char * term * term)
+       | Change of (char * term * term)
+       | Alias of (char * char * term)
+       | Applyalias of (term * char)
        ;;
  
+The definitions of `index`, `bound_value`, `assignment`, `expressed_value`, and `store` can remain as they were in the implementation of implicit-style mutation. Here are the changes to our evaluation function:
+
        let rec eval (t : term) (g : assignment) (s : store) = match t with
-               ...
-               | Alias (var_to_bind, orig_var, t3) ->
-                       (* we don't handle cases where g doesn't bind orig_var to any value *)
-                       let index = List.assoc orig_var g
-                       (* bind var_to_bind to the same index in the store *)
-                       in let g' = ((var_to_bind, index) :: g)
-                       in eval t3 g' s
-               | Applyalias (t1, var) ->
-                       (* we don't handle cases where t1 doesn't evaluate to a function value *)
-                       let (Closure (arg_var, body, savedg), s') = eval t1 g s
-                       (* we don't handle cases where g doesn't bind var to any value *)
-                       in let index = List.assoc var g
-                       (* evaluate body under savedg, except with arg_var bound to existing index *)
-                       in let savedg' = (arg_var, index) :: savedg
-                       in eval body savedg' s'
-               ;;
+       ...
+       | Alias (var_to_bind, orig_var, t3) ->
+               (* we don't handle cases where g doesn't bind orig_var to any value *)
+               let index = List.assoc orig_var g
+               (* bind var_to_bind to the same index in the store *)
+               in let g' = ((var_to_bind, index) :: g)
+               in eval t3 g' s
+       | Applyalias (t1, var) ->
+               (* we don't handle cases where t1 doesn't evaluate to a function value *)
+               let (Closure (arg_var, body, savedg), s') = eval t1 g s
+               (* we don't handle cases where g doesn't bind var to any value *)
+               in let index = List.assoc var g
+               (* evaluate body under savedg, except with arg_var bound to existing index *)
+               in let savedg' = (arg_var, index) :: savedg
+               in eval body savedg' s'
+       ;;
 
 The complete code is available [here](/code/calculator/calc7.ml).