[core libraries] Rename NonEmpty.groupWith/sortWIth to *On*

[Carter Schonwald]

Hello Philip, clc gets / reads libraries anyways, no need to double email :
)

perhaps i'm missing something, are we talking about the specifics of the
implementations while stilling having the same observable pure results, OR
something different?

When does each have a clear performance win?

at least from my native english speaker perspective, sortWith is better
grammar.  Are you describing a choice of performance characteristics
related to  *On vs *With functions?

also, could you spell out which reference implementations of which
convention enshrine which meanings you have in mind?

I dont see a good reason to change the names that are provided from one to
the other. Are you merely making the case that both styles should be
exported from certain places, and that a particular choice of evaluation
trade offs be enshrined by the respective naming convention?


please spell this out more concretely, i'm not able to decode what you mean
unambiguiously. Just changing the names of some functions in base in
isolation breaks code for no reason, so if you are arguing for that, i'm
gonna say nope :)

On Wed, Feb 12, 2020 at 12:58 PM Philip Hazelden <philip.hazelden at gmail.com>
wrote:

> Hi,
>
> I'm referring to these functions: `sortWith` `groupWith` `groupAllWith`
> `groupWith1` `groupAllWith1`.
>
> The `On` suffix is more common for such things, and I anticipate it's what
> most users will normally expect them to be named.
>
> Additionally, the name `groupWith` is potentially misleading. That name is
> also used in GHC.Exts[1], for a function with the same type signature but
> different semantics. `GHC.Exts.groupWith` sorts its input list, unlike
> `NonEmpty.groupWith` or `Data.List.Extra.groupOn`. (In NonEmpty, we have
> `groupAllWith` for group-with-sort. So we have three names, two semantics,
> and no consistency.)
>
> According to https://github.com/ekmett/semigroups/pull/52, `With` was
> chosen because:
>
> > The preferred vocabulary for On here is With to match the combinators in
> GHC.Exts from the "comprehensive comprehensions" paper. That'd make it so
> that if you use these with comprehensive comprehensions turned on and
> RebindableSyntax turned on then you'd get these combinators.
>
> But I don't see anything in the docs which suggests that the
> TransformListComp extension[2] uses these functions implicitly, or
> interacts with RebindableSyntax[3]. So perhaps I'm missing something, but
> my guess is this is no longer a concern.
>
> The case for `sortWith` is weaker, since it might trip people up but it
> won't introduce unexpected semantics. There's also a counter argument in
> https://gitlab.haskell.org/ghc/ghc/issues/12044. `Data.List.sortOn` only
> computes the mapping function once for each element, while
> `GHC.Exts.sortWith` computes it every time it does a comparison but uses
> fewer allocations. `Data.NonEmpty.sortWith` acts like the latter. My
> suggestion would be to replace it with a `sortOn` implemented like
> `Data.List.sortOn`, but I also don't think it would be terrible to have
> both, or even to just rename and leave this small inconsistency. If there's
> no agreement on this function, I think it would be worth renaming the group
> functions anyway.
>
> And so I propose, in descending order of how much I care:
>
> 1. Rename the group functions to be named "On" instead of "With".
>
> 2. Rename `sortWith` to `sortOn` In the case of `sortWith`, also
> reimplement it as
>
> 3. Reimplement `sortOn` as
>
>     sortOn :: Ord b => (a -> b) -> NonEmpty a -> NonEmpty a
>     sortOn = fmap snd . sortBy (comparing fst) . fmap (\x -> let y = f x
> in y `seq` (y, x))
>
> I assume the process here would be to leave the existing names for a time
> with deprecation warnings, and then remove them a few versions down the
> line.
>
> [1]
> https://hackage.haskell.org/package/base-4.12.0.0/docs/GHC-Exts.html#v:groupWith
> [2]
> https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/glasgow_exts.html#extension-TransformListComp
> [3]
> https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/glasgow_exts.html#extension-RebindableSyntax
>
> Best,
> Phil
>
> --
> You received this message because you are subscribed to the Google Groups
> "haskell-core-libraries" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to haskell-core-libraries+unsubscribe at googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/haskell-core-libraries/CALB5dS-5qKjK6rmvFg2TuZ_3HvPtPyuGzsTrVO8adAnX1zovdg%40mail.gmail.com
> <https://groups.google.com/d/msgid/haskell-core-libraries/CALB5dS-5qKjK6rmvFg2TuZ_3HvPtPyuGzsTrVO8adAnX1zovdg%40mail.gmail.com?utm_medium=email&utm_source=footer>
> .
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/libraries/attachments/20200213/005d4104/attachment.html>