Language.Pads.Generation

Documentation

newtype PadsGen st a

A custom application of the ReaderT monad, allowing threaded access to a random generator, supplied when the generation function is called at top level (i.e. via runPadsGen)

Constructors

PadsGen

Fields

• unPadsGen :: StateT (GenIO, st) IO a

Instances

Monad (PadsGen st)

Defined in Language.Pads.Generation

Methods

(>>=) :: PadsGen st a -> (a -> PadsGen st b) -> PadsGen st b

(>>) :: PadsGen st a -> PadsGen st b -> PadsGen st b

return :: a -> PadsGen st a

fail :: String -> PadsGen st a

Functor (PadsGen st)

Defined in Language.Pads.Generation

Methods

fmap :: (a -> b) -> PadsGen st a -> PadsGen st b

(<$) :: a -> PadsGen st b -> PadsGen st a

Applicative (PadsGen st)

Defined in Language.Pads.Generation

Methods

pure :: a -> PadsGen st a

(<*>) :: PadsGen st (a -> b) -> PadsGen st a -> PadsGen st b

liftA2 :: (a -> b -> c) -> PadsGen st a -> PadsGen st b -> PadsGen st c

(*>) :: PadsGen st a -> PadsGen st b -> PadsGen st b

(<*) :: PadsGen st a -> PadsGen st b -> PadsGen st a

MonadIO (PadsGen st)

Defined in Language.Pads.Generation

Methods

liftIO :: IO a -> PadsGen st a

MonadState (Gen RealWorld, st) (PadsGen st)

Defined in Language.Pads.Generation

Methods

get :: PadsGen st (Gen RealWorld, st)

put :: (Gen RealWorld, st) -> PadsGen st ()

state :: ((Gen RealWorld, st) -> (a, (Gen RealWorld, st))) -> PadsGen st a

askGen :: MonadState (GenIO, st) (PadsGen st) => (GenIO -> PadsGen st a) -> PadsGen st a

runPadsGenSt :: st -> PadsGen st a -> IO a

Provides the requisite random number generator to the supplied generation computation and returns the result as a value in IO. Initial generator state must be given.

getState :: PadsGen st st

Pull user-level state out of the generator (ignore the random seed).

putState :: st -> PadsGen st ()

Put user-level state intothe generator (carrying over the random seed).

runPadsGen :: PadsGen () a -> IO a

Delegates to 'runPadsGen\''

randNum :: Variate a => PadsGen st a

The types 'randNum'/'randNumBound'/'randNumBetween' return are dictated by the types of their callers.

randNumBetween :: (Integral a, Variate a) => a -> a -> PadsGen st a

A number with bounds i and j

randNumBound :: (Integral a, Variate a) => a -> PadsGen st a

A number with an upper bound i

randInteger :: PadsGen st Integer

As they aren't members of the System.Random.MWC class Variate, Integers require special treatment - convert them from doubles.

randIntegerBound :: Integral a => a -> PadsGen st Integer

See randInteger

randElem :: [a] -> PadsGen st a

Choose an element from a list at random

randLetter :: PadsGen st Char

A random letter from English upper and lowercase letters

randLetterExcluding :: Char -> PadsGen st Char

A random letter from English upper and lowercase letters, excluding the provided character

letters :: [Char]

listLengthLimit :: Int

randList :: PadsGen st a -> Maybe Int -> PadsGen st [a]

A list of random length, provided a PadsGen generator. Optionally also paramaterized by an Int, which if provided will be the length of the list

recLimit :: Integer

untilM :: Monad m => (a -> Bool) -> (a -> m a) -> Integer -> a -> m a

Provided a predicate, function that transforms a seed value, recursion limit, and seed value, generates a value of the seed's type that satisfies the predicate

randWithConstraint :: PadsGen st a -> (a -> Bool) -> PadsGen st a

A random instance of the provided PadsGen that satisfies the provided constraint