Agda.Utils.List

Append a single element at the end. Time: O(length); use only on small lists.

Case distinction for lists, with list first. O(1).

Cf. ifNull.

Case distinction for lists, with list first. O(1).

Cf. ifNull.

Case distinction for lists, with list last. O(1).

Head function (safe). Returns a default value on empty lists. O(1).

headWithDefault 42 []      = 42
headWithDefault 42 [1,2,3] = 1

Tail function (safe). O(1).

Tail function (safe). Returns a default list on empty lists. O(1).

Last element (safe). O(n).

Last element (safe). Returns a default list on empty lists. O(n).

Last element of non-empty list (safe). O(n). last1 a as = last (a : as)

Last two elements (safe). O(n).

last2' x y zs computes the last two elements of x:y:zs. O(n).

Opposite of cons (:), safe. O(1).

Maybe cons. O(1). mcons ma as = maybeToList ma ++ as

init and last in one go, safe. O(n).

init and last of non-empty list, safe. O(n). initLast1 a as = (init (a:as), last (a:as)

init of non-empty list, safe. O(n). init1 a as = init (a:as)

init, safe. O(n).

init, safe. O(n).

Lookup function (safe). O(min n index).

A variant of !! that might provide more informative error messages if the index is out of bounds.

Precondition: The index should not be out of bounds.

Lookup function with default value for index out of range. O(min n index).

The name is chosen akin to genericIndex.

Find an element satisfying a predicate and return it with its index. O(n) in the worst case, e.g. findWithIndex f xs = Nothing.

TODO: more efficient implementation!?

A generalised variant of elemIndex. O(n).

downFrom n = [n-1,..1,0]. O(n).

Update the first element of a list, if it exists. O(1).

Update the last element of a list, if it exists. O(n).

Update nth element of a list, if it exists. O(min index n).

Precondition: the index is >= 0.

splitExactlyAt n xs = Just (ys, zs) iff xs = ys ++ zs and genericLength ys = n.

Drop from the end of a list. O(length).

dropEnd n = reverse . drop n . reverse

Forces the whole list even for n==0.

Split off the largest suffix whose elements satisfy a predicate. O(n).

spanEnd p xs = (ys, zs) where xs = ys ++ zs and all p zs and maybe True (not . p) (lastMaybe yz).

Breaks a list just after an element satisfying the predicate is found.

>>> breakAfter1 even 1 [3,5,2,4,7,8](1 :| [3,5,2],[4,7,8])

Breaks a list just after an element satisfying the predicate is found.

>>> breakAfter even [1,3,5,2,4,7,8]([1,3,5,2],[4,7,8])

A generalized version of takeWhile. (Cf. mapMaybe vs. filter). @O(length . takeWhileJust f).

takeWhileJust f = fst . spanJust f.

A generalized version of span. O(length . fst . spanJust f).

Partition a list into Nothings and Justs. O(n).

partitionMaybe f = partitionEithers . map ( a -> maybe (Left a) Right (f a))

Note: mapMaybe f = snd . partitionMaybe f.

Like filter, but additionally return the last partition of the list where the predicate is False everywhere. O(n).

Like mapMaybe, but additionally return the last partition of the list where the function always returns Nothing. O(n).

Sublist relation.

dropFrom marker xs drops everything from xs starting with (and including) marker.

If the marker does not appear, the string is returned unchanged.

The following two properties hold provided marker has no overlap with xs:

  dropFrom marker (xs ++ marker ++ ys) == xs
  dropFrom marker xs == xs

All ways of removing one element from a list. O(n²).

Chop up a list in chunks of a given length. O(n).

Chop a list at the positions when the predicate holds. Contrary to wordsBy, consecutive separator elements will result in an empty segment in the result. O(n).

intercalate [x] (chopWhen (== x) xs) == xs

Check membership for the same list often. Use partially applied to create membership predicate hasElem xs :: a -> Bool.

• First time: O(n log n) in the worst case.

• Subsequently: O(log n).

Specification: hasElem xs == (elem xs).

Check whether a list is sorted. O(n).

Assumes that the Ord instance implements a partial order.

Check whether all consecutive elements of a list satisfy the given relation. O(n).

Check whether all elements in a list are distinct from each other. Assumes that the Eq instance stands for an equivalence relation.

O(n²) in the worst case distinct xs == True.

An optimised version of distinct. O(n log n).

Precondition: The list's length must fit in an Int.

Returns an (arbitrary) representative for each list element that occurs more than once. O(n log n).

Remove the first representative for each list element. Thus, returns all duplicate copies. O(n log n).

allDuplicates xs == sort $ xs \ nub xs.

Partition a list into first and later occurrences of elements (modulo some quotient given by a representation function).

Time: O(n log n).

Specification:

nubAndDuplicatesOn f xs = (ys, xs List.\\ ys)
  where ys = nubOn f xs

Efficient variant of nubBy for lists, using a set to store already seen elements. O(n log n)

Specification:

nubOn f xs == 'nubBy' ((==) `'on'` f) xs.

A variant of nubOn that is parametrised by a function that is used to select which element from a group of equal elements that is returned. The returned elements keep the order that they had in the input list.

Precondition: The length of the input list must be at most maxBound :: Int.

Efficient variant of nubBy for finite lists. O(n log n).

uniqOn f == 'List.sortBy' (compare `'on'` f) . 'nubBy' ((==) `'on'` f)

If there are several elements with the same f-representative, the first of these is kept.

Checks if all the elements in the list are equal. Assumes that the Eq instance stands for an equivalence relation. O(n).

Non-efficient, monadic nub. O(n²).

Requires both lists to have the same length. O(n).

Otherwise, Nothing is returned.

Like zipWith but keep the rest of the second list as-is (in case the second list is longer). O(n).

  zipWithKeepRest f as bs == zipWith f as bs ++ drop (length as) bs

Implemented using tree recursion, don't run me at home! O(3^(min n m)).

Implemented using dynamic programming and Data.Array. O(n*m).