Fold

The simplest example of fold is accepting a variable number of (curried) arguments. We’ll define a function f and argument a such that all of the following expressions are valid.

Off-hand it may appear impossible that all of the above expressions are type correct SML — how can a function f accept a variable number of curried arguments? What could the type of f be? We’ll have more to say later on how type checking works. For now, once we have supplied the definitions below, you can check that the expressions are type correct by feeding them to your favorite SML implementation.

It is simple to define f and a. We define f as a folder whose base element is () and whose finish function does nothing. We define a as the step function that does nothing. The only trickiness is that we must eta expand the definition of f and a to work around the ValueRestriction; we frequently use eta expansion for this purpose without mention.

One can easily apply the fold equation to verify by hand that f applied to any number of a's evaluates to ().

Let’s look at an example that computes something: a variable-argument function sum and a stepper a such that

The idea is simple — the folder starts with a base accumulator of 0 and the stepper adds each element to the accumulator, s, which the folder simply returns at the end.

Using the fold equation, one can verify the following.

It is sometimes syntactically convenient to omit the parentheses around the steps in a fold. This is easily done by defining a new function, step1, as follows.

From the definition of step1, we have the following equivalence.

Using the above equivalence, we can compute the following equation for step1.

Here is an example using step1 to define a variable-argument product function, prod, with a convenient syntax.

The functions prod and ` satisfy the following equation.

Note that in SML, `i1 is two different tokens, ` and i1. We often use ` for an instance of a step1 function because of its syntactic unobtrusiveness and because no space is required to separate it from an alphanumeric token.

Also note that there are no parenthesis around the steps. That is, the following expression is not the same as the above one (in fact, it is not type correct).

SML already has a syntax for list literals, e.g. [w, x, y, z]. However, using fold, we can define our own syntax.

The idea is that the folder starts out with the empty list, the steps accumulate the elements into a list, and then the finishing function reverses the list at the end.

With these definitions one can write a list like:

While the example is not practically useful, it does demonstrate the need for the finishing function to be incorporated in fold. Without a finishing function, every use of list would need to be wrapped in rev, as follows.

The finishing function allows us to incorporate the reversal into the definition of list, and to treat list as a truly variable argument function, performing an arbitrary computation after receiving all of its arguments.

See ArrayLiteral for a similar use of fold that provides a syntax for array and vector literals, which are not built in to SML.

Just as fold is analogous to a fold left, in which the functions are applied to the accumulator left-to-right, we can define a variant of fold that is analogous to a fold right, in which the functions are applied to the accumulator right-to-left. That is, we can define functions foldr and step0 such that the following equation holds.

The implementation of fold right is easy, using fold. The idea is for the fold to start with f and for each step to precompose the next hi. Then, the finisher applies the composed function to the base value, a. Here is the code.

Verifying the fold-right equation is straightforward, using the fold-left equation.

One can also define the fold-right analogue of step1.

Revisiting the list literal example from earlier, we can use fold right to define a syntax for list literals that doesn’t do a reversal.

As before, with these definitions, one can write a list like:

The difference between the fold-left and fold-right approaches is that the fold-right approach does not have to reverse the list at the end, since it accumulates the elements in the correct order. In practice, MLton will simplify away all of the intermediate function composition, so the the fold-right approach will be more efficient.

All of the examples so far have used the same step function throughout a fold. This need not be the case. For example, consider the following.

Here we have one folder, n, that can be used with two different steppers, I and O. By using the fold equation, one can verify the following equations.

That is, we’ve defined a syntax for writing binary integer constants.

Not only can one use different instances of step0 in the same fold, one can also intermix uses of step0 and step1. For example, consider the following.

Using the straightforward generalization of the fold equation to mixed steppers, one can verify the following equations.

