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 mono

Instances

type Element ByteString = Word8

type Element ByteString = Word8

type Element IntSet = Int

type Element Text = Char

type Element Text = Char

type Element [a] = a

type Element (IO a) = a

type Element (ZipList a) = a

type Element (Maybe a) = a

type Element (IntMap a) = a

type Element (Set e) = e

type Element (Tree a) = a

type Element (Seq a) = a

type Element (ViewL a) = a

type Element (ViewR a) = a

type Element (Vector a) = a

type Element (HashSet e) = e

type Element (NonEmpty a) = a

type Element (Option a) = a

type Element (Identity a) = a

type Element (Vector a) = a

type Element (Vector a) = a

type Element (DList a) = a

type Element (r -> a) = a

type Element (Either a b) = b

type Element (a, b) = b

type Element (Const m a) = a

type Element (WrappedMonad m a) = a

type Element (Map k v) = v

type Element (HashMap k v) = v

type Element (MaybeT m a) = a

type Element (ListT m a) = a

type Element (IdentityT m a) = a

type Element (WrappedApplicative f a) = a

type Element (MaybeApply f a) = a

type Element (MinLen nat mono) = Element mono

type Element (WrappedArrow a b c) = c

type Element (Cokleisli w a b) = b

type Element (WriterT w m a) = a

type Element (WriterT w m a) = a

type Element (StateT s m a) = a

type Element (StateT s m a) = a

type Element (ReaderT r m a) = a

type Element (ErrorT e m a) = a

type Element (ContT r m a) = a

type Element (Compose f g a) = a

type Element (Product f g a) = a

type Element (Static f a b) = b

type Element (RWST r w s m a) = a

type Element (RWST r w s m a) = a

class MonoFunctor mono where

Minimal complete definition

Nothing

Methods

omap :: (Element mono -> Element mono) -> mono -> mono

Instances

MonoFunctor ByteString

MonoFunctor ByteString

MonoFunctor Text

MonoFunctor Text

MonoFunctor [a]

MonoFunctor (IO a)

MonoFunctor (ZipList a)

MonoFunctor (Maybe a)

MonoFunctor (IntMap a)

MonoFunctor (Tree a)

MonoFunctor (Seq a)

MonoFunctor (ViewL a)

MonoFunctor (ViewR a)

Storable a => MonoFunctor (Vector a)

MonoFunctor (NonEmpty a)

MonoFunctor (Option a)

MonoFunctor (Identity a)

MonoFunctor (Vector a)

Unbox a => MonoFunctor (Vector a)

MonoFunctor (DList 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)

MonoFunctor (HashMap k v)

Functor m => MonoFunctor (MaybeT m a)

Functor m => MonoFunctor (ListT m a)

Functor m => MonoFunctor (IdentityT m a)

Functor f => MonoFunctor (WrappedApplicative f a)

Functor f => MonoFunctor (MaybeApply f a)

MonoFunctor mono => MonoFunctor (MinLen nat mono)

Arrow a => MonoFunctor (WrappedArrow a b c)

