ClassyPrelude

CorePrelude

module CorePrelude

undefined :: a

Deprecated: It is highly recommended that you either avoid partial functions or provide meaningful error messages

We define our own undefined which is marked as deprecated. This makes it useful to use during development, but let's you more easily getting notification if you accidentally ship partial code in production.

The classy prelude recommendation for when you need to really have a partial function in production is to use error with a very descriptive message so that, in case an exception is thrown, you get more information than Prelude.undefined.

Since 0.5.5

Standard

Monoid

(++) :: Monoid m => m -> m -> m

Semigroup

class Semigroup a where

Methods

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

An associative operation.

 (a <> b) <> c = a <> (b <> c)

If a is also a Monoid we further require

 (<>) = mappend

sconcat :: NonEmpty a -> a

Reduce a non-empty list with <>

The default definition should be sufficient, but this can be overridden for efficiency.

times1p :: Whole n => n -> a -> a

Repeat a value (n + 1) times.

 times1p n a = a <> a <> ... <> a  -- using <> n times

The default definition uses peasant multiplication, exploiting associativity to only require O(log n) uses of <>.

See also times.

Instances

Semigroup Ordering

Semigroup ()

Semigroup All

Semigroup Any

Semigroup Text

Semigroup ByteString

Semigroup Text

Semigroup ByteString

Semigroup IntSet

Semigroup [a]

Semigroup a => Semigroup (Dual a)

Semigroup (Endo a)

Num a => Semigroup (Sum a)

Num a => Semigroup (Product a)

Semigroup (First a)

Semigroup (Last a)

Semigroup a => Semigroup (Maybe a)

Semigroup (Vector a)

(Hashable a, Eq a) => Semigroup (HashSet a)

Ord a => Semigroup (Set a)

Semigroup (Seq a)

Semigroup (IntMap v)

Ord a => Semigroup (Min a)

Ord a => Semigroup (Max a)

Semigroup (First a)

Semigroup (Last a)

Monoid m => Semigroup (WrappedMonoid m)

Semigroup a => Semigroup (Option a)

Semigroup (NonEmpty a)

Unbox a => Semigroup (Vector a)

Storable a => Semigroup (Vector a)

Prim a => Semigroup (Vector a)

Semigroup b => Semigroup (a -> b)

Semigroup (Either a b)

(Semigroup a, Semigroup b) => Semigroup (a, b)

Semigroup a => Semigroup (Const a b)

(Hashable k, Eq k) => Semigroup (HashMap k a)

Ord k => Semigroup (Map k v)

Apply f => Semigroup (Act f a)

GrowingAppend mono => Semigroup (MinLen nat mono)

(Semigroup a, Semigroup b, Semigroup c) => Semigroup (a, b, c)

(Semigroup a, Semigroup b, Semigroup c, Semigroup d) => Semigroup (a, b, c, d)

(Semigroup a, Semigroup b, Semigroup c, Semigroup d, Semigroup e) => Semigroup (a, b, c, d, e)

data WrappedMonoid m

Provide a Semigroup for an arbitrary Monoid.

Instances

Typeable1 WrappedMonoid

Bounded m => Bounded (WrappedMonoid m)

Eq m => Eq (WrappedMonoid m)

Data m => Data (WrappedMonoid m)

Ord m => Ord (WrappedMonoid m)

Read m => Read (WrappedMonoid m)

Show m => Show (WrappedMonoid m)

Monoid m => Monoid (WrappedMonoid m)

Monoid m => Semigroup (WrappedMonoid m)

Monad

module Control.Monad

Mutable references

module Control.Concurrent.MVar.Lifted

module Data.IORef.Lifted

Debugging

trace :: String -> a -> a

The trace function outputs the trace message given as its first argument, before returning the second argument as its result.

For example, this returns the value of f x but first outputs the message.

 trace ("calling f with x = " ++ show x) (f x)

The trace function should only be used for debugging, or for monitoring execution. The function is not referentially transparent: its type indicates that it is a pure function but it has the side effect of outputting the trace message.

traceShow :: Show a => a -> b -> b

