Safe Haskell | None |
---|---|
Language | Haskell2010 |
Type classes mirroring standard typeclasses, but working with monomorphic containers.
The motivation is that some commonly used data types (i.e., ByteString
and
Text
) do not allow for instances of typeclasses like Functor
and
Foldable
, since they are monomorphic structures. This module allows both
monomorphic and polymorphic data types to be instances of the same
typeclasses.
All of the laws for the polymorphic typeclasses apply to their monomorphic
cousins. Thus, even though a MonoFunctor
instance for Set
could
theoretically be defined, it is omitted since it could violate the functor
law of
.omap
f . omap
g = omap
(f . g)
Note that all typeclasses have been prefixed with Mono
, and functions have
been prefixed with o
. The mnemonic for o
is "only one", or alternatively
"it's mono, but m is overused in Haskell, so we'll use the second letter
instead." (Agreed, it's not a great mangling scheme, input is welcome!)
- type family Element mono
- class MonoFunctor mono where
- class MonoFoldable mono where
- ofoldMap :: Monoid m => (Element mono -> m) -> mono -> m
- ofoldr :: (Element mono -> b -> b) -> b -> mono -> b
- ofoldl' :: (a -> Element mono -> a) -> a -> mono -> a
- otoList :: mono -> [Element mono]
- oall :: (Element mono -> Bool) -> mono -> Bool
- oany :: (Element mono -> Bool) -> mono -> Bool
- onull :: mono -> Bool
- olength :: mono -> Int
- olength64 :: mono -> Int64
- ocompareLength :: Integral i => mono -> i -> Ordering
- otraverse_ :: (MonoFoldable mono, Applicative f) => (Element mono -> f b) -> mono -> f ()
- ofor_ :: (MonoFoldable mono, Applicative f) => mono -> (Element mono -> f b) -> f ()
- omapM_ :: (MonoFoldable mono, Monad m) => (Element mono -> m ()) -> mono -> m ()
- oforM_ :: (MonoFoldable mono, Monad m) => mono -> (Element mono -> m ()) -> m ()
- ofoldlM :: (MonoFoldable mono, Monad m) => (a -> Element mono -> m a) -> a -> mono -> m a
- ofoldMap1Ex :: Semigroup m => (Element mono -> m) -> mono -> m
- ofoldr1Ex :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono
- ofoldl1Ex' :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono
- headEx :: mono -> Element mono
- lastEx :: mono -> Element mono
- unsafeHead :: mono -> Element mono
- unsafeLast :: mono -> Element mono
- maximumByEx :: (Element mono -> Element mono -> Ordering) -> mono -> Element mono
- minimumByEx :: (Element mono -> Element mono -> Ordering) -> mono -> Element mono
- headMay :: MonoFoldable mono => mono -> Maybe (Element mono)
- lastMay :: MonoFoldable mono => mono -> Maybe (Element mono)
- osum :: (MonoFoldable mono, Num (Element mono)) => mono -> Element mono
- oproduct :: (MonoFoldable mono, Num (Element mono)) => mono -> Element mono
- oand :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool
- oor :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool
- class (MonoFoldable mono, Monoid mono) => MonoFoldableMonoid mono where
- oconcatMap :: (Element mono -> mono) -> mono -> mono
- class (MonoFoldable mono, Eq (Element mono)) => MonoFoldableEq mono where
- class (MonoFoldable mono, Ord (Element mono)) => MonoFoldableOrd mono where
- maximumMay :: MonoFoldableOrd mono => mono -> Maybe (Element mono)
- maximumByMay :: MonoFoldable mono => (Element mono -> Element mono -> Ordering) -> mono -> Maybe (Element mono)
- minimumMay :: MonoFoldableOrd mono => mono -> Maybe (Element mono)
- minimumByMay :: MonoFoldable mono => (Element mono -> Element mono -> Ordering) -> mono -> Maybe (Element mono)
- class (MonoFunctor mono, MonoFoldable mono) => MonoTraversable mono where
- ofor :: (MonoTraversable mono, Applicative f) => mono -> (Element mono -> f (Element mono)) -> f mono
- oforM :: (MonoTraversable mono, Monad f) => mono -> (Element mono -> f (Element mono)) -> f mono
- ofoldlUnwrap :: MonoFoldable mono => (x -> Element mono -> x) -> x -> (x -> b) -> mono -> b
- ofoldMUnwrap :: (Monad m, MonoFoldable mono) => (x -> Element mono -> m x) -> m x -> (x -> m b) -> mono -> m b
- class MonoPointed mono where
- class MonoFunctor mono => MonoComonad mono where
Documentation
type family Element mono Source
Type family for getting the type of the elements of a monomorphic container.
class MonoFunctor mono where Source
Monomorphic containers that can be mapped over.
Nothing
class MonoFoldable mono where Source
Monomorphic containers that can be folded.
Nothing
ofoldMap :: Monoid m => (Element mono -> m) -> mono -> m Source
Map each element of a monomorphic container to a Monoid
and combine the results.
ofoldr :: (Element mono -> b -> b) -> b -> mono -> b Source
Right-associative fold of a monomorphic container.
ofoldl' :: (a -> Element mono -> a) -> a -> mono -> a Source
Strict left-associative fold of a monomorphic container.
otoList :: mono -> [Element mono] Source
Convert a monomorphic container to a list.
oall :: (Element mono -> Bool) -> mono -> Bool Source
Are all of the elements in a monomorphic container
converted to booleans True
?
oany :: (Element mono -> Bool) -> mono -> Bool Source
Are any of the elements in a monomorphic container
converted to booleans True
?
Is the monomorphic container empty?
Length of a monomorphic container, returns a Int
.
olength64 :: mono -> Int64 Source
Length of a monomorphic container, returns a Int64
.
ocompareLength :: Integral i => mono -> i -> Ordering Source
Compare the length of a monomorphic container and a given number.
otraverse_ :: (MonoFoldable mono, Applicative f) => (Element mono -> f b) -> mono -> f () Source
Map each element of a monomorphic container to an action, evaluate these actions from left to right, and ignore the results.
ofor_ :: (MonoFoldable mono, Applicative f) => mono -> (Element mono -> f b) -> f () Source
ofor_
is otraverse_
with its arguments flipped.
omapM_ :: (MonoFoldable mono, Monad m) => (Element mono -> m ()) -> mono -> m () Source
Map each element of a monomorphic container to a monadic action, evaluate these actions from left to right, and ignore the results.
oforM_ :: (MonoFoldable mono, Monad m) => mono -> (Element mono -> m ()) -> m () Source
ofoldlM :: (MonoFoldable mono, Monad m) => (a -> Element mono -> m a) -> a -> mono -> m a Source
Monadic fold over the elements of a monomorphic container, associating to the left.
ofoldMap1Ex :: Semigroup m => (Element mono -> m) -> mono -> m Source
Map each element of a monomorphic container to a semigroup, and combine the results.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See ofoldMap1
from Data.MinLen for a total version of this function.
ofoldr1Ex :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono Source
Right-associative fold of a monomorphic container with no base element.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See ofoldr1Ex
from Data.MinLen for a total version of this function.
ofoldl1Ex' :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono Source
Strict left-associative fold of a monomorphic container with no base element.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See ofoldl1Ex'
from Data.MinLen for a total version of this function.
headEx :: mono -> Element mono Source
Get the first element of a monomorphic container.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See head
from Data.MinLen for a total version of this function.
lastEx :: mono -> Element mono Source
Get the last element of a monomorphic container.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See 'Data.MinLen.last from Data.MinLen for a total version of this function.
unsafeHead :: mono -> Element mono Source
Equivalent to headEx
.
unsafeLast :: mono -> Element mono Source
Equivalent to lastEx
.
maximumByEx :: (Element mono -> Element mono -> Ordering) -> mono -> Element mono Source
Get the maximum element of a monomorphic container, using a supplied element ordering function.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See maximiumBy
from Data.MinLen for a total version of this function.
minimumByEx :: (Element mono -> Element mono -> Ordering) -> mono -> Element mono Source
Get the minimum element of a monomorphic container, using a supplied element ordering function.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See minimumBy
from Data.MinLen for a total version of this function.
headMay :: MonoFoldable mono => mono -> Maybe (Element mono) Source
lastMay :: MonoFoldable mono => mono -> Maybe (Element mono) Source
osum :: (MonoFoldable mono, Num (Element mono)) => mono -> Element mono Source
osum
computes the sum of the numbers of a monomorphic container.
oproduct :: (MonoFoldable mono, Num (Element mono)) => mono -> Element mono Source
oproduct
computes the product of the numbers of a monomorphic container.
oand :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool Source
Are all of the elements True
?
Since 0.6.0
oor :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool Source
Are any of the elements True
?
Since 0.6.0
class (MonoFoldable mono, Monoid mono) => MonoFoldableMonoid mono where Source
A typeclass for monomorphic containers that are Monoid
s.
Nothing
oconcatMap :: (Element mono -> mono) -> mono -> mono Source
Map a function over a monomorphic container and combine the results.
class (MonoFoldable mono, Eq (Element mono)) => MonoFoldableEq mono where Source
A typeclass for monomorphic containers whose elements
are an instance of Eq
.
Nothing
oelem :: Element mono -> mono -> Bool Source
Checks if the monomorphic container includes the supplied element.
onotElem :: Element mono -> mono -> Bool Source
Checks if the monomorphic container does not include the supplied element.
class (MonoFoldable mono, Ord (Element mono)) => MonoFoldableOrd mono where Source
A typeclass for monomorphic containers whose elements
are an instance of Ord
.
Nothing
maximumEx :: mono -> Element mono Source
Get the minimum element of a monomorphic container.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See maximum
from Data.MinLen for a total version of this function.
minimumEx :: mono -> Element mono Source
Get the maximum element of a monomorphic container.
Note: this is a partial function. On an empty MonoFoldable
, it will
throw an exception.
See minimum
from Data.MinLen for a total version of this function.
maximumMay :: MonoFoldableOrd mono => mono -> Maybe (Element mono) Source
maximumByMay :: MonoFoldable mono => (Element mono -> Element mono -> Ordering) -> mono -> Maybe (Element mono) Source
Safe version of maximumByEx
.
Returns Nothing
instead of throwing an exception when
encountering an empty monomorphic container.
minimumMay :: MonoFoldableOrd mono => mono -> Maybe (Element mono) Source
minimumByMay :: MonoFoldable mono => (Element mono -> Element mono -> Ordering) -> mono -> Maybe (Element mono) Source
Safe version of minimumByEx
.
Returns Nothing
instead of throwing an exception when
encountering an empty monomorphic container.
class (MonoFunctor mono, MonoFoldable mono) => MonoTraversable mono where Source
Monomorphic containers that can be traversed from left to right.
Nothing
otraverse :: Applicative f => (Element mono -> f (Element mono)) -> mono -> f mono Source
Map each element of a monomorphic container to an action, evaluate these actions from left to right, and collect the results.
omapM :: Monad m => (Element mono -> m (Element mono)) -> mono -> m mono Source
Map each element of a monomorphic container to a monadic action, evaluate these actions from left to right, and collect the results.
ofor :: (MonoTraversable mono, Applicative f) => mono -> (Element mono -> f (Element mono)) -> f mono Source
oforM :: (MonoTraversable mono, Monad f) => mono -> (Element mono -> f (Element mono)) -> f mono Source
ofoldlUnwrap :: MonoFoldable mono => (x -> Element mono -> x) -> x -> (x -> b) -> mono -> b Source
A strict left fold, together with an unwrap function.
This is convenient when the accumulator value is not the same as the final
expected type. It is provided mainly for integration with the foldl
package, to be used in conjunction with purely
.
Since 0.3.1
ofoldMUnwrap :: (Monad m, MonoFoldable mono) => (x -> Element mono -> m x) -> m x -> (x -> m b) -> mono -> m b Source
A monadic strict left fold, together with an unwrap function.
Similar to foldlUnwrap
, but allows monadic actions. To be used with
impurely
from foldl
.
Since 0.3.1
class MonoPointed mono where Source
Typeclass for monomorphic containers that an element can be lifted into.
For any MonoFunctor
, the following law holds:
omap
f .opoint
=opoint
. f
Nothing
opoint :: Element mono -> mono Source
Lift an element into a monomorphic container.
opoint
is the same as pure
for an Applicative
class MonoFunctor mono => MonoComonad mono where Source
Typeclass for monomorphic containers where it is always okay to
"extract" a value from with oextract
, and where you can extrapolate
any "extracting" function to be a function on the whole part with
oextend
.
oextend
and oextract
should work together following the laws:
oextend
oextract
=id
oextract
.oextend
f = foextend
f .oextend
g =oextend
(f .oextend
g)
As an intuition,
uses oextend
ff
to "build up" a new mono
with
pieces from the old one received by f
.
Nothing
oextract :: mono -> Element mono Source
Extract an element from mono
. Can be thought of as a dual
concept to opoint
.
MonoComonad (Identity a) Source | |
MonoComonad (Tree a) Source | |
MonoComonad (ViewL a) Source | |
MonoComonad (ViewR a) Source | |
MonoComonad (NonEmpty a) Source | |
Monoid m => MonoComonad (m -> a) Source | |
MonoComonad (e, a) Source | |
Comonad w => MonoComonad (IdentityT w a) Source | |
MonoComonad (Arg a b) Source | |
IsSequence mono => MonoComonad (MinLen (Succ Zero) mono) Source | For For example, for
Meant to be a direct analogy to the instance for |
(Comonad w, Monoid m) => MonoComonad (TracedT m w a) Source | |
Comonad w => MonoComonad (StoreT s w a) Source | |
Comonad w => MonoComonad (EnvT e w a) Source |