Optimised list functions for doing index-related things
|LTS Haskell 20.15:||0.4.0.1@rev:2|
|Stackage Nightly 2022-11-17:||0.4.0.1@rev:2|
|Latest on Hackage:||0.4.0.1@rev:2|
Module documentation for 0.4.0.1
What is this
This is a library with lots of list functions that are related to indices. It has often-reinvented
setAt, etc, as well as indexed variants of functions from
izipWith). It has no dependencies, builds in about a second, and works on GHC from 7.4 to 8.0; the functions are optimised and benchmarked (for instance, the
zip [0..] idiom is usually twice as slow, and sometimes 20× as slow).
So, this library is intended to be the canonical place for index-related functions. You are encouraged to depend on this library instead of reinventing the functions, using
zip [0..], or using lens when all you need is a simple
ifoldr (not to mention that lens variants are usually 2–10 times slower for lists).
Why should you care
You shouldn’t, actually. This is a small library, it won’t change anyone’s life, and if you care about speed you probably shouldn’t be using lists anyway (unless you keep your fingers crossed and hope that fusion will kick in). So, consider it more of a public service announcement – “hey, just in case you ever need them, index-related functions live here”.
Data.List.Indexed was taken by IndexedList, which implements such exciting things as “counted lists” and “conic lists”. Nope, I’m not bitter at all. Okay, maybe a bit, even tho it’s completely unfair to IndexedList. Anyway:
And you can use functions from
Data.List by prepending
i to them. There’s also
indexed :: [a] -> [(Int,a)] and a family of functions for modifying the element at an index (
Watch out –
ifoldl has the index as the second parameter of the function:
ifoldl :: (b -> Int -> a -> b) -> b -> [a] -> b
That’s the same convention that containers and vector use. Other functions pass the index as the first argument, as expected.
ilist uses PVP Versioning.
The changelog is available on GitHub.
0.4.0.1 — May 7, 2020
- #7: Support GHC-8.10. Move from GHC-8.8.1 support to GHC-8.8.3.
0.4.0.0 — Dec 26, 2019
- Support GHC-8.8, GHC-8.6, GHC-8.4, GHC-8.2. Drop older GHC versions support.
- Update maintenance info.
ifindnow returns the index alongside with the value (same as in
izipWithM_have been generalised from
Applicative(which mimics what was done in base-4.9).