Like trace, but uses show on the argument to convert it to a String.

This makes it convenient for printing the values of interesting variables or expressions inside a function. For example here we print the value of the variables x and z:

 f x y =
     traceShow (x, z) $ result
   where
     z = ...
     ...

traceId :: String -> String

Since 0.5.9

traceM :: Monad m => String -> m ()

Since 0.5.9

traceShowId :: Show a => a -> a

Since 0.5.9

traceShowM :: (Show a, Monad m) => a -> m ()

Since 0.5.9

assert :: Bool -> a -> a

If the first argument evaluates to True, then the result is the second argument. Otherwise an AssertionFailed exception is raised, containing a String with the source file and line number of the call to assert.

Assertions can normally be turned on or off with a compiler flag (for GHC, assertions are normally on unless optimisation is turned on with -O or the -fignore-asserts option is given). When assertions are turned off, the first argument to assert is ignored, and the second argument is returned as the result.

Time (since 0.6.1)

module Data.Time

defaultTimeLocale :: TimeLocale

Poly hierarchy

module Data.Foldable

module Data.Traversable

Mono hierarchy

module Data.MonoTraversable

module Data.Sequences

module Data.Sequences.Lazy

module Data.Textual.Encoding

module Data.Containers

module Data.Builder

module Data.MinLen

I/O

data Handle

Haskell defines operations to read and write characters from and to files, represented by values of type Handle. Each value of this type is a handle: a record used by the Haskell run-time system to manage I/O with file system objects. A handle has at least the following properties:

• whether it manages input or output or both;
• whether it is open, closed or semi-closed;
• whether the object is seekable;
• whether buffering is disabled, or enabled on a line or block basis;
• a buffer (whose length may be zero).

Most handles will also have a current I/O position indicating where the next input or output operation will occur. A handle is readable if it manages only input or both input and output; likewise, it is writable if it manages only output or both input and output. A handle is open when first allocated. Once it is closed it can no longer be used for either input or output, though an implementation cannot re-use its storage while references remain to it. Handles are in the Show and Eq classes. The string produced by showing a handle is system dependent; it should include enough information to identify the handle for debugging. A handle is equal according to == only to itself; no attempt is made to compare the internal state of different handles for equality.

Instances

Eq Handle

Show Handle

Typeable Handle

stdin :: Handle

A handle managing input from the Haskell program's standard input channel.

stdout :: Handle

A handle managing output to the Haskell program's standard output channel.

stderr :: Handle

A handle managing output to the Haskell program's standard error channel.

Non-standard

List-like classes

map :: Functor f => (a -> b) -> f a -> f b

concat :: (MonoFoldable c, Monoid (Element c)) => c -> Element c

concatMap :: (Monoid m, MonoFoldable c) => (Element c -> m) -> c -> m

length :: MonoFoldable c => c -> Int

null :: MonoFoldable c => c -> Bool

pack :: IsSequence c => [Element c] -> c

unpack :: MonoFoldable c => c -> [Element c]

repack :: (MonoFoldable a, IsSequence b, Element a ~ Element b) => a -> b

Repack from one type to another, dropping to a list in the middle.

repack = pack . unpack.

toList :: MonoFoldable c => c -> [Element c]

mapM :: Traversable t => forall a m b. Monad m => (a -> m b) -> t a -> m (t b)

Map each element of a structure to a monadic action, evaluate these actions from left to right, and collect the results.

mapM_ :: (Monad m, MonoFoldable c) => (Element c -> m a) -> c -> m ()

forM :: (Traversable t, Monad m) => t a -> (a -> m b) -> m (t b)

forM is mapM with its arguments flipped.

forM_ :: (Monad m, MonoFoldable c) => c -> (Element c -> m a) -> m ()

any :: MonoFoldable c => (Element c -> Bool) -> c -> Bool

all :: MonoFoldable c => (Element c -> Bool) -> c -> Bool

foldl' :: MonoFoldable c => (a -> Element c -> a) -> a -> c -> a

foldr :: MonoFoldable c => (Element c -> b -> b) -> b -> c -> b

