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

Add comparison method in Order companion object #2100

Merged
merged 2 commits into from
Dec 17, 2017
Merged
Show file tree
Hide file tree
Changes from all 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
3 changes: 3 additions & 0 deletions kernel/src/main/scala/cats/kernel/Order.scala
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ abstract class OrderFunctions[O[T] <: Order[T]] extends PartialOrderFunctions[O]

def max[@sp A](x: A, y: A)(implicit ev: O[A]): A =
ev.max(x, y)

def comparison[@sp A](x: A, y: A)(implicit ev: O[A]): Comparison =
ev.comparison(x, y)
}

trait OrderToOrderingConversion {
Expand Down
21 changes: 20 additions & 1 deletion tests/src/test/scala/cats/tests/OrderSuite.scala
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package cats
package tests


import Helpers.Ord
import cats.kernel.laws.discipline.OrderTests

class OrderSuite extends CatsSuite {
Expand All @@ -15,6 +15,25 @@ class OrderSuite extends CatsSuite {
checkAll("Double", OrderTests[Double].order)
checkAll("Float", OrderTests[Float].order)
checkAll("Long", OrderTests[Long].order)

test("order ops syntax"){
forAll { (i: Ord, j: Ord) =>
(i compare j) should ===(Order.compare(i, j))
(i min j) should ===(Order.min(i, j))
(i max j) should === (Order.max(i, j))
(i comparison j) should ===(Order.comparison(i, j))

// partial order syntax should also work when an Order instance exists
(i > j) should ===(PartialOrder.gt(i, j))
(i >= j) should ===(PartialOrder.gteqv(i, j))
(i < j) should ===(PartialOrder.lt(i, j))
(i <= j) should ===(PartialOrder.lteqv(i, j))
(i partialCompare j) should ===(PartialOrder.partialCompare(i, j))
(i tryCompare j) should ===(PartialOrder.tryCompare(i, j))
(i pmin j) should ===(PartialOrder.pmin(i, j))
(i pmax j) should ===(PartialOrder.pmax(i, j))
}
}
}

object OrderSuite {
Expand Down
28 changes: 26 additions & 2 deletions tests/src/test/scala/cats/tests/PartialOrderSuite.scala
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
package cats
package tests


import Helpers.POrd
import org.scalatest.Assertion

class PartialOrderSuite extends CatsSuite {

/**
* Check that two partial compare results are "the same".
* This works around the fact that `NaN` is not equal to itself.
*/
def checkPartialCompare(res1: Double, res2: Double): Assertion = {
(res1 == res2 || (res1.isNaN && res2.isNaN)) should ===(true)
}

{
Invariant[PartialOrder]
Contravariant[PartialOrder]
}

test("companion object syntax") {
forAll { (i: Int, j: Int) =>
PartialOrder.partialCompare(i, j) should ===(catsKernelStdOrderForInt.partialCompare(i, j))
checkPartialCompare(PartialOrder.partialCompare(i, j), catsKernelStdOrderForInt.partialCompare(i, j))
PartialOrder.tryCompare(i, j) should ===(catsKernelStdOrderForInt.tryCompare(i, j))
PartialOrder.pmin(i, j) should ===(catsKernelStdOrderForInt.pmin(i, j))
PartialOrder.pmax(i, j) should ===(catsKernelStdOrderForInt.pmax(i, j))
Expand All @@ -21,6 +31,20 @@ class PartialOrderSuite extends CatsSuite {
PartialOrder.gt(i, j) should ===(catsKernelStdOrderForInt.gt(i, j))
}
}

test("partial order ops syntax") {
forAll { (i: POrd, j: POrd) =>
(i > j) should ===(PartialOrder.gt(i, j))
(i >= j) should ===(PartialOrder.gteqv(i, j))
(i < j) should ===(PartialOrder.lt(i, j))
(i <= j) should ===(PartialOrder.lteqv(i, j))

checkPartialCompare(i partialCompare j, PartialOrder.partialCompare(i, j))
(i tryCompare j) should ===(PartialOrder.tryCompare(i, j))
(i pmin j) should ===(PartialOrder.pmin(i, j))
(i pmax j) should ===(PartialOrder.pmax(i, j))
}
}
}

object PartialOrderSuite {
Expand Down