Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require an Order instance for NonEmptyList's groupBy function #1964

Merged
merged 5 commits into from
Oct 13, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions core/src/main/scala/cats/data/NonEmptyList.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import cats.instances.list._
import cats.syntax.order._

import scala.annotation.tailrec
import scala.collection.immutable.TreeSet
import scala.collection.immutable.{ TreeMap, TreeSet }
import scala.collection.mutable
import scala.collection.mutable.ListBuffer
import scala.collection.{immutable, mutable}

/**
* A data type which represents a non empty list of A, with
Expand Down Expand Up @@ -325,24 +325,26 @@ final case class NonEmptyList[+A](head: A, tail: List[A]) {
*
* {{{
* scala> import cats.data.NonEmptyList
* scala> import cats.instances.boolean._
* scala> val nel = NonEmptyList.of(12, -2, 3, -5)
* scala> nel.groupBy(_ >= 0)
* res0: Map[Boolean, cats.data.NonEmptyList[Int]] = Map(false -> NonEmptyList(-2, -5), true -> NonEmptyList(12, 3))
* }}}
*/
def groupBy[B](f: A => B): Map[B, NonEmptyList[A]] = {
val m = mutable.Map.empty[B, mutable.Builder[A, List[A]]]
def groupBy[B](f: A => B)(implicit B: Order[B]): Map[B, NonEmptyList[A]] = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add to the scaladoc a brief description of why Order is required?

var m = TreeMap.empty[B, mutable.Builder[A, List[A]]](B.toOrdering)

for { elem <- toList } {
m.getOrElseUpdate(f(elem), List.newBuilder[A]) += elem
}
val b = immutable.Map.newBuilder[B, NonEmptyList[A]]
for { (k, v) <- m } {
val head :: tail = v.result // we only create non empty list inside of the map `m`
b += ((k, NonEmptyList(head, tail)))
val k = f(elem)

m.get(k) match {
case None => m += ((k, List.newBuilder[A] += elem))
case Some(builder) => builder += elem
}
}
b.result
}

m.map { case (k, v) => (k, NonEmptyList.fromListUnsafe(v.result)) }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we ascribe a type to this to make sure we are not converting to using hashCode and equals at the end?

 m.map { case (k, v) => (k, NonEmptyList.fromListUnsafe(v.result)) } : TreeMap[B, NonEmptyList[A]]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. One further thought. Shall we also change the return type to SortedMap? That would explain why we require an Order instance for B.

}
}

object NonEmptyList extends NonEmptyListInstances {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/scala/cats/syntax/list.scala
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ final class ListOps[A](val la: List[A]) extends AnyVal {
* }}}
*/
def toNel: Option[NonEmptyList[A]] = NonEmptyList.fromList(la)
def groupByNel[B](f: A => B): Map[B, NonEmptyList[A]] =
def groupByNel[B : Order](f: A => B): Map[B, NonEmptyList[A]] =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't the type here also be SortedMap?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it should. Working on it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well... current status: yak-shaving inside NonEmptyTraverse doctests, where SortedMap needs an Apply instance.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed something that addresses this. I've fixed the NonEmptyTraverse doctests by upcasting to a vanilla Map for which there's an Apply instance. I'm not completely satisfied with this approach, but it's the best I've got right now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think making an Apply and Traversable for SortedMap is probably out of scope, so I think that's okay.

toNel.fold(Map.empty[B, NonEmptyList[A]])(_.groupBy(f))
}