# Zipper (data structure)

A zipper is a technique of representing an aggregate data structure so that it is convenient for writing programs that traverse the structure arbitrarily and update its contents, especially in purely functional programming languages. The zipper was described by Gérard Huet in 1997.[1] It includes and generalizes the gap buffer technique sometimes used with arrays.

The zipper technique is general in the sense that it can be adapted to lists, trees, and other recursively defined data structures. Such modified data structures are usually referred to as "a tree with zipper" or "a list with zipper" to emphasize that the structure is conceptually a tree or list, while the zipper is a detail of the implementation.

A layman's explanation for a tree with zipper would be an ordinary computer filesystem with operations to go to parent (often cd ..), and the possibility to go downwards (cd subdirectory). The zipper is the pointer to the current path. Behind the scenes the zippers are efficient when making (functional) changes to a data structure, where a new, slightly changed, data structure is returned from an edit operation (instead of making a change in the current data structure).

## Example: Bidirectional list traversal

Many common data structures in computer science can be expressed as the structure generated by a few primitive constructor operations or observer operations. These include the structure of finite lists, which can be generated by two operations:

• Empty: Constructs an empty list
• Insert(x, L): Constructs a list by inserting value x in front of list L

The list [1, 2, 3] is then constructed as Insert(1, Insert(2, Insert(3, Empty))). It is possible to describe the location of a value in a list as the number of steps from the front of the list to that value. More formally, a location is the number of additional Insert operations used to construct the whole list, after a particular value was inserted.

A context for a location in the list is constructed by recording not just the number of Insert operations, but all of the other information about them—namely, the values that were inserted. These are represented in a separate list that is reversed from the order of the original data structure. Specifically, the context of "3" in the list [1, 2, 3] is represented as [2, 1]. A list with a zipper represents the entire structure, and a location within the structure. This is a pair consisting of the location's context, and the part of the structure that begins at the location. The list [1, 2, 3, 4] with a reference to the "3" is represented as ([2, 1], [3, 4]).

With the list represented this way, it is easy to define efficient operations that move the location forward or backward and manipulate the list at that location, for example by inserting or removing items. Similarly, applying the zipper transformation to a tree makes it easy to insert or remove values at a particular location in the tree.

## Uses

The zipper is often used where there is some concept of 'focus' or of moving around in some set of data, since its semantics reflect that of moving around but in a functional non-destructive manner.

The zipper has been used in

• Xmonad, to manage focus and placement of windows
• Huet's papers cover a structural editor[2] based on zippers and a theorem prover
• A filesystem (ZipperFS) written in Haskell offering "...transactional semantics; undo of any file and directory operation; snapshots; statically guaranteed the strongest, repeatable read, isolation mode for clients; pervasive copy-on-write for files and directories; built-in traversal facility; and just the right behavior for cyclic directory references."[3]
• Clojure has extensive support for zippers. [4]

## Zipper contexts and differentiation

It has been shown that the type of the items in the context list produced by the zipper transformation is the "derivative" of the original type in a sense that is related to differentiation in calculus by decategorification. Most datatypes are constructed from products and sums of datatypes; any given datatype looks like a polynomial or a Taylor series, and the representation of the type of context items looks like the derivative of that polynomial or series.[5][6] In a recursive datatype like a list or a tree, the derivative is taken with respect to the recursion variable.

Consider a recursive data structure like a binary tree labeled by data of type A.

$T(A, R) = 1 + A\cdot R^2$

That is, a tree is either empty, or a triple consisting of a value of type $A$ and two subtrees of type $R$. The datatype of the context is

$\frac{d T(A, R)}{d R} = A\cdot 2\cdot R.$

By taking the fixed point $R = T(A, R),$ we find that a zipper for a tree consists of a "path" and a downward subtree, where a path is a context list of triples consisting of

• a value for the root of the tree (type A)
• a choice of left or right subtree in which to find the hole (type 2), and
• the value of the other subtree (type R).

In general, then, a zipper for a datatype $T$ parameterized by some other type $A$ and a recursion variable $R$ consists of two parts: a context list with items of type $\frac{d T(A, R)}{dR}|_{R = T(A, R)}$ and a copy of the downward substructure $T(A,R)|_{R = T(A,R)}.$

## Alternatives and extensions

### Direct modification

In a non-purely-functional programming language, it may be more convenient to simply traverse the original data structure and modify it directly (perhaps after deep cloning it, to avoid affecting other code that might hold a reference to it).

### Generic zipper

The Generic Zipper[7][8][9] is a technique to achieve the same goal as the conventional zipper by capturing the state of the traversal in a continuation while visiting each node. (The Haskell code given in the reference uses generic programming to generate a traversal function for any data structure, but this is optional – any suitable traversal function can be used.)

However, the Generic Zipper involves inversion of control, so some uses of it require a state machine (or equivalent) to keep track of what to do next.

## References

1. ^ Huet 1997
2. ^
3. ^ Generic Zipper: the context of a traversal
4. ^ jafingerhut (2010-10-22). "clojure.zip/zipper". ClojureDocs. Retrieved 2013-06-15.
5. ^ Joyal, André (1981), "Une théorie combinatoire des séries formelles", Advances in Mathematics 42:1-82.
6. ^ McBride, Conor (2001), "The Derivative of a Regular Type is its Type of One-Hole Contexts"
7. ^ Chung-chieh Shan, Oleg Kiselyov (17 August 2008). "From walking to zipping, part 1". Retrieved 29 August 2011.
8. ^ Chung-chieh Shan, Oleg Kiselyov (17 August 2008). "From walking to zipping, part 2". Retrieved 29 August 2011.
9. ^ Chung-chieh Shan, Oleg Kiselyov (17 August 2008). "From walking to zipping, part 3". Retrieved 29 August 2011.