-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathEq.scala
More file actions
289 lines (255 loc) · 12.8 KB
/
Copy pathEq.scala
File metadata and controls
289 lines (255 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/*
* Copyright (c) 2015 Typelevel
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package cats.kernel
import cats.kernel.compat.scalaVersionSpecific.*
import java.util.UUID
import scala.collection.immutable.{BitSet, Queue, Seq, SortedMap, SortedSet}
import scala.concurrent.duration.{Duration, FiniteDuration}
import scala.util.{Failure, Success, Try}
import scala.{specialized => sp}
/**
* A type class used to determine equality between 2 instances of the same
* type. Any 2 instances `x` and `y` are equal if `eqv(x, y)` is `true`.
* Moreover, `eqv` should form an equivalence relation.
*/
trait Eq[@sp A] extends Any with Serializable { self =>
/**
* Returns `true` if `x` and `y` are equivalent, `false` otherwise.
*/
def eqv(x: A, y: A): Boolean
/**
* Returns `false` if `x` and `y` are equivalent, `true` otherwise.
*/
def neqv(x: A, y: A): Boolean = !eqv(x, y)
}
abstract class EqFunctions[E[T] <: Eq[T]] {
def eqv[@sp A](x: A, y: A)(implicit ev: E[A]): Boolean =
ev.eqv(x, y)
def neqv[@sp A](x: A, y: A)(implicit ev: E[A]): Boolean =
ev.neqv(x, y)
}
trait EqToEquivConversion {
/**
* Implicitly derive a `scala.math.Equiv[A]` from a `Eq[A]`
* instance.
*/
implicit def catsKernelEquivForEq[A](implicit ev: Eq[A]): Equiv[A] =
ev.eqv(_, _)
}
@suppressUnusedImportWarningForScalaVersionSpecific
object Eq
extends EqFunctions[Eq]
with EqToEquivConversion
with ScalaVersionSpecificOrderInstances
with instances.TupleOrderInstances
with OrderInstances1 {
/**
* Access an implicit `Eq[A]`.
*/
@inline final def apply[A](implicit ev: Eq[A]): Eq[A] = ev
/**
* Convert an implicit `Eq[B]` to an `Eq[A]` using the given
* function `f`.
*/
def by[@sp A, @sp B](f: A => B)(implicit ev: Eq[B]): Eq[A] =
(x, y) => ev.eqv(f(x), f(y))
/**
* Return an Eq that gives the result of the and of eq1 and eq2
* note this is idempotent
*/
def and[@sp A](eq1: Eq[A], eq2: Eq[A]): Eq[A] =
(x, y) => eq1.eqv(x, y) && eq2.eqv(x, y)
/**
* Return an Eq that gives the result of the or of this and that
* Note this is idempotent
*/
def or[@sp A](eq1: Eq[A], eq2: Eq[A]): Eq[A] =
(x, y) => eq1.eqv(x, y) || eq2.eqv(x, y)
/**
* Create an `Eq` instance from an `eqv` implementation.
*/
def instance[A](f: (A, A) => Boolean): Eq[A] = f(_, _)
/**
* An `Eq[A]` that delegates to universal equality (`==`).
*
* This can be useful for case classes, which have reasonable `equals`
* implementations
*/
def fromUniversalEquals[A]: Eq[A] = _ == _
/**
* Everything is the same
*/
def allEqual[A]: Eq[A] = (_, _) => true
/**
* This is a monoid that creates an Eq that
* checks that all equality checks pass
*/
def allEqualBoundedSemilattice[A]: BoundedSemilattice[Eq[A]] =
new BoundedSemilattice[Eq[A]] {
def empty = allEqual[A]
def combine(e1: Eq[A], e2: Eq[A]): Eq[A] = Eq.and(e1, e2)
override def combineAllOption(es: IterableOnce[Eq[A]]): Option[Eq[A]] =
if (es.iterator.isEmpty) None
else {
val materialized = es.iterator.toVector
Some((x, y) => materialized.forall(_.eqv(x, y)))
}
}
/**
* This is a monoid that creates an Eq that
* checks that at least one equality check passes
*/
def anyEqualSemilattice[A]: Semilattice[Eq[A]] =
new Semilattice[Eq[A]] {
def combine(e1: Eq[A], e2: Eq[A]): Eq[A] = Eq.or(e1, e2)
override def combineAllOption(es: IterableOnce[Eq[A]]): Option[Eq[A]] =
if (es.iterator.isEmpty) None
else {
val materialized = es.iterator.toVector
Some((x, y) => materialized.exists(_.eqv(x, y)))
}
}
implicit def catsKernelInstancesForBitSet: PartialOrder[BitSet] & Hash[BitSet] =
cats.kernel.instances.bitSet.catsKernelStdOrderForBitSet
implicit def catsKernelPartialOrderForSet[A]: PartialOrder[Set[A]] =
cats.kernel.instances.set.catsKernelStdPartialOrderForSet[A]
implicit def catsKernelOrderForEither[A: Order, B: Order]: Order[Either[A, B]] =
cats.kernel.instances.either.catsStdOrderForEither[A, B]
implicit def catsKernelInstancesForUnit: Order[Unit] & Hash[Unit] =
cats.kernel.instances.unit.catsKernelStdOrderForUnit
implicit def catsKernelInstancesForBoolean: Order[Boolean] & Hash[Boolean] =
cats.kernel.instances.boolean.catsKernelStdOrderForBoolean
implicit def catsKernelInstancesForByte: Order[Byte] & Hash[Byte] =
cats.kernel.instances.byte.catsKernelStdOrderForByte
implicit def catsKernelInstancesForShort: Order[Short] & Hash[Short] =
cats.kernel.instances.short.catsKernelStdOrderForShort
implicit def catsKernelInstancesForInt: Order[Int] & Hash[Int] = cats.kernel.instances.int.catsKernelStdOrderForInt
implicit def catsKernelInstancesForLong: Order[Long] & Hash[Long] =
cats.kernel.instances.long.catsKernelStdOrderForLong
implicit def catsKernelInstancesForBigInt: Order[BigInt] & Hash[BigInt] =
cats.kernel.instances.bigInt.catsKernelStdOrderForBigInt
implicit def catsKernelInstancesForBigDecimal: Order[BigDecimal] & Hash[BigDecimal] =
cats.kernel.instances.bigDecimal.catsKernelStdOrderForBigDecimal
implicit def catsKernelInstancesForDuration: Order[Duration] & Hash[Duration] =
cats.kernel.instances.duration.catsKernelStdOrderForDuration
implicit def catsKernelInstancesForFiniteDuration: Order[FiniteDuration] & Hash[FiniteDuration] =
cats.kernel.instances.all.catsKernelStdOrderForFiniteDuration
implicit def catsKernelInstancesForChar: Order[Char] & Hash[Char] =
cats.kernel.instances.char.catsKernelStdOrderForChar
implicit def catsKernelInstancesForSymbol: Order[Symbol] & Hash[Symbol] =
cats.kernel.instances.symbol.catsKernelStdOrderForSymbol
implicit def catsKernelInstancesForString: Order[String] & Hash[String] =
cats.kernel.instances.string.catsKernelStdOrderForString
implicit def catsKernelInstancesForUUID: Order[UUID] & Hash[UUID] =
cats.kernel.instances.uuid.catsKernelStdOrderForUUID
implicit def catsKernelInstancesForDouble: Order[Double] & Hash[Double] =
cats.kernel.instances.double.catsKernelStdOrderForDouble
implicit def catsKernelInstancesForFloat: Order[Float] & Hash[Float] =
cats.kernel.instances.float.catsKernelStdOrderForFloat
implicit def catsKernelOrderForOption[A: Order]: Order[Option[A]] =
cats.kernel.instances.option.catsKernelStdOrderForOption[A]
implicit def catsKernelOrderForList[A: Order]: Order[List[A]] =
cats.kernel.instances.list.catsKernelStdOrderForList[A]
implicit def catsKernelOrderForVector[A: Order]: Order[Vector[A]] =
cats.kernel.instances.vector.catsKernelStdOrderForVector[A]
implicit def catsKernelOrderForQueue[A: Order]: Order[Queue[A]] =
cats.kernel.instances.queue.catsKernelStdOrderForQueue[A]
implicit def catsKernelOrderForSortedSet[A: Order]: Order[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdOrderForSortedSet[A]
implicit def catsKernelOrderForFunction0[A: Order]: Order[() => A] =
cats.kernel.instances.function.catsKernelOrderForFunction0[A]
/**
* you may wish to do equality by making `implicit val eqT: Eq[Throwable] = Eq.allEqual`
* doing a fine grained equality on Throwable can make the code very execution
* order dependent
*/
implicit def catsStdEqForTry[A](implicit A: Eq[A], T: Eq[Throwable]): Eq[Try[A]] = {
case (Success(a), Success(b)) => A.eqv(a, b)
case (Failure(a), Failure(b)) => T.eqv(a, b)
case _ => false
}
}
private[kernel] trait OrderInstances0 extends PartialOrderInstances {
implicit def catsKernelOrderForSeq[A: Order]: Order[Seq[A]] =
cats.kernel.instances.seq.catsKernelStdOrderForSeq[A]
}
private[kernel] trait OrderInstances1 extends OrderInstances0 {
implicit def catsKernelOrderForSortedMap[K, V: Order]: Order[SortedMap[K, V]] =
cats.kernel.instances.sortedMap.catsKernelStdOrderForSortedMap[K, V]
}
private[kernel] trait PartialOrderInstances extends PartialOrderInstances1 {
implicit def catsKernelPartialOrderForOption[A: PartialOrder]: PartialOrder[Option[A]] =
cats.kernel.instances.option.catsKernelStdPartialOrderForOption[A]
implicit def catsKernelPartialOrderForList[A: PartialOrder]: PartialOrder[List[A]] =
cats.kernel.instances.list.catsKernelStdPartialOrderForList[A]
implicit def catsKernelPartialOrderForVector[A: PartialOrder]: PartialOrder[Vector[A]] =
cats.kernel.instances.vector.catsKernelStdPartialOrderForVector[A]
implicit def catsKernelPartialOrderForQueue[A: PartialOrder]: PartialOrder[Queue[A]] =
cats.kernel.instances.queue.catsKernelStdPartialOrderForQueue[A]
implicit def catsKernelPartialOrderForFunction0[A: PartialOrder]: PartialOrder[() => A] =
cats.kernel.instances.function.catsKernelPartialOrderForFunction0[A]
}
private[kernel] trait PartialOrderInstances0 extends HashInstances {
implicit def catsKernelPartialOrderForSeq[A: PartialOrder]: PartialOrder[Seq[A]] =
cats.kernel.instances.seq.catsKernelStdPartialOrderForSeq[A]
}
private[kernel] trait PartialOrderInstances1 extends PartialOrderInstances0 {
implicit def catsKernelPartialOrderForSortedMap[K, V: PartialOrder]: PartialOrder[SortedMap[K, V]] =
cats.kernel.instances.sortedMap.catsKernelStdPartialOrderForSortedMap[K, V]
}
private[kernel] trait HashInstances extends HashInstances0 {
implicit def catsKernelHashForSet[A]: Hash[Set[A]] = cats.kernel.instances.set.catsKernelStdHashForSet[A]
implicit def catsKernelHashForOption[A: Hash]: Hash[Option[A]] =
cats.kernel.instances.option.catsKernelStdHashForOption[A]
implicit def catsKernelHashForList[A: Hash]: Hash[List[A]] = cats.kernel.instances.list.catsKernelStdHashForList[A]
implicit def catsKernelHashForVector[A: Hash]: Hash[Vector[A]] =
cats.kernel.instances.vector.catsKernelStdHashForVector[A]
implicit def catsKernelHashForQueue[A: Hash]: Hash[Queue[A]] =
cats.kernel.instances.queue.catsKernelStdHashForQueue[A]
implicit def catsKernelHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](using Hash[A])
implicit def catsKernelHashForFunction0[A: Hash]: Hash[() => A] =
cats.kernel.instances.function.catsKernelHashForFunction0[A]
implicit def catsKernelHashForMap[K: Hash, V: Hash]: Hash[Map[K, V]] =
cats.kernel.instances.map.catsKernelStdHashForMap[K, V]
implicit def catsKernelHashForSortedMap[K: Hash, V: Hash]: Hash[SortedMap[K, V]] =
cats.kernel.instances.sortedMap.catsKernelStdHashForSortedMap[K, V]
implicit def catsKernelHashForEither[A: Hash, B: Hash]: Hash[Either[A, B]] =
cats.kernel.instances.either.catsStdHashForEither[A, B]
}
private[kernel] trait HashInstances0 extends EqInstances {
implicit def catsKernelHashForSeq[A: Hash]: Hash[Seq[A]] = cats.kernel.instances.seq.catsKernelStdHashForSeq[A]
}
private[kernel] trait EqInstances extends EqInstances0 {
implicit def catsKernelEqForOption[A: Eq]: Eq[Option[A]] = cats.kernel.instances.option.catsKernelStdEqForOption[A]
implicit def catsKernelEqForList[A: Eq]: Eq[List[A]] = cats.kernel.instances.list.catsKernelStdEqForList[A]
implicit def catsKernelEqForVector[A: Eq]: Eq[Vector[A]] = cats.kernel.instances.vector.catsKernelStdEqForVector[A]
implicit def catsKernelEqForQueue[A: Eq]: Eq[Queue[A]] = cats.kernel.instances.queue.catsKernelStdEqForQueue[A]
implicit def catsKernelEqForFunction0[A: Eq]: Eq[() => A] = cats.kernel.instances.function.catsKernelEqForFunction0[A]
implicit def catsKernelEqForMap[K, V: Eq]: Eq[Map[K, V]] = cats.kernel.instances.map.catsKernelStdEqForMap[K, V]
implicit def catsKernelEqForSortedMap[K, V: Eq]: Eq[SortedMap[K, V]] =
cats.kernel.instances.sortedMap.catsKernelStdEqForSortedMap[K, V]
implicit def catsKernelEqForEither[A: Eq, B: Eq]: Eq[Either[A, B]] =
cats.kernel.instances.either.catsStdEqForEither[A, B]
}
private[kernel] trait EqInstances0 {
implicit def catsKernelEqForSeq[A: Eq]: Eq[Seq[A]] = cats.kernel.instances.seq.catsKernelStdEqForSeq[A]
}