-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | NonEmpty for Alternative types
--   
--   This package extends <tt>NonEmpty</tt> from <tt>semigroups</tt> for
--   arbitrary <tt>Alternative</tt> types.
@package nonempty-alternative
@version 0.4.0


-- | This package extends <tt>NonEmpty</tt> from <tt>semigroups</tt> to
--   arbitrary <tt>Alternative</tt> types. The method is the same as for
--   lists, by separating an element from the rest.
--   
--   There are two natural ways to merge an element <tt>x</tt> to the rest
--   of the structure <tt>xs</tt>. The first gives rise to
--   <tt>NonEmptyL</tt>:
--   
--   <pre>
--   flattenL :: NonEmptyL f a -&gt; f a
--   flattenL (x :&lt;: xs) = pure x &lt;|&gt; xs
--   </pre>
--   
--   The second gives rise to <tt>NonEmptyR</tt>:
--   
--   <pre>
--   flattenR :: NonEmptyR f a -&gt; f a
--   flattenR (xs :&gt;: x) = xs &lt;|&gt; pure x
--   </pre>
--   
--   The instances are made so that <tt>flattenL</tt> gives a type class
--   morphism between <tt>NonEmptyL List</tt> and <tt>List</tt>, and
--   <tt>flattenR</tt> gives the same for <tt>NonEmptyR RList</tt> and
--   <tt>RList</tt> from the package <tt>rlist</tt>.
module Data.NonEmpty

-- | The type <tt>NonEmptyL</tt> is well suited for <tt>cons</tt>
--   structures.
data NonEmptyL f a
(:<:) :: a -> f a -> NonEmptyL f a

-- | Extracts the structure's singular element. This function is total and
--   equivalent to <tt>extract</tt> from <tt>Comonad</tt>.
headL :: NonEmptyL f a -> a

-- | Extracts the structure's remaining data. This function is total.
tailL :: NonEmptyL f a -> f a

-- | Flattens the structure to its base type from the left.
flattenL :: Alternative f => NonEmptyL f a -> f a

-- | This is equivalent to <tt>join</tt> for <tt>Monad</tt>.
joinL :: (Alternative f, Monad f) => NonEmptyL f (NonEmptyL f a) -> NonEmptyL f a

-- | Budge the head into the remaining structure from the left, adding an
--   empty head.
budgeL :: (Alternative f, Alternative g) => NonEmptyL f (g a) -> NonEmptyL f (g a)

-- | The type <tt>NonEmptyR</tt> is well suited for <tt>snoc</tt>
--   structures.
data NonEmptyR f a
(:>:) :: f a -> a -> NonEmptyR f a

-- | Extracts the structure's singular element. This function is total and
--   equivalent to <tt>extract</tt> from <tt>Comonad</tt>.
lastR :: NonEmptyR f a -> a

-- | Extracts the structure's remaining data. This function is total.
initR :: NonEmptyR f a -> f a

-- | Flattens the structure to its base type from the right.
flattenR :: Alternative f => NonEmptyR f a -> f a

-- | This is equivalent to <tt>join</tt> for <tt>Monad</tt>.
joinR :: (Alternative f, Monad f) => NonEmptyR f (NonEmptyR f a) -> NonEmptyR f a

-- | Budge the head into the remaining structure from the right, adding an
--   empty head.
budgeR :: (Alternative f, Alternative g) => NonEmptyR f (g a) -> NonEmptyR f (g a)
instance GHC.Generics.Constructor Data.NonEmpty.C1_0NonEmptyR
instance GHC.Generics.Datatype Data.NonEmpty.D1NonEmptyR
instance GHC.Generics.Constructor Data.NonEmpty.C1_0NonEmptyL
instance GHC.Generics.Datatype Data.NonEmpty.D1NonEmptyL
instance GHC.Generics.Generic1 (Data.NonEmpty.NonEmptyR f)
instance GHC.Generics.Generic (Data.NonEmpty.NonEmptyR f a)
instance (Data.Data.Data a, Data.Data.Data (f a), Data.Typeable.Internal.Typeable f) => Data.Data.Data (Data.NonEmpty.NonEmptyR f a)
instance (GHC.Read.Read a, GHC.Read.Read (f a)) => GHC.Read.Read (Data.NonEmpty.NonEmptyR f a)
instance (GHC.Classes.Ord a, GHC.Classes.Ord (f a)) => GHC.Classes.Ord (Data.NonEmpty.NonEmptyR f a)
instance (GHC.Classes.Eq a, GHC.Classes.Eq (f a)) => GHC.Classes.Eq (Data.NonEmpty.NonEmptyR f a)
instance (GHC.Show.Show a, GHC.Show.Show (f a)) => GHC.Show.Show (Data.NonEmpty.NonEmptyR f a)
instance GHC.Generics.Generic1 (Data.NonEmpty.NonEmptyL f)
instance GHC.Generics.Generic (Data.NonEmpty.NonEmptyL f a)
instance (Data.Data.Data a, Data.Data.Data (f a), Data.Typeable.Internal.Typeable f) => Data.Data.Data (Data.NonEmpty.NonEmptyL f a)
instance (GHC.Read.Read a, GHC.Read.Read (f a)) => GHC.Read.Read (Data.NonEmpty.NonEmptyL f a)
instance (GHC.Classes.Ord a, GHC.Classes.Ord (f a)) => GHC.Classes.Ord (Data.NonEmpty.NonEmptyL f a)
instance (GHC.Classes.Eq a, GHC.Classes.Eq (f a)) => GHC.Classes.Eq (Data.NonEmpty.NonEmptyL f a)
instance (GHC.Show.Show a, GHC.Show.Show (f a)) => GHC.Show.Show (Data.NonEmpty.NonEmptyL f a)
instance GHC.Base.Functor f => GHC.Base.Functor (Data.NonEmpty.NonEmptyL f)
instance GHC.Base.Functor f => GHC.Base.Functor (Data.NonEmpty.NonEmptyR f)
instance GHC.Base.Alternative f => GHC.Base.Applicative (Data.NonEmpty.NonEmptyL f)
instance GHC.Base.Alternative f => GHC.Base.Applicative (Data.NonEmpty.NonEmptyR f)
instance (GHC.Base.Alternative f, GHC.Base.Monad f) => GHC.Base.Monad (Data.NonEmpty.NonEmptyL f)
instance GHC.Base.Alternative f => Control.Comonad.Comonad (Data.NonEmpty.NonEmptyL f)
instance GHC.Base.Alternative f => Control.Comonad.Comonad (Data.NonEmpty.NonEmptyR f)
instance Data.Foldable.Foldable f => Data.Foldable.Foldable (Data.NonEmpty.NonEmptyL f)
instance Data.Foldable.Foldable f => Data.Foldable.Foldable (Data.NonEmpty.NonEmptyR f)
instance (GHC.Base.Functor f, Data.Traversable.Traversable f) => Data.Traversable.Traversable (Data.NonEmpty.NonEmptyL f)
instance (GHC.Base.Functor f, Data.Traversable.Traversable f) => Data.Traversable.Traversable (Data.NonEmpty.NonEmptyR f)
instance GHC.Base.Alternative f => Data.Semigroup.Semigroup (Data.NonEmpty.NonEmptyL f a)
instance GHC.Base.Alternative f => Data.Semigroup.Semigroup (Data.NonEmpty.NonEmptyR f a)