That is, we’ve defined a syntax for writing octal integer constants, with a special syntax, O, for the zero digit (admittedly contrived, since one could just write `0 instead of O).

See NumericLiteral for a practical extension of this approach that supports numeric constants in any base and of any type.

A normal list fold always returns the same type no matter what elements are in the list or how long the list is. Variable-argument fold is more powerful, because the result type can vary based both on the arguments that are passed and on their number. This can provide the illusion of dependent types.

For example, consider the following.

Using the fold equation, one can verify the following equations.

That is, f returns a value of a different type depending on whether it is applied to argument a, argument b, or argument c.

The following example shows how the type of a fold can depend on the number of arguments.

Using the fold equation, one can verify the following equations.

Clearly, the result type of a call to the variable argument grow function depends on the number of arguments that are passed.

As a reminder, this is well-typed SML. You can check it out in any implementation.

Fold is especially useful when it returns a curried function whose arity depends on the number of arguments. For example, consider the following.

The makeSum folder constructs a function whose arity depends on the number of I arguments and that adds together all of its arguments. For example, makeSum I $ is of type int -> int and makeSum I I $ is of type int -> int -> int.

One can use the fold equation to verify that the makeSum works correctly. For example, one can easily check by hand the following equations.

Returning a function becomes especially interesting when there are steppers of different types. For example, the following makeSum folder constructs functions that sum integers and reals.

With these definitions, makeSum I R $ is of type int -> real -> real and makeSum R I I $ is of type real -> int -> int -> real. One can use the foldr equation to check the following equations.

We used foldr instead of fold for this so that the order in which the specifiers I and R appear is the same as the order in which the arguments appear. Had we used fold, things would have been reversed.

An extension of this idea is sufficient to define Printf-like functions in SML.

It is sometimes useful to combine a number of steps together and name them as a single step. As a simple example, suppose that one often sees an integer follower by a real in the makeSum example above. One can define a new compound step IR as follows.

With this definition in place, one can verify the following.

In general, one can combine steps s1, s2, … sn as

The following calculation shows why a compound step behaves as the composition of its constituent steps.

Suppose we already have a function defined via fold, w = fold (a, f), and we would like to construct a new fold function that is like w, but applies g to the result produced by w. This is similar to function composition, but we can’t just do g o w, because we don’t want to use g until w has been applied to all of its arguments and received the end-of-arguments terminator $.

More precisely, we want to define a post-composition function post that satisfies the following equation.

Here is the definition of post.

The following calculations show that post satisfies the desired equation, where w = fold (a, f).

Now, suppose si = step0 hi for i from 1 to n.

For a practical example of post composition, see ArrayLiteral.

We now define a peculiar-looking function, lift0, that is, equationally speaking, equivalent to the identity function on a step function.

Using the definitions, we can prove the following equation.

Here is the proof.

If lift0 is the identity, then why even define it? The answer lies in the typing of fold expressions, which we have, until now, left unexplained.

Perhaps the most surprising aspect of fold is that it can be checked by the SML type system. The types involved in fold expressions are complex; fortunately type inference is able to deduce them. Nevertheless, it is instructive to study the types of fold functions and steppers. More importantly, it is essential to understand the typing aspects of fold in order to write down signatures of functions defined using fold and step.

Here is the FOLD signature, and a recapitulation of the entire Fold structure, with additional type annotations.

That’s a lot to swallow, so let’s walk through it one step at a time. First, we have the definition of type Fold.step.

As a fold proceeds over its arguments, it maintains two things: the accumulator, of type 'a, and the finishing function, of type 'b -> 'c. Each step in the fold is a function that takes those two pieces (i.e. 'a * ('b -> 'c) and does something to them (i.e. produces 'd). The result type of the step is completely left open to be filled in by type inference, as it is an arrow type that is capable of consuming the rest of the arguments to the fold.

A folder, of type Fold.t, is a function that consumes a single step.

Expanding out the type, we have:

This shows that the only thing a folder does is to hand its accumulator ('a) and finisher ('b -> 'c) to the next step ('a * ('b -> 'c) -> 'd). If SML had first-class polymorphism, we would write the fold type as follows.

This type definition shows that a folder had nothing to do with the rest of the fold, it only deals with the next step.

We now can understand the type of fold, which takes the initial value of the accumulator and the finishing function, and constructs a folder, i.e. a function awaiting the next step.

Continuing on, we have the type of step functions.

Expanding out the type a bit gives:

So, a step function takes the accumulator ('a1) and finishing function ('b -> 'c), which will be passed to it by the previous folder, and transforms them to a new folder. This new folder has a new accumulator ('a2) and the same finishing function.

Again, imagining that SML had first-class polymorphism makes the type clearer.

Thus, in essence, a step0 function is a wrapper around a function of type 'a1 -> 'a2, which is exactly what the definition of step0 does.

It is not much beyond step0 to understand step1.

A step1 function takes the accumulator ('a12) and finisher ('b -> 'c) passed to it by the previous folder and transforms them into a function that consumes the next argument ('a11) and produces a folder that will continue the fold with a new accumulator ('a2) and the same finisher.

With first-class polymorphism, a step1 function is more clearly seen as a wrapper around a binary function of type 'a11 * 'a12 -> 'a2.

The type of post is clear: it takes a folder with a finishing function that produces type 'c1, and a function of type 'c1 -> 'c2 to postcompose onto the folder. It returns a new folder with a finishing function that produces type 'c2.

We will return to lift0 after an example.

Let’s type check our simplest example, a variable-argument fold. Recall that we have a folder f and a stepper a defined as follows.

Since the accumulator and finisher are uninteresting, we’ll use some abbreviations to simplify things.

With these abbreviations, f and a have the following polymorphic types.

Suppose we want to type check

As a reminder, the fully parenthesized expression is

The observation that we will use repeatedly is that for any type z, if f: z fold and s: z step, then f s: z. So, if we want

then we must have

Applying the observation again, we must have

Applying the observation two more times leads to the following type derivation.

So, each application is a fold that consumes the next step, producing a fold of one smaller type.

One can expand some of the type definitions in f to see that it is indeed a function that takes four curried arguments, each one a step function.

This example shows why we must eta expand uses of fold and step0 to work around the value restriction and make folders and steppers polymorphic. The type of a fold function like f depends on the number of arguments, and so will vary from use to use. Similarly, each occurrence of an argument like a has a different type, depending on the number of remaining arguments.

This example also shows that the type of a folder, when fully expanded, is exponential in the number of arguments: there are as many nested occurrences of the fold type constructor as there are arguments, and each occurrence duplicates its type argument. One can observe this exponential behavior in a type checker that doesn’t share enough of the representation of types (e.g. one that represents types as trees rather than directed acyclic graphs).

Generalizing this type derivation to uses of fold where the accumulator and finisher are more interesting is straightforward. One simply includes the type of the accumulator, which may change, for each step, and the type of the finisher, which doesn’t change from step to step.

The lack of first-class polymorphism in SML causes problems if one wants to use a step in a first-class way. Consider the following double function, which takes a step, s, and produces a composite step that does s twice.

The definition of double is not type correct. The problem is that the type of a step depends on the number of remaining arguments but that the parameter s is not polymorphic, and so can not be used in two different positions.

Fortunately, we can define a function, lift0, that takes a monotyped step function and lifts it into a polymorphic step function. This is apparent in the type of lift0.

The following definition of double uses lift0, appropriately eta wrapped, to fix the problem.

With that definition of double in place, we can use it as in the following example.

Of course, we must eta wrap the call double in order to use its result, which is a step function, polymorphically.

For clarity and to avoid mistakes, it can be useful to hide the type of the accumulator in a fold. Reworking the simple variable-argument example to do this leads to the following.

The idea is to name the accumulator type and use opaque signature matching to make it abstract. This can prevent improper manipulation of the accumulator by client code and ensure invariants that the folder and stepper would like to maintain.

For a practical example of this technique, see ArrayLiteral.

Fold has a number of practical applications. Here are some of them.

There are a number of related techniques. Here are some of them.