Safe Haskell	None
Language	Haskell2010

Data.SOP.NonEmpty

Contents

Proofs
Working with NonEmpty

Description

Type-level non-empty lists

Synopsis

data NonEmpty (xs ∷ [Type]) a where
- NonEmptyOne ∷ ∀ a x (xs1 ∷ [Type]). !a → NonEmpty (x ': xs1) a
- NonEmptyCons ∷ ∀ a (xs1 ∷ [Type]) x. !a → !(NonEmpty xs1 a) → NonEmpty (x ': xs1) a
class IsNonEmpty (xs ∷ [a]) where
- isNonEmpty ∷ proxy xs → ProofNonEmpty xs
data ProofNonEmpty (xs ∷ [a]) where
- ProofNonEmpty ∷ ∀ {a} (x ∷ a) (xs1 ∷ [a]). Proxy x → Proxy xs1 → ProofNonEmpty (x ': xs1)
checkIsNonEmpty ∷ ∀ {a} (xs ∷ [a]). SListI xs ⇒ Proxy xs → Maybe (ProofNonEmpty xs)
nonEmptyFromList ∷ ∀ (xs ∷ [Type]) a. SListI xs ⇒ [a] → Maybe (NonEmpty xs a)
nonEmptyHead ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → a
nonEmptyInit ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → (Maybe (NonEmpty xs a), a)
nonEmptyLast ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → a
nonEmptyMapOne ∷ ∀ m (xs ∷ [Type]) a. Alternative m ⇒ (a → m a) → NonEmpty xs a → m (NonEmpty xs a)
nonEmptyMapTwo ∷ ∀ m (xs ∷ [Type]) a. Alternative m ⇒ (a → m a) → (a → a → m (a, a)) → NonEmpty xs a → m (NonEmpty xs a)
nonEmptyStrictPrefixes ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → [NonEmpty xs a]
nonEmptyToList ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → [a]

Documentation

data NonEmpty (xs ∷ [Type]) a where Source #

Non-empty variation on AtMost

Constructors

NonEmptyOne ∷ ∀ a x (xs1 ∷ [Type]). !a → NonEmpty (x ': xs1) a
NonEmptyCons ∷ ∀ a (xs1 ∷ [Type]) x. !a → !(NonEmpty xs1 a) → NonEmpty (x ': xs1) a

Instances

Instances details

(IsNonEmpty xs, SListI xs) ⇒ Applicative (NonEmpty xs) Source #
Instance details Defined in Data.SOP.NonEmpty Methods pure ∷ a → NonEmpty xs a # (<>) ∷ NonEmpty xs (a → b) → NonEmpty xs a → NonEmpty xs b # liftA2 ∷ (a → b → c) → NonEmpty xs a → NonEmpty xs b → NonEmpty xs c # (>) ∷ NonEmpty xs a → NonEmpty xs b → NonEmpty xs b # (<*) ∷ NonEmpty xs a → NonEmpty xs b → NonEmpty xs a #
Functor (NonEmpty xs) Source #
Instance details Defined in Data.SOP.NonEmpty Methods fmap ∷ (a → b) → NonEmpty xs a → NonEmpty xs b # (<$) ∷ a → NonEmpty xs b → NonEmpty xs a #
Foldable (NonEmpty xs) Source #
Instance details Defined in Data.SOP.NonEmpty Methods fold ∷ Monoid m ⇒ NonEmpty xs m → m # foldMap ∷ Monoid m ⇒ (a → m) → NonEmpty xs a → m # foldMap' ∷ Monoid m ⇒ (a → m) → NonEmpty xs a → m # foldr ∷ (a → b → b) → b → NonEmpty xs a → b # foldr' ∷ (a → b → b) → b → NonEmpty xs a → b # foldl ∷ (b → a → b) → b → NonEmpty xs a → b # foldl' ∷ (b → a → b) → b → NonEmpty xs a → b # foldr1 ∷ (a → a → a) → NonEmpty xs a → a # foldl1 ∷ (a → a → a) → NonEmpty xs a → a # toList ∷ NonEmpty xs a → [a] # null ∷ NonEmpty xs a → Bool # length ∷ NonEmpty xs a → Int # elem ∷ Eq a ⇒ a → NonEmpty xs a → Bool # maximum ∷ Ord a ⇒ NonEmpty xs a → a # minimum ∷ Ord a ⇒ NonEmpty xs a → a # sum ∷ Num a ⇒ NonEmpty xs a → a # product ∷ Num a ⇒ NonEmpty xs a → a #
Traversable (NonEmpty xs) Source #
Instance details Defined in Data.SOP.NonEmpty Methods traverse ∷ Applicative f ⇒ (a → f b) → NonEmpty xs a → f (NonEmpty xs b) # sequenceA ∷ Applicative f ⇒ NonEmpty xs (f a) → f (NonEmpty xs a) # mapM ∷ Monad m ⇒ (a → m b) → NonEmpty xs a → m (NonEmpty xs b) # sequence ∷ Monad m ⇒ NonEmpty xs (m a) → m (NonEmpty xs a) #
Show a ⇒ Show (NonEmpty xs a) Source #
Instance details Defined in Data.SOP.NonEmpty Methods showsPrec ∷ Int → NonEmpty xs a → ShowS # show ∷ NonEmpty xs a → String # showList ∷ [NonEmpty xs a] → ShowS #
Eq a ⇒ Eq (NonEmpty xs a) Source #
Instance details Defined in Data.SOP.NonEmpty Methods (==) ∷ NonEmpty xs a → NonEmpty xs a → Bool # (/=) ∷ NonEmpty xs a → NonEmpty xs a → Bool #

Proofs

class IsNonEmpty (xs ∷ [a]) where Source #

Methods

isNonEmpty ∷ proxy xs → ProofNonEmpty xs Source #

Instances

Instances details

IsNonEmpty (x ': xs ∷ [a]) Source #
Instance details Defined in Data.SOP.NonEmpty Methods isNonEmpty ∷ proxy (x ': xs) → ProofNonEmpty (x ': xs) Source #

data ProofNonEmpty (xs ∷ [a]) where Source #

Constructors

ProofNonEmpty ∷ ∀ {a} (x ∷ a) (xs1 ∷ [a]). Proxy x → Proxy xs1 → ProofNonEmpty (x ': xs1)

checkIsNonEmpty ∷ ∀ {a} (xs ∷ [a]). SListI xs ⇒ Proxy xs → Maybe (ProofNonEmpty xs) Source #

Working with `NonEmpty`

nonEmptyFromList ∷ ∀ (xs ∷ [Type]) a. SListI xs ⇒ [a] → Maybe (NonEmpty xs a) Source #

Build a NonEmpty from a list. Returns Nothing when the list is empty or when it's longer than xs.

nonEmptyHead ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → a Source #

Analogue of head

nonEmptyInit ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → (Maybe (NonEmpty xs a), a) Source #

Analogue of init

nonEmptyLast ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → a Source #

Analogue of last

nonEmptyMapOne ∷ ∀ m (xs ∷ [Type]) a. Alternative m ⇒ (a → m a) → NonEmpty xs a → m (NonEmpty xs a) Source #

Apply the specified function to exactly one element

nonEmptyMapTwo ∷ ∀ m (xs ∷ [Type]) a. Alternative m ⇒ (a → m a) → (a → a → m (a, a)) → NonEmpty xs a → m (NonEmpty xs a) Source #

Variation on nonEmptyMapOne where we try to apply the function to pairs of elements

nonEmptyStrictPrefixes ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → [NonEmpty xs a] Source #

A strict prefixes

   nonEmptyStrictPrefixes (fromJust (nonEmptyFromList [1..4]))
== [ NonEmptyOne  1
   , NonEmptyCons 1 $ NonEmptyOne  2
   , NonEmptyCons 1 $ NonEmptyCons 2 $ NonEmptyOne 3
   ]

nonEmptyToList ∷ ∀ (xs ∷ [Type]) a. NonEmpty xs a → [a] Source #

Convert a NonEmpty to a list.

Documentation

Instances

Proofs

Instances

Working with NonEmpty

Working with `NonEmpty`