tweak monads-lib, start T2
[lambda.git] / tree_and_list_zippers.mdwn
1 [[!toc]]
2
3 ##List Zippers##
4
5 Say you've got some moderately-complex function for searching through a list, for example:
6
7         let find_nth (test : 'a -> bool) (n : int) (lst : 'a list) : (int * 'a) ->
8             let rec helper (position : int) n lst =
9                 match lst with
10                 | [] -> failwith "not found"
11                 | x :: xs when test x -> (if n = 1
12                     then (position, x)
13                     else helper (position + 1) (n - 1) xs
14                 )
15                 | x :: xs -> helper (position + 1) n xs
16             in helper 0 n lst;;
17
18 This searches for the `n`th element of a list that satisfies the predicate `test`, and returns a pair containing the position of that element, and the element itself. Good. But now what if you wanted to retrieve a different kind of information, such as the `n`th element matching `test`, together with its preceding and succeeding elements? In a real situation, you'd want to develop some good strategy for reporting when the target element doesn't have a predecessor and successor; but we'll just simplify here and report them as having some default value:
19
20         let find_nth' (test : 'a -> bool) (n : int) (lst : 'a list) (default : 'a) : ('a * 'a * 'a) ->
21             let rec helper (predecessor : 'a) n lst =
22                 match lst with
23                 | [] -> failwith "not found"
24                 | x :: xs when test x -> (if n = 1
25                     then (predecessor, x, match xs with [] -> default | y::ys -> y)
26                     else helper x (n - 1) xs
27                 )
28                 | x :: xs -> helper x n xs
29             in helper default n lst;;
30
31 This duplicates a lot of the structure of `find_nth`; it just has enough different code to retrieve different information when the matching element is found. But now what if you wanted to retrieve yet a different kind of information...?
32
33 Ideally, there should be some way to factor out the code to find the target element---the `n`th element of the list satisfying the predicate `test`---from the code that retrieves the information you want once the target is found. We might build upon the initial `find_nth` function, since that returns the *position* of the matching element. We could hand that result off to some other function that's designed to retrieve information of a specific sort surrounding that position. But suppose our list has millions of elements, and the target element is at position 600512. The search function will already have traversed 600512 elements of the list looking for the target, then the retrieval function would have to *start again from the beginning* and traverse those same 600512 elements again. It could go a bit faster, since it doesn't have to check each element against `test` as it traverses. It already knows how far it has to travel. But still, this should seem a bit wasteful.
34
35 Here's an idea. What if we had some way of representing a list as "broken" at a specific point. For example, if our base list is:
36
37         [10; 20; 30; 40; 50; 60; 70; 80; 90]
38
39 we might imagine the list "broken" at position 3 like this (positions are numbered starting from 0):
40
41                     40;
42                 30;     50;
43             20;             60;
44         [10;                    70;
45                                     80;
46                                         90]
47
48 Then if we move one step forward in the list, it would be "broken" at position 4:
49
50                         50;
51                     40;     60;
52                 30;             70;
53             20;                     80;
54         [10;                            90]
55
56 If we had some convenient representation of these "broken" lists, then our search function could hand *that* off to the retrieval function, and the retrieval function could start right at the position where the list was broken, without having to start at the beginning and traverse many elements to get there. The retrieval function would also be able to inspect elements both forwards and backwards from the position where the list was "broken".
57
58 The kind of data structure we're looking for here is called a **list zipper**. To represent our first broken list, we'd use two lists: (1) containing the elements in the left branch, preceding the target element, *in the order reverse to their appearance in the base list*. (2) containing the target element and the rest of the list, in normal order. So:
59
60                     40;
61                 30;     50;
62             20;             60;
63         [10;                    70;
64                                     80;
65                                         90]
66
67 would be represented as `([30; 20; 10], [40; 50; 60; 70; 80; 90])`. To move forward in the base list, we pop the head element `40` off of the head element of the second list in the zipper, and push it onto the first list, getting `([40; 30; 20; 10], [50; 60; 70; 80; 90])`. To move backwards again, we pop off of the first list, and push it onto the second. To reconstruct the base list, we just "move backwards" until the first list is empty. (This is supposed to evoke the image of zipping up a zipper; hence the data structure's name.)
68
69 We had some discussion in seminar of the right way to understand the "zipper" metaphor. I think it's best to think of the tab of the zipper being here:
70
71                  t
72                   a
73                    b
74                     40;
75                 30;     50;
76             20;             60;
77         [10;                    70;
78                                     80;
79                                         90]
80
81 And imagine that you're just seeing the left half of a real-zipper, rotated 60 degrees counter-clockwise. When the list is all "zipped up", we've "move backwards" to the state where the first element is targetted:
82
83         ([], [10; 20; 30; 40; 50; 60; 70; 80; 90])
84
85 However you understand the "zipper" metaphor, this is a very handy data structure, and it will become even more handy when we translate it over to more complicated base structures, like trees. To help get a good conceptual grip on how to do that, it's useful to introduce a kind of symbolism for talking about zippers. This is just a metalanguage notation, for us theorists; we don't need our programs to interpret the notation. We'll use a specification like this:
86
87         [10; 20; 30; *; 50; 60; 70; 80; 90], * filled by 40
88
89 to represent a list zipper where the break is at position 3, and the element occupying that position is 40. For a list zipper, this is implemented using the pairs-of-lists structure described above.
90
91
92 ##Tree Zippers##
93
94 Now how could we translate a zipper-like structure over to trees? What we're aiming for is a way to keep track of where we are in a tree, in the same way that the "broken" lists let us keep track of where we are in the base list.
95
96 It's important to set some ground rules for what will follow. If you don't understand these ground rules you will get confused. First off, for many uses of trees one wants some of the nodes or leaves in the tree to be *labeled* with additional information. It's important not to conflate the label with the node itself. Numerically one and the same piece of information---for example, the same `int`---could label two nodes of the tree without those nodes thereby being identical, as here:
97
98                 root
99                 / \
100               /     \
101             /  \    label 1
102           /      \
103         label 1  label 2
104
105 The leftmost leaf and the rightmost leaf have the same label; but they are different leaves. The leftmost leaf has a sibling leaf with the label 2; the rightmost leaf has no siblings that are leaves. Sometimes when one is diagramming trees, one will annotate the nodes with the labels, as above. Other times, when one is diagramming trees, one will instead want to annotate the nodes with tags to make it easier to refer to particular parts of the tree. So for instance, I could diagram the same tree as above as:
106
107                  1
108                 / \
109               2     \
110             /  \     5
111           /      \
112          3        4
113
114 Here I haven't drawn what the labels are. The leftmost leaf, the node tagged "3" in this diagram, doesn't have the label `3`. It has the label 1, as we said before. I just haven't put that into the diagram. The node tagged "2" doesn't have the label `2`. It doesn't have any label. The tree in this example only has information labeling its leaves, not any of its inner nodes. The identity of its inner nodes is exhausted by their position in the tree.
115
116 That is a second thing to note. In what follows, we'll only be working with *leaf-labeled* trees. In some uses of trees, one also wants labels on inner nodes. But we won't be discussing any such trees now. Our trees only have labels on their leaves. The diagrams below will tag all of the nodes, as in the second diagram above, and won't display what the leaves' labels are.
117
118 Final introductory comment: in particular applications, you may only need to work with binary trees---trees where internal nodes always have exactly two subtrees. That is what we'll work with in the homework, for example. But to get the guiding idea of how tree zippers work, it's helpful first to think about trees that permit nodes to have many subtrees. So that's how we'll start.
119
120 Suppose we have the following tree:
121
122                                  9200
123                             /      |  \
124                          /         |    \
125                       /            |      \
126                    /               |        \
127                 /                  |          \
128                500                920          950
129             /   |    \          /  |  \      /  |  \
130          20     50     80      91  92  93   94  95  96
131         1 2 3  4 5 6  7 8 9
132
133 This is a leaf-labeled tree whose labels aren't displayed. The `9200` and so on are tags to make it easier for us to refer to particular parts of the tree.
134
135 Suppose we want to represent that we're *at* the node marked `50`. We might use the following metalanguage notation to specify this:
136
137         {parent = ...; siblings = [subtree 20; *; subtree 80]}, * filled by subtree 50
138
139 This is modeled on the notation suggested above for list zippers. Here `subtree 20` refers to the whole subtree rooted at node `20`:
140
141           20
142          / | \
143         1  2  3
144
145 Similarly for `subtree 50` and `subtree 80`. We haven't said yet what goes in the `parent = ...` slot. Well, the parent of a subtree targetted on `node 50` should intuitively be a tree targetted on `node 500`:
146
147         {parent = ...; siblings = [*; subtree 920; subtree 950]}, * filled by subtree 500
148
149 And the parent of that targetted subtree should intuitively be a tree targetted on `node 9200`:
150
151         {parent = None; siblings = [*]}, * filled by tree 9200
152
153 This tree has no parents because it's the root of the base tree. Fully spelled out, then, our tree targetted on `node 50` would be:
154
155         {
156            parent = {
157               parent = {
158                  parent = None;
159                  siblings = [*]
160               }, * filled by tree 9200;
161               siblings = [*; subtree 920; subtree 950]
162            }, * filled by subtree 500;
163            siblings = [subtree 20; *; subtree 80]
164         }, * filled by subtree 50
165
166 In fact, there's some redundancy in this structure, at the points where we have `* filled by tree 9200` and `* filled by subtree 500`. Since node 9200 doesn't have any label attached to it, the subtree rooted in it is determined by the rest of this structure; and so too with `subtree 500`. So we could really work with:
167
168         {
169            parent = {
170               parent = {
171                  parent = None;
172                  siblings = [*]
173               },
174               siblings = [*; subtree 920; subtree 950]
175            },
176            siblings = [subtree 20; *; subtree 80]
177         }, * filled by subtree 50
178
179
180 We still do need to keep track of what fills the outermost targetted position---`* filled by subtree 50`---because that contain a subtree of arbitrary complexity, that is not determined by the rest of this data structure.
181
182 For simplicity, I'll continue to use the abbreviated form:
183
184         {parent = ...; siblings = [subtree 20; *; subtree 80]}, * filled by subtree 50
185
186 But that should be understood as standing for the more fully-spelled-out structure. Structures of this sort are called **tree zippers**. They should already seem intuitively similar to list zippers, at least in what we're using them to represent. I think it may also be helpful to call them **targetted trees**, though, and so will be switching back and forth between these different terms.
187
188 Moving left in our targetted tree that's targetted on `node 50` would be a matter of shifting the `*` leftwards:
189
190         {parent = ...; siblings = [*; subtree 50; subtree 80]}, * filled by subtree 20
191
192 and similarly for moving right. If the sibling list is implemented as a list zipper, you should already know how to do that. If one were designing a tree zipper for a more restricted kind of tree, however, such as a binary tree, one would probably not represent siblings with a list zipper, but with something more special-purpose and economical.
193
194 Moving downward in the tree would be a matter of constructing a tree targetted on some child of `node 20`, with the first part of the targetted tree above as its parent:
195
196         {
197            parent = {parent = ...; siblings = [*; subtree 50; subtree 80]};
198            siblings = [*; leaf 2; leaf 3]
199         }, * filled by leaf 1
200
201 How would we move upward in a tree? Well, we'd build a regular, untargetted tree with a root node---let's call it `20'`---and whose children are given by the outermost sibling list in the targetted tree above, after inserting the targetted subtree into the `*` position:
202
203                node 20'
204             /     |    \
205          /        |      \
206         leaf 1  leaf 2  leaf 3
207
208 We'll call this new untargetted tree `subtree 20'`. The result of moving upward from our previous targetted tree, targetted on `leaf 1`, would be the outermost `parent` element of that targetted tree, with `subtree 20'` being the subtree that fills that parent's target position `*`:
209
210         {
211            parent = ...;
212            siblings = [*; subtree 50; subtree 80]
213         }, * filled by subtree 20'
214
215 Or, spelling that structure out fully:
216
217         {
218            parent = {
219               parent = {
220                  parent = None;
221                  siblings = [*]
222               },
223               siblings = [*; subtree 920; subtree 950]
224            },
225            siblings = [*; subtree 50; subtree 80]
226         }, * filled by subtree 20'
227
228 Moving upwards yet again would get us:
229
230         {
231            parent = {
232               parent = None;
233               siblings = [*]
234            },
235            siblings = [*; subtree 920; subtree 950]
236         }, * filled by subtree 500'
237
238 where `subtree 500'` refers to a tree built from a root node whose children are given by the list `[*; subtree 50; subtree 80]`, with `subtree 20'` inserted into the `*` position. Moving upwards yet again would get us:
239
240         {
241            parent = None;
242            siblings = [*]
243         }, * filled by tree 9200'
244
245 where the targetted element is the root of our base tree. Like the "moving backward" operation for the list zipper, this "moving upward" operation is supposed to be reminiscent of closing a zipper, and that's why these data structures are called zippers.
246
247 We haven't given you a real implementation of the tree zipper, but only a suggestive notation. We have however told you enough that you should be able to implement it yourself. Or if you're lazy, you can read:
248
249 *       [[!wikipedia Zipper (data structure)]]
250 *       [Haskell wikibook on zippers](http://en.wikibooks.org/wiki/Haskell/Zippers)
251 *       Huet, Gerard. ["Functional Pearl: The Zipper"](http://www.st.cs.uni-sb.de/edu/seminare/2005/advanced-fp/docs/huet-zipper.pdf) Journal of Functional Programming 7 (5): 549-554, September 1997.
252 *       As always, [Oleg](http://okmij.org/ftp/continuations/Continuations.html#zipper) takes this a few steps deeper.
253
254