Why clojure collections don't implement ISeq interface directly?

Question

Every collection in clojure is said to be "sequable" but only list and cons are actually seqs:

user> (seq? {:a 1 :b 2})
false
user> (seq? [1 2 3])
false    

All other seq functions first convert a collection to a sequence and only then operate on it.

user> (class (rest {:a 1 :b 2}))
clojure.lang.PersistentArrayMap$Seq

I cannot do things like:

user> (:b (rest {:a 1 :b 2}))
nil
user> (:b (filter #(-> % val (= 1)) {:a 1 :b 1 :c 2}))
nil

and have to coerce back to concrete data type. This looks like bad design to me, but most likely I just don't get it as yet.

So, why clojure collections don't implement ISeq interface directly and all seq functions don't return an object of the same class as the input object?

Susie

Well, is a map a sequential container? (No, it isn't). You can iterate over the elements of a map in some sequence, but the map itself isn't sequential. I don't really agree with functions like filter - which conceptually don't require to have their input in any particular order - requiring their argument to be a seq, but it's not necessarily bad design. – Bassoon

@Cubic, vector is sequential container, so why it is not a seq?(edited the question). For maps and sets there is always an implicit order. This is why seq is defined on those. The question is, if ISeq is meaningful for maps, sets and vectors why does clojure need additional inner Seq classes for each collection? And why useless coercion back and forth? – Susie

@Cubic, BTW, if map were to implement ISeq directly, filter would not need to operate on seq. Kinda proves my point. – Susie

Answer 1

This has been discussed on the Clojure google group; see for example the thread map semantics from February of this year. I'll take the liberty of reusing some of the points I made in my message to that thread below while adding several new ones.

Before I go on to explain why I think the "separate seq" design is the correct one, I would like to point out that a natural solution for the situations where you'd really want to have an output similar to the input without being explicit about it exists in the form of the function fmap from the contrib library algo.generic. (I don't think it's a good idea to use it by default, however, for the same reasons for which the core library design is a good one.)

Overview

The key observation, I believe, is that the sequence operations like map, filter etc. conceptually divide into three separate concerns:

1. some way of iterating over their input;

2. applying a function to each element of the input;

3. producing an output.

Clearly 2. is unproblematic if we can deal with 1. and 3. So let's have a look at those.

Iteration

For 1., consider that the simplest and most performant way to iterate over a collection typically does not involve allocating intermediate results of the same abstract type as the collection. Mapping a function over a chunked seq over a vector is likely to be much more performant than mapping a function over a seq producing "view vectors" (using subvec) for each call to next; the latter, however, is the best we can do performance-wise for next on Clojure-style vectors (even in the presence of RRB trees, which are great when we need a proper subvector / vector slice operation to implement an interesting algorithm, but make traversals terrifying slow if we used them to implement next).

In Clojure, specialized seq types maintain traversal state and extra functionality such as (1) a node stack for sorted maps and sets (apart from better performance, this has better big-O complexity than traversals using dissoc / disj!), (2) current index + logic for wrapping leaf arrays in chunks for vectors, (3) a traversal "continuation" for hash maps. Traversing a collection through an object like this is simply faster than any attempt at traversing through subvec / dissoc / disj could be.

Suppose, however, that we're willing to accept the performance hit when mapping a function over a vector. Well, let's try filtering now:

(->> some-vector (map f) (filter p?))

There's a problem here -- there's no good way to remove elements from a vector. (Again, RRB trees could help in theory, but in practice all the RRB slicing and concatenating involved in producing "real vector" for filtering operations would absolutely destroy performance.)

Here's a similar problem. Consider this pipeline:

(->> some-sorted-set (filter p?) (map f) (take n))

Here we benefit from laziness (or rather, from the ability to stop filtering and mapping early; there's a point involving reducers to be made here, see below). Clearly take could be reordered with map, but not with filter.

The point is that if it's ok for filter to convert to seq implicitly, then it is also ok for map; and similar arguments can be made for other sequence functions. Once we've made the argument for all -- or nearly all -- of them, it becomes clear that it also makes sense for seq to return specialized seq objects.

Incidentally, filtering or mapping a function over a collection without producing a similar collection as a result is very useful. For example, often we care only about the result of reducing the sequence produced by a pipeline of transformations to some value or about calling a function for side effect at each element. For these scenarios, there is nothing whatsoever to be gained by maintaining the input type and quite a lot to be lost in performance.

Producing an output

As noted above, we do not always want to produce an output of the same type as the input. When we do, however, often the best way to do so is to do the equivalent of pouring a seq over the input into an empty output collection.

In fact, there is absolutely no way to do better for maps and sets. The fundamental reason is that for sets of cardinality greater than 1 there is no way to predict the cardinality of the output of mapping a function over a set, since the function can "glue together" (produce the same outputs for) arbitrary inputs.

Additionally, for sorted maps and sets there is no guarantee that the input set's comparator will be able to deal with outputs from an arbitrary function.

So, if in many cases there is no way to, say, map significantly better than by doing a seq and an into separately, and considering how both seq and into make useful primitives in their own right, Clojure makes the choice of exposing the useful primitives and letting users compose them. This lets us map and into to produce a set from a set, while leaving us the freedom to not go on to the into stage when there is no value to be gained by producing a set (or another collection type, as the case may be).

Not all is seq; or, consider reducers

Some of the problems with using the collection types themselves when mapping, filtering etc. don't apply when using reducers.

The key difference between reducers and seqs is that the intermediate objects produced by clojure.core.reducers/map and friends only produce "descriptor" objects that maintain information on what computations need to be performed in the event that the reducer is actually reduced. Thus, individual stages of the computation can be merged.

This allows us to do things like

(require '[clojure.core.reducers :as r])

(->> some-set (r/map f) (r/filter p?) (into #{}))

Of course we still need to be explicit about our (into #{}), but this is just a way of saying "the reducers pipeline ends here; please produce the result in the form of a set". We could also ask for a different collection type (a vector of results perhaps; note that mapping f over a set may well produce duplicate results and we may in some situations wish to preserve them) or a scalar value ((reduce + 0)).

Summary

The main points are these:

1. the fastest way to iterate over a collection typically doesn't involve produce intermediate results similar to the input;

2. seq uses the fastest way to iterate;

3. the best approach to transforming a set by mapping or filtering involves using a seq-style operation, because we want to iterate very fast while accumulating an output;

4. thus seq makes a great primitive;

5. map and filter, in their choice to deal with seqs, depending on the scenario, may avoid performance penalties without upsides, benefit from laziness etc., yet can still be used to produce a collection result with into;

6. thus they too make great primitives.

Some of these points may not apply to a statically typed language, but of course Clojure is dynamic. Additionally, when we do want to a return that matches input type, we're simply forced to be explicit about it and that, in itself, may be viewed as a good thing.

Helios

Aha! 1) A sequence is a protocol (small 'p') for an immutable iterator. 2) An iterator, mutable or not, has to embody some scheme for going through the underlying collection and know where it is in it (state). 3) Just as in C++, Java, or C#, it must be able to be a different object, wrapping the collection. 4) Immutable collections give you the option of using a collection as its own iterator (state), but it isn't necessarily a good choice. – Lukin

Thanks for the detailed answer. I think your "Summary" is a bit repetitive with exclusive focus on performance. How about adding explicit points on lazy evaluation and the fact that in some cases the "within class" output is either meaningless or not desirable, like (map + #{1 2 3} '(1 2 3)) or (map #(mod % 2) #{2 6}). – Susie

These are all good arguments for having a general sequence interface with many implementations serving different performance scenarios. So fine: rest on a vector should not return a vector. But why can't vector itself be an ISeq whose rest operation returns the same as (rest (seq myvector))? – Frear

The only rational I can fathom is that the rest method of an ISeq is intended to always return the same concrete type. If that's not the case, though, I'm not hearing any good reason why vectors and maps shouldn't be sequences directly. – Frear

And what would be the value of making vectors and maps into ISeq instances, given the fact that all Clojure collections can already be passed to map, first etc. directly, without explicit calls to seq? For example, why would it make sense to repeat the next implementation of chunked seqs inside PersistentVector itself when implementing Seqable solves the ease of use issue in a simple, DRY and efficient fashion? DRY provides an argument against doing this; what are the arguments in favour of doing it (assuming we've accepted that rest cannot always return the original type)? – Recalescence

Answer 2

Sequences are a logical list abstraction. They provide access to a (stable) ordered sequence of values. They are implemented as views over collections (except for lists where the concrete interface matches the logical interface). The sequence (view) is a separate data structure that refers into the collection to provide the logical abstraction.

Sequence functions (map, filter, etc) take a "seqable" thing (something which can produce a sequence), call seq on it to produce the sequence, and then operate on that sequence, returning a new sequence. It is up to you whether you need to or how to re-collect that sequence back into a concrete collection. While vectors and lists are ordered, sets and maps are not and thus sequences over these data structures must compute and retain the order outside the collection.

Specialized functions like mapv, filterv, reduce-kv allow you to stay "in the collection" when you know you want the operation to return a collection at the end instead of sequence.

Preventer

Answer 3

Seqs are ordered structures, whereas maps and sets are unordered. Two maps that are equal in value may have a different internal ordering. For example:

user=> (seq (array-map :a 1 :b 2))
([:a 1] [:b 2])
user=> (seq (array-map :b 2 :a 1))
([:b 2] [:a 1])

It makes no sense to ask for the rest of a map, because it's not a sequential structure. The same goes for a set.

So what about vectors? They're sequentially ordered, so we could potentially map across a vector, and indeed there is such a function: mapv.

You may well ask: why is this not implicit? If I pass a vector to map, why doesn't it return a vector?

Well, first that would mean making an exception for ordered structures like vectors, and Clojure isn't big on making exceptions.

But more importantly you'd lose one of the most useful properties of seqs: laziness. Chaining together seq functions, such as map and filter is a very common operation, and without laziness this would be much less performant and far more memory-intensive.

Massimiliano

@OpenLearner Chaining them together means to call one function on the output of the other. So for instance, you could chain them like this: (map #(+ 2 %) (filter even? [1 2 3 4])). Laziness ensures that the functions won't materialize intermediate sequences in memory. This can be important for more complex chains and longer sequences. – Guessrope

Answer 4

The collection classes follow a factory pattern i.e instead of implementing ISeq they implement Sequable i.e you can create a ISeq from the collection but the collection itself is not an ISeq.

Now even if these collections implemented ISeq directly I am not sure how that would solve your problem of having general purpose sequence functions that would return the original object, as that would not make sense at all as these general purpose functions are supposed to work on ISeq, they have no idea about which object gave them this ISeq

Example in java:

interface ISeq {
    ....
}

class A implements ISeq {

}

class B implements ISeq {

}

static class Helpers {
    /*
        Filter can only work with ISeq, that's what makes it general purpose.
        There is no way it could return A or B objects.
    */
    public static ISeq filter(ISeq coll, ...) { } 
    ...
}

Sherlock