Antisymmetry.hs

{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE ScopedTypeVariables #-}

module Test.Validity.Relations.Antisymmetry
    ( antisymmetricOnElemsWithEquality
    , antisymmetryOnGensWithEquality
    , antisymmetryOnGens
    , antisymmetryOnValid
    , antisymmetry
    , antisymmetryOnArbitrary
    ) where

import Data.GenValidity

import Test.QuickCheck

import Test.Validity.Utils

-- |
--
-- \[
--   Antisymmetric(\prec, \doteq)
--   \quad\equiv\quad
--   \forall a, b: ((a \prec b) \wedge (b \prec a)) \Rightarrow (a \doteq b)
-- \]
antisymmetricOnElemsWithEquality
    :: (a -> a -> Bool) -- ^ A relation
    -> (a -> a -> Bool) -- ^ An equivalence relation
    -> a
    -> a -- ^ Two elements
    -> Bool
antisymmetricOnElemsWithEquality func eq a b =
    (func a b && func b a) ===> (a `eq` b)

antisymmetryOnGensWithEquality
    :: Show a
    => (a -> a -> Bool) -> Gen (a, a) -> (a -> a -> Bool) -> Property
antisymmetryOnGensWithEquality func gen eq =
    forAll gen $ uncurry $ antisymmetricOnElemsWithEquality func eq

antisymmetryOnGens
    :: (Show a, Eq a)
    => (a -> a -> Bool) -> Gen (a, a) -> Property
antisymmetryOnGens func gen = antisymmetryOnGensWithEquality func gen (==)

-- |
--
-- prop> antisymmetryOnValid ((>) @Double)
-- prop> antisymmetryOnValid ((>=) @Double)
-- prop> antisymmetryOnValid ((<=) @Double)
-- prop> antisymmetryOnValid ((<) @Double)
-- prop> antisymmetryOnValid (Data.List.isPrefixOf @Double)
-- prop> antisymmetryOnValid (Data.List.isSuffixOf @Double)
-- prop> antisymmetryOnValid (Data.List.isInfixOf @Double)
-- prop> antisymmetryOnValid (Data.List.isSubsequenceOf @Double)
antisymmetryOnValid
    :: (Show a, Eq a, GenValid a)
    => (a -> a -> Bool) -> Property
antisymmetryOnValid func = antisymmetryOnGens func genValid

-- |
--
-- prop> antisymmetry ((>) @Int)
-- prop> antisymmetry ((>=) @Int)
-- prop> antisymmetry ((<=) @Int)
-- prop> antisymmetry ((<) @Int)
-- prop> antisymmetry (Data.List.isPrefixOf @Int)
-- prop> antisymmetry (Data.List.isSuffixOf @Int)
-- prop> antisymmetry (Data.List.isInfixOf @Int)
-- prop> antisymmetry (Data.List.isSubsequenceOf @Int)
-- prop> antisymmetry ((\x y -> even x && odd y) :: Int -> Int -> Bool)
antisymmetry
    :: (Show a, Eq a, GenUnchecked a)
    => (a -> a -> Bool) -> Property
antisymmetry func = antisymmetryOnGens func genUnchecked

-- |
--
-- prop> antisymmetryOnArbitrary ((>) @Int)
-- prop> antisymmetryOnArbitrary ((>=) @Int)
-- prop> antisymmetryOnArbitrary ((<=) @Int)
-- prop> antisymmetryOnArbitrary ((<) @Int)
-- prop> antisymmetryOnArbitrary (Data.List.isPrefixOf @Int)
-- prop> antisymmetryOnArbitrary (Data.List.isSuffixOf @Int)
-- prop> antisymmetryOnArbitrary (Data.List.isInfixOf @Int)
-- prop> antisymmetryOnArbitrary (Data.List.isSubsequenceOf @Int)
-- prop> antisymmetryOnArbitrary ((\x y -> even x && odd y) :: Int -> Int -> Bool)
antisymmetryOnArbitrary
    :: (Show a, Eq a, Arbitrary a)
    => (a -> a -> Bool) -> Property
antisymmetryOnArbitrary func = antisymmetryOnGens func arbitrary