Data.MonoTraversable

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!)

Documentation

type family Element mofu

class MonoFunctor mofu where

Methods

omap :: (Element mofu -> Element mofu) -> mofu -> mofu

Instances

MonoFunctor ByteString

MonoFunctor ByteString

MonoFunctor Text

MonoFunctor Text

MonoFunctor [a]

MonoFunctor (IO a)

MonoFunctor (ZipList a)

MonoFunctor (Maybe a)

MonoFunctor (Tree a)

MonoFunctor (Seq a)

MonoFunctor (ViewL a)

MonoFunctor (ViewR a)

MonoFunctor (IntMap a)

MonoFunctor (Option a)

MonoFunctor (NonEmpty a)

MonoFunctor (Identity a)

MonoFunctor (Vector a)

Unbox a => MonoFunctor (Vector a)

Storable a => MonoFunctor (Vector a)

MonoFunctor (r -> a)

MonoFunctor (Either a b)

MonoFunctor (a, b)

MonoFunctor (Const m a)

Monad m => MonoFunctor (WrappedMonad m a)

MonoFunctor (Map k v)

Functor f => MonoFunctor (WrappedApplicative f a)

Functor f => MonoFunctor (MaybeApply f a)

Functor m => MonoFunctor (MaybeT m a)

Functor m => MonoFunctor (ListT m a)

Functor m => MonoFunctor (IdentityT m a)

MonoFunctor (HashMap k v)

Arrow a => MonoFunctor (WrappedArrow a b c)

MonoFunctor (Cokleisli w a b)

Functor m => MonoFunctor (ErrorT e m a)

Functor f => MonoFunctor (Static f a b)

Functor m => MonoFunctor (WriterT w m a)

Functor m => MonoFunctor (WriterT w m a)

Functor m => MonoFunctor (StateT s m a)

Functor m => MonoFunctor (StateT s m a)

Functor m => MonoFunctor (ReaderT r m a)

Functor m => MonoFunctor (ContT r m a)

(Functor f, Functor g) => MonoFunctor (Compose f g a)

(Functor f, Functor g) => MonoFunctor (Product f g a)

Functor m => MonoFunctor (RWST r w s m a)

Functor m => MonoFunctor (RWST r w s m a)

class MonoFoldable mofo where

Methods

ofoldMap :: Monoid m => (Element mofo -> m) -> mofo -> m

ofoldr :: (Element mofo -> b -> b) -> b -> mofo -> b

ofoldl' :: (a -> Element mofo -> a) -> a -> mofo -> a

otoList :: mofo -> [Element mofo]

oall :: (Element mofo -> Bool) -> mofo -> Bool

oany :: (Element mofo -> Bool) -> mofo -> Bool

onull :: mofo -> Bool

olength :: mofo -> Int

olength64 :: mofo -> Int64

ocompareLength :: Integral i => mofo -> i -> Ordering

otraverse_ :: (MonoFoldable mofo, Applicative f) => (Element mofo -> f b) -> mofo -> f ()

ofor_ :: (MonoFoldable mofo, Applicative f) => mofo -> (Element mofo -> f b) -> f ()

omapM_ :: (MonoFoldable mofo, Monad m) => (Element mofo -> m b) -> mofo -> m ()

oforM_ :: (MonoFoldable mofo, Monad m) => mofo -> (Element mofo -> m b) -> m ()

ofoldlM :: (MonoFoldable mofo, Monad m) => (a -> Element mofo -> m a) -> a -> mofo -> m a

Instances

MonoFoldable ByteString

MonoFoldable ByteString

MonoFoldable IntSet

MonoFoldable Text

MonoFoldable Text

MonoFoldable [a]

MonoFoldable (Maybe a)

MonoFoldable (Tree a)

MonoFoldable (Seq a)

MonoFoldable (ViewL a)

MonoFoldable (ViewR a)

MonoFoldable (IntMap a)

MonoFoldable (Set e)

MonoFoldable (Option a)

MonoFoldable (NonEmpty a)

MonoFoldable (Identity a)

MonoFoldable (HashSet e)

MonoFoldable (Vector a)

Unbox a => MonoFoldable (Vector a)

Storable a => MonoFoldable (Vector a)

MonoFoldable (Map k v)

MonoFoldable (HashMap k v)

osum :: (MonoFoldable mofo, Num (Element mofo)) => mofo -> Element mofo

The sum function computes the sum of the numbers of a structure.

oproduct :: (MonoFoldable mofo, Num (Element mofo)) => mofo -> Element mofo

The product function computes the product of the numbers of a structure.

class (MonoFoldable mofo, Monoid mofo) => MonoFoldableMonoid mofo where

Methods

oconcatMap :: (Element mofo -> mofo) -> mofo -> mofo

Instances

MonoFoldableMonoid ByteString

MonoFoldableMonoid ByteString

MonoFoldableMonoid Text

MonoFoldableMonoid Text

(MonoFoldable (t a), Monoid (t a)) => MonoFoldableMonoid (t a)

class (MonoFunctor mot, MonoFoldable mot) => MonoTraversable mot where

Methods

otraverse :: Applicative f => (Element mot -> f (Element mot)) -> mot -> f mot

omapM :: Monad m => (Element mot -> m (Element mot)) -> mot -> m mot

Instances

MonoTraversable ByteString

MonoTraversable ByteString

MonoTraversable Text

MonoTraversable Text

MonoTraversable [a]

MonoTraversable (Maybe a)

MonoTraversable (Tree a)

MonoTraversable (Seq a)

MonoTraversable (ViewL a)

MonoTraversable (ViewR a)

MonoTraversable (IntMap a)

MonoTraversable (Option a)

MonoTraversable (NonEmpty a)

MonoTraversable (Identity a)

MonoTraversable (Vector a)

Unbox a => MonoTraversable (Vector a)

Storable a => MonoTraversable (Vector a)

MonoTraversable (Map k v)

MonoTraversable (HashMap k v)

ofor :: (MonoTraversable mot, Applicative f) => mot -> (Element mot -> f (Element mot)) -> f mot

oforM :: (MonoTraversable mot, Monad f) => mot -> (Element mot -> f (Element mot)) -> f mot