diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 Daniel Mendler + +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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/special-values.cabal b/special-values.cabal new file mode 100644 --- /dev/null +++ b/special-values.cabal @@ -0,0 +1,42 @@ +-- This file has been generated from package.yaml by hpack version 0.18.1. +-- +-- see: https://github.com/sol/hpack + +name: special-values +version: 0.1.0.0 +synopsis: Typeclass providing special values +description: Special values are provided by a SpecialValues typeclass. Those can be used for example by QuickCheck, see quickcheck-special. +category: Testing +homepage: https://github.com/minad/special-values#readme +bug-reports: https://github.com/minad/special-values/issues +author: Daniel Mendler +maintainer: Daniel Mendler +copyright: 2017 Daniel Mendler +license: MIT +license-file: LICENSE +tested-with: GHC == 7.2.2, GHC == 7.4.2, GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.3, GHC == 8.0.1 +build-type: Simple +cabal-version: >= 1.10 + +source-repository head + type: git + location: https://github.com/minad/special-values + +library + hs-source-dirs: + src + ghc-options: -Wall + build-depends: + base < 6 + , bytestring >= 0.9 && < 0.11 + , scientific >= 0.2 && < 0.4 + , text >= 0.7 && < 1.3 + , ieee754 >= 0.8 && < 0.9 + if impl(ghc < 7.10) + build-depends: + nats >= 1 + exposed-modules: + Data.SpecialValues + other-modules: + Paths_special_values + default-language: Haskell2010 diff --git a/src/Data/SpecialValues.hs b/src/Data/SpecialValues.hs new file mode 100644 --- /dev/null +++ b/src/Data/SpecialValues.hs @@ -0,0 +1,115 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Data.SpecialValues +-- Copyright : Daniel Mendler (c) 2017 +-- License : MIT (see the file LICENSE) +-- +-- Maintainer : mail@daniel-mendler.de +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------- + +{-# LANGUAGE FlexibleInstances #-} +module Data.SpecialValues ( + SpecialValues(..), +) where + +import Data.Int +import Data.Word +import Data.Ratio +import Numeric.Natural (Natural) +import Numeric.IEEE +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BL +import qualified Data.Scientific as Scientific +import qualified Data.Text as TS +import qualified Data.Text.Lazy as TL + +-- | Provides a list of special values or edge cases +class SpecialValues a where + -- | Finite list of special values + specialValues :: [a] + +instance SpecialValues Int where specialValues = specialInt +instance SpecialValues Int8 where specialValues = specialInt +instance SpecialValues Int16 where specialValues = specialInt +instance SpecialValues Int32 where specialValues = specialInt +instance SpecialValues Int64 where specialValues = specialInt +instance SpecialValues Word where specialValues = specialBoundedEnum +instance SpecialValues Word8 where specialValues = specialBoundedEnum +instance SpecialValues Word16 where specialValues = specialBoundedEnum +instance SpecialValues Word32 where specialValues = specialBoundedEnum +instance SpecialValues Word64 where specialValues = specialBoundedEnum +instance SpecialValues Bool where specialValues = [True, False] +instance SpecialValues () where specialValues = [()] +instance SpecialValues Float where specialValues = specialIEEE +instance SpecialValues Double where specialValues = specialIEEE + +instance SpecialValues Integer where + specialValues = [ 0, 1, -1, 2, -2 + , fromIntegral (minBound :: Int64) - 1 + , fromIntegral (maxBound :: Int64) + 1 + , fromIntegral (maxBound :: Word64) + 1 + ] + +instance SpecialValues Natural where + specialValues = [ 0, 1, 2, fromIntegral (maxBound :: Word64) + 1 ] + +instance SpecialValues Rational where + specialValues = [ 0, 1, -1, 2, -2, 0 % 1, - 0 % 1] + +instance SpecialValues Char where + specialValues = specialBoundedEnum ++ "\0\a\b\f\n\r\t\v\'\"\\aä " + +instance SpecialValues TS.Text where + specialValues = fmap TS.pack specialValues + +instance SpecialValues TL.Text where + specialValues = fmap TL.pack specialValues + +instance SpecialValues BS.ByteString where + specialValues = fmap BS.pack specialValues + +instance SpecialValues BL.ByteString where + specialValues = fmap BL.pack specialValues + +instance SpecialValues Scientific.Scientific where + specialValues = [ 0 + , 1, negate 1 + , Scientific.scientific 1 (-1000), negate $ Scientific.scientific 1 (-1000) + , Scientific.scientific 1 1000, negate $ Scientific.scientific 1 1000 + ] + +instance SpecialValues a => SpecialValues [a] where + specialValues = [[], specialValues] + +instance SpecialValues a => SpecialValues (Maybe a) where + specialValues = Nothing : fmap Just specialValues + +instance (SpecialValues a, SpecialValues b) => SpecialValues (Either a b) where + specialValues = fmap Left specialValues ++ fmap Right specialValues + +instance (SpecialValues a, SpecialValues b) => SpecialValues (a, b) where + specialValues = zip specialValues specialValues + +specialIEEE :: IEEE a => [a] +specialIEEE = list ++ map negate list + where list = [ nan, 0, 1, epsilon, infinity + , minDenormal, succIEEE minDenormal + , minNormal, succIEEE minNormal + , succIEEE minNormal + , maxFinite, predIEEE maxFinite + , 0x1000000, predIEEE 0x1000000, succIEEE 0x1000000 -- Integer range representable by Float + , 0x20000000000000, predIEEE 0x20000000000000, succIEEE 0x20000000000000 -- Integer range representable by Double + , 0x7FFFFFFFFFFFFC00, predIEEE 0x7FFFFFFFFFFFFC00, succIEEE 0x7FFFFFFFFFFFFC00 -- Largest Int64 value representable by Double + , 0x8000000000000000, predIEEE 0x8000000000000000, succIEEE 0x8000000000000000 -- Largest Word64 value representable by Float and Double + , 0x7000000000000000, predIEEE 0x7000000000000000, succIEEE 0x7000000000000000 -- Largest Int64 value representable by Float + , 0x7000000, predIEEE 0x7000000, succIEEE 0x7000000 -- Largest Int32 value representable by Float and Double + , 0x8000000, predIEEE 0x8000000, succIEEE 0x8000000 -- Largest Word32 value representable by Float and Double + ] + +specialInt :: (Num a, Bounded a) => [a] +specialInt = [0, 1, -1, 2, -2, minBound, maxBound, minBound + 1, maxBound - 1, minBound + 2, maxBound - 2] + +specialBoundedEnum :: (Enum a, Bounded a) => [a] +specialBoundedEnum = [minBound, maxBound, succ minBound, pred maxBound]