Safe Haskell	Safe-Inferred
Language	Haskell98

Data.NonEmpty

Synopsis

data T (f :: Type -> Type) a = Cons {
- head :: a
- tail :: f a
}
(!:) :: a -> f a -> T f a
force :: forall (f :: Type -> Type) a. T f a -> T f a
apply :: forall (f :: Type -> Type) a b. (Applicative f, Cons f, Append f) => T f (a -> b) -> T f a -> T f b
bind :: forall (f :: Type -> Type) a b. (Monad f, Cons f, Append f) => T f a -> (a -> T f b) -> T f b
toList :: forall (f :: Type -> Type) a. Foldable f => T f a -> [a]
flatten :: Cons f => T f a -> f a
fetch :: ViewL f => f a -> Maybe (T f a)
cons :: a -> f a -> T f a
snoc :: Traversable f => f a -> a -> T f a
singleton :: forall (f :: Type -> Type) a. Empty f => a -> T f a
reverse :: forall (f :: Type -> Type) a. (Traversable f, Reverse f) => T f a -> T f a
mapHead :: forall a (f :: Type -> Type). (a -> a) -> T f a -> T f a
mapTail :: (f a -> g a) -> T f a -> T g a
viewL :: T f a -> (a, f a)
viewR :: Traversable f => T f a -> (f a, a)
init :: Traversable f => T f a -> f a
last :: forall (f :: Type -> Type) a. Foldable f => T f a -> a
foldl1 :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> a) -> T f a -> a
foldl1Map :: forall (f :: Type -> Type) b a. Foldable f => (b -> b -> b) -> (a -> b) -> T f a -> b
foldBalanced :: (a -> a -> a) -> T [] a -> a
foldBalancedStrict :: (a -> a -> a) -> T [] a -> a
maximum :: forall a (f :: Type -> Type). (Ord a, Foldable f) => T f a -> a
maximumBy :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> Ordering) -> T f a -> a
maximumKey :: forall b (f :: Type -> Type) a. (Ord b, Foldable f) => (a -> b) -> T f a -> a
minimum :: forall a (f :: Type -> Type). (Ord a, Foldable f) => T f a -> a
minimumBy :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> Ordering) -> T f a -> a
minimumKey :: forall b (f :: Type -> Type) a. (Ord b, Foldable f) => (a -> b) -> T f a -> a
sum :: forall a (f :: Type -> Type). (Num a, Foldable f) => T f a -> a
product :: forall a (f :: Type -> Type). (Num a, Foldable f) => T f a -> a
chop :: (a -> Bool) -> [a] -> T [] [a]
append :: forall (f :: Type -> Type) a. (Append f, Traversable f) => T f a -> T f a -> T (T f) a
appendLeft :: (Append f, Traversable f) => f a -> T f a -> T f a
appendRight :: Append f => T f a -> f a -> T f a
cycle :: forall (f :: Type -> Type) a. (Cons f, Append f) => T f a -> T f a
zipWith :: forall (f :: Type -> Type) a b c. Zip f => (a -> b -> c) -> T f a -> T f b -> T f c
mapAdjacent :: Traversable f => (a -> a -> b) -> T f a -> f b
class Insert (f :: Type -> Type) where
- insert :: Ord a => a -> f a -> T f a
insertDefault :: (Ord a, InsertBy f, SortBy f) => a -> f a -> T f a
class Insert f => InsertBy (f :: Type -> Type) where
- insertBy :: (a -> a -> Ordering) -> a -> f a -> T f a
scanl :: Traversable f => (b -> a -> b) -> b -> f a -> T f b
scanr :: Traversable f => (a -> b -> b) -> b -> f a -> T f b
tails :: (Traversable f, Cons g, Empty g) => f a -> T f (g a)
inits :: (Traversable f, Snoc g, Empty g) => f a -> T f (g a)
initsRev :: (Traversable f, Cons g, Empty g, Reverse g) => f a -> T f (g a)
removeEach :: Traversable f => T f a -> T f (a, f a)
takeUntil :: (a -> Bool) -> T [] a -> T [] a
partitionEithersLeft :: T [] (Either a b) -> Either (T [] a) ([a], T [] b)
partitionEithersRight :: T [] (Either a b) -> Either (T [] a, [b]) (T [] b)

