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.

Sign up for GitHub

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

Jump to bottom

Remove Order constraint from Hash instance for Map #3126

Merged
merged 4 commits into from
Nov 6, 2019
Merged

Remove Order constraint from Hash instance for Map #3126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f785937
Hash[Map[K, V]] has unnecessary constraint #3039
vasiliybondarenko Sep 13, 2019
5369df1
fix binary compatibility
larsrh Oct 5, 2019
1194733
Simplify names, adjust deprecation messages
travisbrown Nov 5, 2019
c1b48bb
Make bincompat-only auxiliary constructor package-private
travisbrown Nov 5, 2019
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
16 changes: 12 additions & 4 deletions core/src/main/scala/cats/instances/sortedSet.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ trait SortedSetInstances extends SortedSetInstances1 {
private[instances] trait SortedSetInstances1 {
@deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet", "2.0.0-RC2")
private[instances] def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])

@deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdSemilatticeForSortedSet", "2.0.0-RC2")
def catsKernelStdSemilatticeForSortedSet[A: Order]: BoundedSemilattice[SortedSet[A]] =
Expand All @@ -93,8 +93,12 @@ private[instances] trait SortedSetInstancesBinCompat0 {

private[instances] trait SortedSetInstancesBinCompat1 extends LowPrioritySortedSetInstancesBinCompat1 {
// TODO: Remove when this is no longer necessary for binary compatibility.
implicit override def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
// Note that the overrides here and below are only necessary because the
// definitions in `SortedSetInstances1` conflict with the ones in
// `cats.kernel.instances.SortedSetInstances`. Both are inherited here, so
// we have to "bubble" the "correct" ones up to the appropriate place.
implicit override def catsKernelStdHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])
}

private[instances] trait LowPrioritySortedSetInstancesBinCompat1
Expand All @@ -103,8 +107,12 @@ private[instances] trait LowPrioritySortedSetInstancesBinCompat1
implicit override def catsKernelStdOrderForSortedSet[A: Order]: Order[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdOrderForSortedSet[A]

implicit override def catsKernelStdHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])

@deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet", "2.0.0-RC2")
override def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])
}

@deprecated("Use cats.kernel.instances.SortedSetHash", "2.0.0-RC2")
Expand Down
15 changes: 11 additions & 4 deletions kernel/src/main/scala/cats/kernel/instances/SortedSetInstances.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
package cats.kernel
package instances

import cats.kernel.{BoundedSemilattice, Hash, Order}
import scala.collection.immutable.SortedSet

trait SortedSetInstances extends SortedSetInstances1 {
implicit def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
@deprecated("Use catsKernelStdHashForSortedSet override without Order", "2.1.0")
def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
new SortedSetHash[A]

implicit def catsKernelStdHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
new SortedSetHash[A]
}

Expand All @@ -28,9 +31,13 @@ class SortedSetOrder[A: Order] extends Order[SortedSet[A]] {
StaticMethods.iteratorEq(s1.iterator, s2.iterator)
}

class SortedSetHash[A: Order: Hash] extends Hash[SortedSet[A]] {
// FIXME use context bound in 3.x
class SortedSetHash[A](implicit hashA: Hash[A]) extends Hash[SortedSet[A]] {
import scala.util.hashing.MurmurHash3._

@deprecated("Use the constructor _without_ Order instead, since Order is not required", "2.1.0")
private[instances] def this(o: Order[A], h: Hash[A]) = this()(h)

// adapted from [[scala.util.hashing.MurmurHash3]],
// but modified standard `Any#hashCode` to `ev.hash`.
def hash(xs: SortedSet[A]): Int = {
Expand All @@ -50,7 +57,7 @@ class SortedSetHash[A: Order: Hash] extends Hash[SortedSet[A]] {
finalizeHash(h, n)
}
override def eqv(s1: SortedSet[A], s2: SortedSet[A]): Boolean =
StaticMethods.iteratorEq(s1.iterator, s2.iterator)(Order[A])
StaticMethods.iteratorEq(s1.iterator, s2.iterator)(Eq[A])
}

class SortedSetSemilattice[A: Order] extends BoundedSemilattice[SortedSet[A]] {
Expand Down