Ideas.Common.Examples

• This module provides an interface to structure a collection of examples. Examples can be taken from (lists of) concrete values, or from random generators. Both types can be marked as test items. Examples can be assigned a level of difficulty (ranging from very easy to very difficult). Test items do not have a difficulty level. Examples can be grouped into sub-collections and assigned an identifier. Use the Monoid operations for combining examples.

Examples type

data Examples a

Instances

Functor Examples

Defined in Ideas.Common.Examples

Methods

fmap :: (a -> b) -> Examples a -> Examples b

(<$) :: a -> Examples b -> Examples a

Semigroup (Examples a)

Defined in Ideas.Common.Examples

Methods

(<>) :: Examples a -> Examples a -> Examples a

sconcat :: NonEmpty (Examples a) -> Examples a

stimes :: Integral b => b -> Examples a -> Examples a

Monoid (Examples a)

Defined in Ideas.Common.Examples

Methods

mempty :: Examples a

mappend :: Examples a -> Examples a -> Examples a

mconcat :: [Examples a] -> Examples a

Constructing examples

example :: a -> Examples a

One example

exampleList :: [a] -> Examples a

List of examples

examplesFor :: Difficulty -> [a] -> Examples a

List of examples with the same difficulty

examplesWithDifficulty :: [(Difficulty, a)] -> Examples a

List of examples with their own difficulty

random :: Gen a -> Examples a

Use a random generator (from QuickCheck) as example generator

group :: Id -> Examples a -> Examples a

forTesting :: Examples a -> Examples a

Turn examples (and random generators) into tests (and test generators)

Assigning difficulty

difficulty :: Difficulty -> Examples a -> Examples a

Assign difficulty (to all items without a difficulty level)

veryEasy :: Examples a -> Examples a

easy :: Examples a -> Examples a

medium :: Examples a -> Examples a

difficult :: Examples a -> Examples a

veryDifficult :: Examples a -> Examples a

Transformations and queries

isEmpty :: Examples a -> Bool

Tests if there ar no examples

size :: Examples a -> Int

Number of examples, including those in subgroups

flatten :: Examples a -> Examples a

Flatten examples into one collection without subgroups

groups :: Examples a -> [(Id, Examples a)]

Top-level groups

topLevelExamples :: Examples a -> [(Maybe Difficulty, a)]

Top-level examples

topLevelRandoms :: Examples a -> [(Maybe Difficulty, Gen a)]

Top-level random generators

topLevelTests :: Examples a -> [a]

Top-level test cases

topLevelRandomTests :: Examples a -> [Gen a]

Top-level test generators

allExamples :: Examples a -> [(Maybe Difficulty, a)]

All examples (also in groups)

allRandoms :: Examples a -> [(Maybe Difficulty, Gen a)]

All random generators (also in groups)

allTests :: Examples a -> [a]

All test cases (also in groups)

allRandomTests :: Examples a -> [Gen a]

All test generators (also in groups)

Difficulty type

data Difficulty

Constructors

VeryEasy

Easy

Medium

Difficult

VeryDifficult

Instances

Enum Difficulty

Defined in Ideas.Common.Examples

Methods

succ :: Difficulty -> Difficulty

pred :: Difficulty -> Difficulty

toEnum :: Int -> Difficulty

fromEnum :: Difficulty -> Int

enumFrom :: Difficulty -> [Difficulty]

enumFromThen :: Difficulty -> Difficulty -> [Difficulty]

enumFromTo :: Difficulty -> Difficulty -> [Difficulty]

enumFromThenTo :: Difficulty -> Difficulty -> Difficulty -> [Difficulty]

Eq Difficulty

Defined in Ideas.Common.Examples

Methods

(==) :: Difficulty -> Difficulty -> Bool

(/=) :: Difficulty -> Difficulty -> Bool

Ord Difficulty

Defined in Ideas.Common.Examples

Methods

compare :: Difficulty -> Difficulty -> Ordering

(<) :: Difficulty -> Difficulty -> Bool

(<=) :: Difficulty -> Difficulty -> Bool

(>) :: Difficulty -> Difficulty -> Bool

(>=) :: Difficulty -> Difficulty -> Bool

max :: Difficulty -> Difficulty -> Difficulty

min :: Difficulty -> Difficulty -> Difficulty

Read Difficulty

Defined in Ideas.Common.Examples

Methods

readsPrec :: Int -> ReadS Difficulty

readList :: ReadS [Difficulty]

readPrec :: ReadPrec Difficulty

readListPrec :: ReadPrec [Difficulty]

Show Difficulty

Defined in Ideas.Common.Examples

Methods

showsPrec :: Int -> Difficulty -> ShowS

show :: Difficulty -> String

showList :: [Difficulty] -> ShowS

readDifficulty :: String -> Maybe Difficulty

Parser for difficulty levels, which ignores non-alpha charactes (including spaces) and upper/lower case distinction.