foldM :: (Monad m, MonoFoldable c) => (a -> Element c -> m a) -> a -> c -> m a

readMay :: (Element c ~ Char, MonoFoldable c, Read a) => c -> Maybe a

intercalate :: (Monoid (Element c), IsSequence c) => Element c -> c -> Element c

zip :: Zip f => forall a b. f a -> f b -> f (a, b)

zip3 :: Zip3 f => forall a b c. f a -> f b -> f c -> f (a, b, c)

zip4 :: Zip4 f => forall a b c d. f a -> f b -> f c -> f d -> f (a, b, c, d)

zip5 :: Zip5 f => forall a b c d e. f a -> f b -> f c -> f d -> f e -> f (a, b, c, d, e)

zip6 :: Zip6 f => forall a b c d e g. f a -> f b -> f c -> f d -> f e -> f g -> f (a, b, c, d, e, g)

zip7 :: Zip7 f => forall a b c d e g h. f a -> f b -> f c -> f d -> f e -> f g -> f h -> f (a, b, c, d, e, g, h)

unzip :: Zip f => forall a b. f (a, b) -> (f a, f b)

unzip3 :: Zip3 f => forall a b c. f (a, b, c) -> (f a, f b, f c)

unzip4 :: Zip4 f => forall a b c d. f (a, b, c, d) -> (f a, f b, f c, f d)

unzip5 :: Zip5 f => forall a b c d e. f (a, b, c, d, e) -> (f a, f b, f c, f d, f e)

unzip6 :: Zip6 f => forall a b c d e g. f (a, b, c, d, e, g) -> (f a, f b, f c, f d, f e, f g)

unzip7 :: Zip7 f => forall a b c d e g h. f (a, b, c, d, e, g, h) -> (f a, f b, f c, f d, f e, f g, f h)

zipWith :: Zip f => forall a b c. (a -> b -> c) -> f a -> f b -> f c

zipWith3 :: Zip3 f => forall a b c d. (a -> b -> c -> d) -> f a -> f b -> f c -> f d

zipWith4 :: Zip4 f => forall a b c d e. (a -> b -> c -> d -> e) -> f a -> f b -> f c -> f d -> f e

zipWith5 :: Zip5 f => forall a b c d e g. (a -> b -> c -> d -> e -> g) -> f a -> f b -> f c -> f d -> f e -> f g

zipWith6 :: Zip6 f => forall a b c d e g h. (a -> b -> c -> d -> e -> g -> h) -> f a -> f b -> f c -> f d -> f e -> f g -> f h

zipWith7 :: Zip7 f => forall a b c d e g h i. (a -> b -> c -> d -> e -> g -> h -> i) -> f a -> f b -> f c -> f d -> f e -> f g -> f h -> f i

hashNub :: (Hashable a, Eq a) => [a] -> [a]

same behavior as nub, but requires Hashable & Eq and is O(n log n) https:github.comnh2haskell-ordnub

ordNub :: Ord a => [a] -> [a]

same behavior as nub, but requires Ord and is O(n log n) https:github.comnh2haskell-ordnub

ordNubBy :: Ord b => (a -> b) -> (a -> a -> Bool) -> [a] -> [a]

same behavior as nubBy, but requires Ord and is O(n log n) https:github.comnh2haskell-ordnub

sortWith :: (Ord a, IsSequence c) => (Element c -> a) -> c -> c

Sort elements using the user supplied function to project something out of each element. Inspired by http://hackage.haskell.org/packages/archive/base/latest/doc/html/GHC-Exts.html#v:sortWith.

compareLength :: (Integral i, MonoFoldable c) => c -> i -> Ordering

sum :: (MonoFoldable c, Num (Element c)) => c -> Element c

product :: (MonoFoldable c, Num (Element c)) => c -> Element c

repeat :: a -> [a]

repeat x is an infinite list, with x the value of every element.

Set-like

(\\) :: SetContainer a => a -> a -> a

An alias for difference.

intersect :: SetContainer a => a -> a -> a

An alias for intersection.

unions :: (MonoFoldable c, SetContainer (Element c)) => c -> Element c

Text-like

class Show a where