Documentation

data T (f :: Type -> Type) a Source #

The type T can be used for many kinds of list-like structures with restrictions on the size.

T [] a is a lazy list containing at least one element.
T (T []) a is a lazy list containing at least two elements.
T Vector a is a vector with at least one element. You may also use unboxed vectors but the first element will be stored in a box and you will not be able to use many functions from this module.
T Maybe a is a list that contains one or two elements.
Maybe is isomorphic to Optional Empty.
T Empty a is a list that contains exactly one element.
T (T Empty) a is a list that contains exactly two elements.
Optional (T Empty) a is a list that contains zero or two elements.
You can create a list type for every finite set of allowed list length by nesting Optional and NonEmpty constructors. If list length n is allowed, then place Optional at depth n, if it is disallowed then place NonEmpty. The maximum length is marked by Empty.

Constructors

Cons
Fields head :: a tail :: f a

Instances

Instances details

Foldable f => Foldable (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods fold :: Monoid m => T f m -> m # foldMap :: Monoid m => (a -> m) -> T f a -> m # foldMap' :: Monoid m => (a -> m) -> T f a -> m # foldr :: (a -> b -> b) -> b -> T f a -> b # foldr' :: (a -> b -> b) -> b -> T f a -> b # foldl :: (b -> a -> b) -> b -> T f a -> b # foldl' :: (b -> a -> b) -> b -> T f a -> b # foldr1 :: (a -> a -> a) -> T f a -> a # foldl1 :: (a -> a -> a) -> T f a -> a # toList :: T f a -> [a] # null :: T f a -> Bool # length :: T f a -> Int # elem :: Eq a => a -> T f a -> Bool # maximum :: Ord a => T f a -> a # minimum :: Ord a => T f a -> a # sum :: Num a => T f a -> a # product :: Num a => T f a -> a #
Traversable f => Traversable (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods traverse :: Applicative f0 => (a -> f0 b) -> T f a -> f0 (T f b) # sequenceA :: Applicative f0 => T f (f0 a) -> f0 (T f a) # mapM :: Monad m => (a -> m b) -> T f a -> m (T f b) # sequence :: Monad m => T f (m a) -> m (T f a) #
(Applicative f, Empty f, Cons f, Append f) => Applicative (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods pure :: a -> T f a # (<>) :: T f (a -> b) -> T f a -> T f b # liftA2 :: (a -> b -> c) -> T f a -> T f b -> T f c # (>) :: T f a -> T f b -> T f b # (<*) :: T f a -> T f b -> T f a #
Functor f => Functor (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods fmap :: (a -> b) -> T f a -> T f b # (<$) :: a -> T f b -> T f a #
(Monad f, Empty f, Cons f, Append f) => Monad (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods (>>=) :: T f a -> (a -> T f b) -> T f b # (>>) :: T f a -> T f b -> T f b # return :: a -> T f a #
(Cons f, Append f) => Append (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods append :: T f a -> T f a -> T f a Source #
Arbitrary f => Arbitrary (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods arbitrary :: Arbitrary a => Gen (T f a) Source # shrink :: Arbitrary a => T f a -> [T f a] Source #
Cons f => Cons (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods cons :: a -> T f a -> T f a Source #
Gen f => Gen (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods genOf :: Gen a -> Gen (T f a) Source #
Iterate f => Iterate (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods iterate :: (a -> a) -> a -> T f a Source #
Ix f => Ix (T f) Source #	forRange $ \b0 -> forRange $ \b1 -> forRange $ \b2 -> let b = FuncHT.unzip $ b0!:b1!:b2!:Empty.Cons in map (Ix.index b) (Ix.range b) == take (Ix.rangeSize b) [0..]
Instance details Defined in Data.NonEmptyPrivate Methods range :: Ix i => (T f i, T f i) -> [T f i] Source # index :: Ix i => (T f i, T f i) -> T f i -> Int Source # inRange :: Ix i => (T f i, T f i) -> T f i -> Bool Source # rangeSize :: Ix i => (T f i, T f i) -> Int Source # rangeSizeIndex :: Ix i => (T f i, T f i) -> (Int, T f i -> Int) Source # indexHorner :: Ix i => (T f i, T f i) -> Int -> T f i -> Int Source #
NFData f => NFData (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods rnf :: NFData a => T f a -> () Source #
Repeat f => Repeat (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods repeat :: a -> T f a Source #
(Traversable f, Reverse f) => Reverse (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods reverse :: T f a -> T f a Source #
Show f => Show (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods showsPrec :: Show a => Int -> T f a -> ShowS Source #
Empty f => Singleton (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods singleton :: a -> T f a Source #
Snoc f => Snoc (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods snoc :: T f a -> a -> T f a Source #
(Sort f, InsertBy f) => Sort (T f) Source #	If you nest too many non-empty lists then the efficient merge-sort (linear-logarithmic runtime) will degenerate to an inefficient insert-sort (quadratic runtime).
Instance details Defined in Data.NonEmptyPrivate Methods sort :: Ord a => T f a -> T f a Source #
(SortBy f, InsertBy f) => SortBy (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods sortBy :: (a -> a -> Ordering) -> T f a -> T f a Source #
ViewL f => ViewL (T f) Source #	Caution: `viewL (NonEmpty.Cons x []) = Nothing` because the tail is empty, and thus cannot be NonEmpty! This instance mainly exist to allow cascaded applications of `fetch`.
Instance details Defined in Data.NonEmptyPrivate Methods viewL :: T f a -> Maybe (a, T f a) Source #
Zip f => Zip (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods zipWith :: (a -> b -> c) -> T f a -> T f b -> T f c Source #
Choose f => Choose (T f) Source #
Instance details Defined in Data.NonEmpty.Mixed Methods choose :: [a] -> [T f a] Source #
Insert f => Insert (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> T f a -> T (T f) a Source #
InsertBy f => InsertBy (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> T f a -> T (T f) a Source #
(Arbitrary a, Arbitrary f) => Arbitrary (T f a) Source #
Instance details Defined in Data.NonEmptyPrivate Methods arbitrary :: Gen (T f a) # shrink :: T f a -> [T f a] #
(Ix f, Ix i, Ord (f i)) => Ix (T f i) Source #
Instance details Defined in Data.NonEmptyPrivate Methods range :: (T f i, T f i) -> [T f i] # index :: (T f i, T f i) -> T f i -> Int # unsafeIndex :: (T f i, T f i) -> T f i -> Int # inRange :: (T f i, T f i) -> T f i -> Bool # rangeSize :: (T f i, T f i) -> Int # unsafeRangeSize :: (T f i, T f i) -> Int #
(Show f, Show a) => Show (T f a) Source #
Instance details Defined in Data.NonEmptyPrivate Methods showsPrec :: Int -> T f a -> ShowS # show :: T f a -> String # showList :: [T f a] -> ShowS #
(NFData f, NFData a) => NFData (T f a) Source #
Instance details Defined in Data.NonEmptyPrivate Methods rnf :: T f a -> () #
(Eq a, Eq (f a)) => Eq (T f a) Source #
Instance details Defined in Data.NonEmptyPrivate Methods (==) :: T f a -> T f a -> Bool # (/=) :: T f a -> T f a -> Bool #
(Ord a, Ord (f a)) => Ord (T f a) Source #
Instance details Defined in Data.NonEmptyPrivate Methods compare :: T f a -> T f a -> Ordering # (<) :: T f a -> T f a -> Bool # (<=) :: T f a -> T f a -> Bool # (>) :: T f a -> T f a -> Bool # (>=) :: T f a -> T f a -> Bool # max :: T f a -> T f a -> T f a # min :: T f a -> T f a -> T f a #

(!:) :: a -> f a -> T f a infixr 5 Source #

force :: forall (f :: Type -> Type) a. T f a -> T f a Source #

Force immediate generation of Cons.

apply :: forall (f :: Type -> Type) a b. (Applicative f, Cons f, Append f) => T f (a -> b) -> T f a -> T f b Source #

Implementation of <*> without the Empty constraint that is needed for pure.

bind :: forall (f :: Type -> Type) a b. (Monad f, Cons f, Append f) => T f a -> (a -> T f b) -> T f b Source #

Implementation of >>= without the Empty constraint that is needed for return.

toList :: forall (f :: Type -> Type) a. Foldable f => T f a -> [a] Source #

flatten :: Cons f => T f a -> f a Source #

fetch :: ViewL f => f a -> Maybe (T f a) Source #

cons :: a -> f a -> T f a Source #

Synonym for Cons. For symmetry to snoc.

snoc :: Traversable f => f a -> a -> T f a Source #

singleton :: forall (f :: Type -> Type) a. Empty f => a -> T f a Source #

reverse :: forall (f :: Type -> Type) a. (Traversable f, Reverse f) => T f a -> T f a Source #

mapHead :: forall a (f :: Type -> Type). (a -> a) -> T f a -> T f a Source #

mapTail :: (f a -> g a) -> T f a -> T g a Source #

viewL :: T f a -> (a, f a) Source #

viewR :: Traversable f => T f a -> (f a, a) Source #

init :: Traversable f => T f a -> f a Source #

last :: forall (f :: Type -> Type) a. Foldable f => T f a -> a Source #

foldl1 :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> a) -> T f a -> a Source #

foldl1Map :: forall (f :: Type -> Type) b a. Foldable f => (b -> b -> b) -> (a -> b) -> T f a -> b Source #

It holds:

foldl1Map f g = foldl1 f . fmap g

but foldl1Map does not need a Functor instance.

foldBalanced :: (a -> a -> a) -> T [] a -> a Source #

Fold a non-empty list in a balanced way. Balanced means that each element has approximately the same depth in the operator tree. Approximately the same depth means that the difference between maximum and minimum depth is at most 1. The accumulation operation must be associative and commutative in order to get the same result as foldl1 or foldr1.

foldBalancedStrict :: (a -> a -> a) -> T [] a -> a Source #

maximum :: forall a (f :: Type -> Type). (Ord a, Foldable f) => T f a -> a Source #

maximum is a total function

maximumBy :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> Ordering) -> T f a -> a Source #

maximumBy is a total function

maximumKey :: forall b (f :: Type -> Type) a. (Ord b, Foldable f) => (a -> b) -> T f a -> a Source #

maximumKey is a total function

minimum :: forall a (f :: Type -> Type). (Ord a, Foldable f) => T f a -> a Source #

minimum is a total function

minimumBy :: forall (f :: Type -> Type) a. Foldable f => (a -> a -> Ordering) -> T f a -> a Source #

minimumBy is a total function

minimumKey :: forall b (f :: Type -> Type) a. (Ord b, Foldable f) => (a -> b) -> T f a -> a Source #

minimumKey is a total function

sum :: forall a (f :: Type -> Type). (Num a, Foldable f) => T f a -> a Source #

sum does not need a zero for initialization

product :: forall a (f :: Type -> Type). (Num a, Foldable f) => T f a -> a Source #

product does not need a one for initialization

chop :: (a -> Bool) -> [a] -> T [] [a] Source #

append :: forall (f :: Type -> Type) a. (Append f, Traversable f) => T f a -> T f a -> T (T f) a infixr 5 Source #

appendLeft :: (Append f, Traversable f) => f a -> T f a -> T f a infixr 5 Source #

appendRight :: Append f => T f a -> f a -> T f a infixr 5 Source #

cycle :: forall (f :: Type -> Type) a. (Cons f, Append f) => T f a -> T f a Source #

generic variants: cycle or better Semigroup.cycle

zipWith :: forall (f :: Type -> Type) a b c. Zip f => (a -> b -> c) -> T f a -> T f b -> T f c Source #

mapAdjacent :: Traversable f => (a -> a -> b) -> T f a -> f b Source #

class Insert (f :: Type -> Type) where Source #

Methods

insert :: Ord a => a -> f a -> T f a Source #

Insert an element into an ordered list while preserving the order.

Instances

Instances details

Insert Seq Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> Seq a -> T Seq a Source #
Insert T Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> T a -> T T a Source #
Insert Maybe Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> Maybe a -> T Maybe a Source #
Insert [] Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> [a] -> T [] a Source #
Insert f => Insert (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods insert :: Ord a => a -> T f a -> T (T f) a Source #
Insert f => Insert (T f) Source #
Instance details Defined in Data.Optional Methods insert :: Ord a => a -> T f a -> T (T f) a Source #

insertDefault :: (Ord a, InsertBy f, SortBy f) => a -> f a -> T f a Source #

Default implementation for insert based on insertBy.

class Insert f => InsertBy (f :: Type -> Type) where Source #

Methods

insertBy :: (a -> a -> Ordering) -> a -> f a -> T f a Source #

Instances

Instances details

InsertBy Seq Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> Seq a -> T Seq a Source #
InsertBy T Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> T a -> T T a Source #
InsertBy Maybe Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> Maybe a -> T Maybe a Source #
InsertBy [] Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> [a] -> T [] a Source #
InsertBy f => InsertBy (T f) Source #
Instance details Defined in Data.NonEmptyPrivate Methods insertBy :: (a -> a -> Ordering) -> a -> T f a -> T (T f) a Source #
InsertBy f => InsertBy (T f) Source #
Instance details Defined in Data.Optional Methods insertBy :: (a -> a -> Ordering) -> a -> T f a -> T (T f) a Source #

scanl :: Traversable f => (b -> a -> b) -> b -> f a -> T f b Source #

scanr :: Traversable f => (a -> b -> b) -> b -> f a -> T f b Source #

tails :: (Traversable f, Cons g, Empty g) => f a -> T f (g a) Source #

inits :: (Traversable f, Snoc g, Empty g) => f a -> T f (g a) Source #

Only advised for structures with efficient appending of single elements like Sequence. Alternatively you may consider initsRev.

initsRev :: (Traversable f, Cons g, Empty g, Reverse g) => f a -> T f (g a) Source #

removeEach :: Traversable f => T f a -> T f (a, f a) Source #

takeUntil :: (a -> Bool) -> T [] a -> T [] a Source #

let takeUntil p xs = NonEmpty.zipWith const xs $ () !: void (takeWhile (not . p) $ NonEmpty.flatten xs) in \k xs -> takeUntil (>=k) xs == NonEmpty.takeUntil (>=(k::Int)) xs

partitionEithersLeft :: T [] (Either a b) -> Either (T [] a) ([a], T [] b) Source #

\xs -> mapMaybe EitherHT.maybeLeft (NonEmpty.flatten xs) == either NonEmpty.flatten fst (NonEmpty.partitionEithersLeft (xs::NonEmpty.T[](Either Char Int)))

\xs -> mapMaybe EitherHT.maybeRight (NonEmpty.flatten xs) == either (const []) (NonEmpty.flatten . snd) (NonEmpty.partitionEithersLeft (xs::NonEmpty.T[](Either Char Int)))

\xs -> NonEmpty.partitionEithersRight (fmap EitherHT.swap xs) == EitherHT.mapLeft swap (EitherHT.swap (NonEmpty.partitionEithersLeft (xs::NonEmpty.T[](Either Char Int))))

partitionEithersRight :: T [] (Either a b) -> Either (T [] a, [b]) (T [] b) Source #

\xs -> NonEmpty.partitionEithersLeft (fmap EitherHT.swap xs) == EitherHT.mapRight swap (EitherHT.swap (NonEmpty.partitionEithersRight (xs::NonEmpty.T[](Either Char Int))))