MonoFunctor (Cokleisli w 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 (ErrorT e 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 f => MonoFunctor (Static f a b)

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

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

class MonoFoldable mono where

Minimal complete definition

Nothing

Methods

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

Note: this is a partial function. On an empty MonoFoldable, it will throw an exception. See Data.NonNull for a total version of this function.

ofoldr1Ex :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono

Note: this is a partial function. On an empty MonoFoldable, it will throw an exception. See Data.NonNull for a total version of this function.

ofoldl1Ex' :: (Element mono -> Element mono -> Element mono) -> mono -> Element mono

Note: this is a partial function. On an empty MonoFoldable, it will throw an exception. See Data.NonNull for a total version of this function.

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

Instances

MonoFoldable ByteString

MonoFoldable ByteString

MonoFoldable IntSet

MonoFoldable Text

MonoFoldable Text

MonoFoldable [a]

MonoFoldable (Maybe a)

MonoFoldable (IntMap a)

MonoFoldable (Set e)

MonoFoldable (Tree a)

MonoFoldable (Seq a)

MonoFoldable (ViewL a)

MonoFoldable (ViewR a)

Storable a => MonoFoldable (Vector a)

MonoFoldable (HashSet e)

MonoFoldable (NonEmpty a)

MonoFoldable (Option a)

MonoFoldable (Identity a)

MonoFoldable (Vector a)

Unbox a => MonoFoldable (Vector a)

MonoFoldable (DList a)

MonoFoldable (Either a b)

MonoFoldable (Map k v)

MonoFoldable (HashMap k v)

MonoFoldable mono => MonoFoldable (MinLen nat mono)

headMay :: MonoFoldable mono => mono -> Maybe (Element mono)

like Data.List.head, but not partial

lastMay :: MonoFoldable mono => mono -> Maybe (Element mono)

like Data.List.last, but not partial

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

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

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

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

oand :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool

Are all of the values True?

Since 0.6.0

oor :: (Element mono ~ Bool, MonoFoldable mono) => mono -> Bool

Are any of the values True?

Since 0.6.0

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

Minimal complete definition

Nothing

Methods

oconcatMap :: (Element mono -> mono) -> mono -> mono

Instances

MonoFoldableMonoid ByteString

MonoFoldableMonoid ByteString

MonoFoldableMonoid Text

MonoFoldableMonoid Text

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

class (MonoFoldable mono, Eq (Element mono)) => MonoFoldableEq mono where

A typeclass for MonoFoldables containing elements which are an instance of Eq.

Minimal complete definition

Nothing

Methods

oelem :: Element mono -> mono -> Bool

onotElem :: Element mono -> mono -> Bool

Instances

MonoFoldableEq ByteString

MonoFoldableEq ByteString

MonoFoldableEq IntSet

MonoFoldableEq Text

MonoFoldableEq Text

Eq a => MonoFoldableEq [a]

Eq a => MonoFoldableEq (Maybe a)

Eq a => MonoFoldableEq (IntMap a)

(Eq a, Ord a) => MonoFoldableEq (Set a)

Eq a => MonoFoldableEq (Tree a)

Eq a => MonoFoldableEq (Seq a)

Eq a => MonoFoldableEq (ViewL a)

Eq a => MonoFoldableEq (ViewR a)

(Eq a, Storable a) => MonoFoldableEq (Vector a)

Eq a => MonoFoldableEq (HashSet a)

Eq a => MonoFoldableEq (NonEmpty a)

Eq a => MonoFoldableEq (Option a)

Eq a => MonoFoldableEq (Identity a)

Eq a => MonoFoldableEq (Vector a)

(Eq a, Unbox a) => MonoFoldableEq (Vector a)

Eq a => MonoFoldableEq (DList a)

Eq b => MonoFoldableEq (Either a b)

Eq v => MonoFoldableEq (Map k v)

Eq v => MonoFoldableEq (HashMap k v)

class (MonoFoldable mono, Ord (Element mono)) => MonoFoldableOrd mono where

A typeclass for MonoFoldables containing elements which are an instance of Ord.

Minimal complete definition

Nothing

Methods

maximumEx :: mono -> Element mono

minimumEx :: mono -> Element mono

Instances

MonoFoldableOrd ByteString

MonoFoldableOrd ByteString

MonoFoldableOrd IntSet

MonoFoldableOrd Text

MonoFoldableOrd Text

Ord a => MonoFoldableOrd [a]

Ord a => MonoFoldableOrd (Maybe a)

Ord a => MonoFoldableOrd (IntMap a)

Ord e => MonoFoldableOrd (Set e)

Ord a => MonoFoldableOrd (Tree a)

Ord a => MonoFoldableOrd (Seq a)

Ord a => MonoFoldableOrd (ViewL a)

Ord a => MonoFoldableOrd (ViewR a)

(Ord a, Storable a) => MonoFoldableOrd (Vector a)

Ord e => MonoFoldableOrd (HashSet e)

Ord a => MonoFoldableOrd (NonEmpty a)

Ord a => MonoFoldableOrd (Option a)

Ord a => MonoFoldableOrd (Identity a)

Ord a => MonoFoldableOrd (Vector a)

(Unbox a, Ord a) => MonoFoldableOrd (Vector a)

Ord b => MonoFoldableOrd (Either a b)

Ord v => MonoFoldableOrd (Map k v)

Ord v => MonoFoldableOrd (HashMap k v)

MonoFoldableOrd mono => MonoFoldableOrd (MinLen nat mono)

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

Minimal complete definition

Nothing

Methods

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

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

Instances

MonoTraversable ByteString

MonoTraversable ByteString

MonoTraversable Text

MonoTraversable Text

MonoTraversable [a]

MonoTraversable (Maybe a)

MonoTraversable (IntMap a)

MonoTraversable (Tree a)

MonoTraversable (Seq a)

MonoTraversable (ViewL a)

MonoTraversable (ViewR a)

Storable a => MonoTraversable (Vector a)

MonoTraversable (NonEmpty a)

MonoTraversable (Option a)

MonoTraversable (Identity a)

MonoTraversable (Vector a)

Unbox a => MonoTraversable (Vector a)

MonoTraversable (DList a)

MonoTraversable (Either a b)

MonoTraversable (Map k v)

MonoTraversable (HashMap k v)

MonoTraversable mono => MonoTraversable (MinLen nat mono)

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

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

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

opoint is the same as pure for an Applicative

For any MonoFunctor, the following law holds:

omap f . point = point . f

Minimal complete definition

Nothing

Methods

opoint :: Element mono -> mono

Instances

MonoPointed ByteString

MonoPointed ByteString

MonoPointed IntSet

MonoPointed Text

MonoPointed Text

MonoPointed [a]

MonoPointed (Maybe a)

MonoPointed (Set a)

MonoPointed (Seq a)

Storable a => MonoPointed (Vector a)

Hashable a => MonoPointed (HashSet a)

MonoPointed (NonEmpty a)

MonoPointed (Option a)

MonoPointed (Identity a)

MonoPointed (Vector a)

Unbox a => MonoPointed (Vector a)

MonoPointed (DList a)

MonoPointed (Either a b)

MonoPointed mono => MonoPointed (MinLen (Succ Zero) mono)

MonoPointed mono => MonoPointed (MinLen Zero mono)