Conversion of values to readable Strings.

Minimal complete definition: showsPrec or show.

Derived instances of Show have the following properties, which are compatible with derived instances of Read:

• The result of show is a syntactically correct Haskell expression containing only constants, given the fixity declarations in force at the point where the type is declared. It contains only the constructor names defined in the data type, parentheses, and spaces. When labelled constructor fields are used, braces, commas, field names, and equal signs are also used.
• If the constructor is defined to be an infix operator, then showsPrec will produce infix applications of the constructor.
• the representation will be enclosed in parentheses if the precedence of the top-level constructor in x is less than d (associativity is ignored). Thus, if d is 0 then the result is never surrounded in parentheses; if d is 11 it is always surrounded in parentheses, unless it is an atomic expression.
• If the constructor is defined using record syntax, then show will produce the record-syntax form, with the fields given in the same order as the original declaration.

For example, given the declarations

 infixr 5 :^:
 data Tree a =  Leaf a  |  Tree a :^: Tree a

the derived instance of Show is equivalent to

 instance (Show a) => Show (Tree a) where

        showsPrec d (Leaf m) = showParen (d > app_prec) $
             showString "Leaf " . showsPrec (app_prec+1) m
          where app_prec = 10

        showsPrec d (u :^: v) = showParen (d > up_prec) $
             showsPrec (up_prec+1) u .
             showString " :^: "      .
             showsPrec (up_prec+1) v
          where up_prec = 5

Note that right-associativity of :^: is ignored. For example,

• show (Leaf 1 :^: Leaf 2 :^: Leaf 3) produces the string "Leaf 1 :^: (Leaf 2 :^: Leaf 3)".

Methods

showsPrec

Arguments

:: Int

the operator precedence of the enclosing context (a number from 0 to 11). Function application has precedence 10.

-> a

the value to be converted to a String

-> ShowS

Convert a value to a readable String.

showsPrec should satisfy the law

 showsPrec d x r ++ s  ==  showsPrec d x (r ++ s)

Derived instances of Read and Show satisfy the following:

• (x,"") is an element of (readsPrec d (showsPrec d x "")).

That is, readsPrec parses the string produced by showsPrec, and delivers the value that showsPrec started with.

show :: a -> String

A specialised variant of showsPrec, using precedence context zero, and returning an ordinary String.

showList :: [a] -> ShowS

The method showList is provided to allow the programmer to give a specialised way of showing lists of values. For example, this is used by the predefined Show instance of the Char type, where values of type String should be shown in double quotes, rather than between square brackets.

Instances

Show Bool

Show Char

Show Double

Show Float

Show Int

Show Int8

Show Int16

Show Int32

Show Int64

Show Integer

Show Ordering

Show Word

Show Word8

Show Word16

Show Word32

Show Word64

Show ()

Show Handle

Show ThreadId

Show HandleType

Show HandlePosn

Show BlockReason

Show ThreadStatus

Show BufferMode

Show Newline

Show NewlineMode

Show All

Show Any

Show Arity

Show Fixity

Show Associativity

Show GeneralCategory

Show TypeRep

Show TyCon

Show FilePath

Show Text

Show ByteString

Show Text

Show ByteString

Show IntSet

Show TimeLocale

Show Padding

Show DateFormatSpec

Show LocalTime

Show ZonedTime

Show UTCTime

Show Day

Show a => Show [a]

(Integral a, Show a) => Show (Ratio a)

Show a => Show (Dual a)

Show a => Show (Sum a)

Show a => Show (Product a)

Show a => Show (First a)

Show a => Show (Last a)

Show a => Show (Maybe a)

Show a => Show (Vector a)

Show a => Show (HashSet a)

Show a => Show (Set a)

Show a => Show (IntMap a)

Show a => Show (Min a)

Show a => Show (Max a)

Show a => Show (First a)

Show a => Show (Last a)

Show m => Show (WrappedMonoid m)

Show a => Show (Option a)

Show (Rules a)

(Show a, Unbox a) => Show (Vector a)

(Show a, Storable a) => Show (Vector a)

(Show a, Prim a) => Show (Vector a)

