lib.lists.{findFirstIndex,commonPrefix}: init

[infinisil]

Description of changes

Adds two new functions:

• lib.lists.findFirstIndex :: (a -> bool) -> Any -> [a] -> (Int | Any): Find the first index in the list matching the specified predicate or return a default if no such element exists.

  lib.lists.findFirstIndex (x: x > 3) null [ 0 6 4 ]
  -> 1

• lib.lists.commonPrefix :: [ a ] -> [ a ] -> [ a ]: The common prefix of two lists:

  lib.lists.commonPrefix [ 1 2 3 4 ] [ 1 2 4 8 ]
  -> [ 1 2 ]

This is distantly part of the path library effort, in order to be able to work with lists of path components. Relates to #243511

This work is sponsored by Antithesis ✨

Things done

• Docs
• Tests

[fricklerhandwerk]

I like the minimality of all this, a lot.

[tjni]

Just brainstorming here: what do you think about extracting out findFirst into findFirstIndex and reusing that here? Pseudocode being:

commonPrefixLength list1 list2 =
    let pairs = zipLists list1 list2
    let firstDiffIndex = findFirstIndex ({ fst, snd }: fst != snd) pairs
    if firstDiffIndex was found then
        firstDiffIndex
    else
        length pairs

Not sure about the performance of this or if firstFindIndex is the best generalization of the foldl' idea you have.

[tjni]

Thinking about this a little more, the following can also be a route if commonPrefixLength is otherwise not too useful by itself (which I am unsure about but think it might be only useful as a helper function for commonPrefix):

We use your algorithm and create the more general:

findFirstWithIndex = predicate: list:
    return first { index, value } matching predicate

and then use that to define:

takeWhile = predicate: list:
    let sentinel = findFirstWithIndex (elem: !(predicate elem)) list in
    if sentinel != null then
        take sentinel.index list
    else
        list

and finally:

commonPrefix = list1: list2:
    takeWhile (predicate comparing list1[i] with list2[i])

where forming that last predicate depends on some design decisions (like does predicate accept the index, do we use zipLists, do we first get the shorter list and take over it explicitly).

[roberth]

findFirstWithIndex

This seems like a useful function to factor out.
To simplify it a bit, you could return just the index. That way you don't have to allocate the { index, value } attrset just to ignore value. You could call it findFirstIndex then.

[infinisil]

@tjni Nice idea! This turned out to work out really well since I was able to reuse a lot of code. I removed commonPrefixLength again, it's not really necessary to expose that, it's really just a helper function as you suggested. Instead findFirstIndex is now available :)

[fricklerhandwerk]

Very elegant, such compose, many wow.

[roberth]

[tjni]

Looks awesome!