(Show a, Show b) => Show (Either a b)

(Show a, Show b) => Show (a, b)

Show (ST s a)

(Show k, Show v) => Show (HashMap k v)

(Show k, Show a) => Show (Map k a)

(Show a, Show b, Show c) => Show (a, b, c)

(Show a, Show b, Show c, Show d) => Show (a, b, c, d)

(Show a, Show b, Show c, Show d, Show e) => Show (a, b, c, d, e)

(Show a, Show b, Show c, Show d, Show e, Show f) => Show (a, b, c, d, e, f)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g) => Show (a, b, c, d, e, f, g)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h) => Show (a, b, c, d, e, f, g, h)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i) => Show (a, b, c, d, e, f, g, h, i)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j) => Show (a, b, c, d, e, f, g, h, i, j)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k) => Show (a, b, c, d, e, f, g, h, i, j, k)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l) => Show (a, b, c, d, e, f, g, h, i, j, k, l)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m, Show n) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n)

(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m, Show n, Show o) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)

tshow :: Show a => a -> Text

tlshow :: Show a => a -> LText

Case conversion

charToLower :: Char -> Char

Convert a character to lower case.

Character-based case conversion is lossy in comparison to string-based toLower. For instance, 'İ' will be converted to 'i', instead of "i̇".

charToUpper :: Char -> Char

Convert a character to upper case.

Character-based case conversion is lossy in comparison to string-based toUpper. For instance, 'ß' won't be converted to "SS".

IO

class IsSequence a => IOData a where

Data which can be read to and from files and handles.

Note that, for lazy sequences, these operations may perform lazy I/O.

Methods

readFile :: MonadIO m => FilePath -> m a

writeFile :: MonadIO m => FilePath -> a -> m ()

getLine :: MonadIO m => m a

hGetContents :: MonadIO m => Handle -> m a

hGetLine :: MonadIO m => Handle -> m a

hPut :: MonadIO m => Handle -> a -> m ()

hPutStrLn :: MonadIO m => Handle -> a -> m ()

hGetChunk :: MonadIO m => Handle -> m a

Instances

IOData Text

IOData ByteString

IOData Text

IOData ByteString

~ * Char c => IOData [c]

print :: (Show a, MonadIO m) => a -> m ()

hClose :: Handle -> IO ()

Computation hClose hdl makes handle hdl closed. Before the computation finishes, if hdl is writable its buffer is flushed as for hFlush. Performing hClose on a handle that has already been closed has no effect; doing so is not an error. All other operations on a closed handle will fail. If hClose fails for any reason, any further operations (apart from hClose) on the handle will still fail as if hdl had been successfully closed.

FilePath

fpToString :: FilePath -> String

fpFromString :: String -> FilePath

fpToText :: FilePath -> Text

Translates a FilePath to a Text This translation is not correct for a (unix) filename which can contain arbitrary (non-unicode) bytes: those bytes will be discarded

This means you cannot translate the Text back to the original file name.

If you control or otherwise understand the filenames and believe them to be unicode valid consider using fpToTextEx or fpToTextWarn

fpFromText :: Text -> FilePath

fpToTextWarn :: MonadIO m => FilePath -> m Text

Translates a FilePath to a Text Warns if there are non-unicode sequences in the file name

fpToTextEx :: FilePath -> Text

Translates a FilePath to a Text Throws an exception if there are non-unicode sequences in the file name

Use this to assert that you know a filename will translate properly into a Text If you created the filename, this should be the case.

Exceptions

module Control.Exception.Enclosed

Force types

Helper functions for situations where type inferer gets confused.

asByteString :: ByteString -> ByteString

asLByteString :: LByteString -> LByteString

asHashMap :: HashMap k v -> HashMap k v

asHashSet :: HashSet a -> HashSet a

asText :: Text -> Text

asLText :: LText -> LText

asList :: [a] -> [a]

asMap :: Map k v -> Map k v

asMaybe :: Maybe a -> Maybe a

asSet :: Set a -> Set a

asVector :: Vector a -> Vector a

asUVector :: UVector a -> UVector a