vector-0.4: Efficient Arrays Source code Contents Index

Data.Vector.Fusion.Stream.Monadic Portability non-portable Stability experimental Maintainer Roman Leshchinskiy <rl@cse.unsw.edu.au>

Contents Size hints Length Construction Accessing elements Substreams Mapping Zipping Filtering Searching Folding Specialised folds Unfolding Scans Conversions

Description

Monadic streams

Synopsis

data Stream m a = forall s . Stream (s -> m (Step s a)) s Size data Step s a = Yield a s | Skip s | Done size :: Stream m a -> Size sized :: Stream m a -> Size -> Stream m a length :: Monad m => Stream m a -> m Int null :: Monad m => Stream m a -> m Bool empty :: Monad m => Stream m a singleton :: Monad m => a -> Stream m a cons :: Monad m => a -> Stream m a -> Stream m a snoc :: Monad m => Stream m a -> a -> Stream m a replicate :: Monad m => Int -> a -> Stream m a (++) :: Monad m => Stream m a -> Stream m a -> Stream m a head :: Monad m => Stream m a -> m a last :: Monad m => Stream m a -> m a (!!) :: Monad m => Stream m a -> Int -> m a extract :: Monad m => Stream m a -> Int -> Int -> Stream m a init :: Monad m => Stream m a -> Stream m a tail :: Monad m => Stream m a -> Stream m a take :: Monad m => Int -> Stream m a -> Stream m a drop :: Monad m => Int -> Stream m a -> Stream m a map :: Monad m => (a -> b) -> Stream m a -> Stream m b mapM :: Monad m => (a -> m b) -> Stream m a -> Stream m b mapM_ :: Monad m => (a -> m b) -> Stream m a -> m () trans :: (Monad m, Monad m') => (forall a. m a -> m' a) -> Stream m a -> Stream m' a concatMap :: Monad m => (a -> Stream m b) -> Stream m a -> Stream m b zipWith :: Monad m => (a -> b -> c) -> Stream m a -> Stream m b -> Stream m c zipWithM :: Monad m => (a -> b -> m c) -> Stream m a -> Stream m b -> Stream m c zipWith3 :: Monad m => (a -> b -> c -> d) -> Stream m a -> Stream m b -> Stream m c -> Stream m d zipWith3M :: Monad m => (a -> b -> c -> m d) -> Stream m a -> Stream m b -> Stream m c -> Stream m d filter :: Monad m => (a -> Bool) -> Stream m a -> Stream m a filterM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a takeWhile :: Monad m => (a -> Bool) -> Stream m a -> Stream m a takeWhileM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a dropWhile :: Monad m => (a -> Bool) -> Stream m a -> Stream m a dropWhileM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a elem :: (Monad m, Eq a) => a -> Stream m a -> m Bool notElem :: (Monad m, Eq a) => a -> Stream m a -> m Bool find :: Monad m => (a -> Bool) -> Stream m a -> m (Maybe a) findM :: Monad m => (a -> m Bool) -> Stream m a -> m (Maybe a) findIndex :: Monad m => (a -> Bool) -> Stream m a -> m (Maybe Int) findIndexM :: Monad m => (a -> m Bool) -> Stream m a -> m (Maybe Int) foldl :: Monad m => (a -> b -> a) -> a -> Stream m b -> m a foldlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a foldl1 :: Monad m => (a -> a -> a) -> Stream m a -> m a foldl1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a foldM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a fold1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a foldl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> m a foldlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a foldl1' :: Monad m => (a -> a -> a) -> Stream m a -> m a foldl1M' :: Monad m => (a -> a -> m a) -> Stream m a -> m a foldM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a fold1M' :: Monad m => (a -> a -> m a) -> Stream m a -> m a foldr :: Monad m => (a -> b -> b) -> b -> Stream m a -> m b foldrM :: Monad m => (a -> b -> m b) -> b -> Stream m a -> m b foldr1 :: Monad m => (a -> a -> a) -> Stream m a -> m a foldr1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a and :: Monad m => Stream m Bool -> m Bool or :: Monad m => Stream m Bool -> m Bool concatMapM :: Monad m => (a -> m (Stream m b)) -> Stream m a -> Stream m b unfoldr :: Monad m => (s -> Maybe (a, s)) -> s -> Stream m a unfoldrM :: Monad m => (s -> m (Maybe (a, s))) -> s -> Stream m a prescanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a prescanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a prescanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a prescanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a postscanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a postscanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a postscanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a postscanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a scanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a scanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a scanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a scanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a scanl1 :: Monad m => (a -> a -> a) -> Stream m a -> Stream m a scanl1M :: Monad m => (a -> a -> m a) -> Stream m a -> Stream m a scanl1' :: Monad m => (a -> a -> a) -> Stream m a -> Stream m a scanl1M' :: Monad m => (a -> a -> m a) -> Stream m a -> Stream m a toList :: Monad m => Stream m a -> m [a] fromList :: Monad m => [a] -> Stream m a

Documentation

data Stream m a Source

Monadic streams Constructors forall s . Stream (s -> m (Step s a)) s Size Instances Monad m => Functor (Stream m) Eq a => Eq (Stream Id a) Ord a => Ord (Stream Id a)

data Step s a Source

Result of taking a single step in a stream Constructors Yield a s a new element and a new seed Skip s just a new seed Done end of stream

Size hints

size :: Stream m a -> Size Source

Size hint of a Stream

sized :: Stream m a -> Size -> Stream m a Source

Attach a Size hint to a Stream

Length

length :: Monad m => Stream m a -> m Int Source

Length of a Stream

null :: Monad m => Stream m a -> m Bool Source

Check if a Stream is empty

Construction

empty :: Monad m => Stream m a Source

Empty Stream

singleton :: Monad m => a -> Stream m a Source

Singleton Stream

cons :: Monad m => a -> Stream m a -> Stream m a Source

Prepend an element

snoc :: Monad m => Stream m a -> a -> Stream m a Source

Append an element

replicate :: Monad m => Int -> a -> Stream m a Source

Replicate a value to a given length

(++) :: Monad m => Stream m a -> Stream m a -> Stream m a Source

Concatenate two Streams

Accessing elements

head :: Monad m => Stream m a -> m a Source

First element of the Stream or error if empty

last :: Monad m => Stream m a -> m a Source

Last element of the Stream or error if empty

(!!) :: Monad m => Stream m a -> Int -> m a Source

Element at the given position

Substreams

extract Source

:: Monad m => Stream m a -> Int starting index -> Int length -> Stream m a Extract a substream of the given length starting at the given position.

init :: Monad m => Stream m a -> Stream m a Source

All but the last element

tail :: Monad m => Stream m a -> Stream m a Source

All but the first element

take :: Monad m => Int -> Stream m a -> Stream m a Source

The first n elements

drop :: Monad m => Int -> Stream m a -> Stream m a Source

All but the first n elements

Mapping

map :: Monad m => (a -> b) -> Stream m a -> Stream m b Source

Map a function over a Stream

mapM :: Monad m => (a -> m b) -> Stream m a -> Stream m b Source

Map a monadic function over a Stream

mapM_ :: Monad m => (a -> m b) -> Stream m a -> m () Source

Execute a monadic action for each element of the Stream

trans :: (Monad m, Monad m') => (forall a. m a -> m' a) -> Stream m a -> Stream m' a Source

Transform a Stream to use a different monad

concatMap :: Monad m => (a -> Stream m b) -> Stream m a -> Stream m b Source

Zipping

zipWith :: Monad m => (a -> b -> c) -> Stream m a -> Stream m b -> Stream m c Source

Zip two Streams with the given function

zipWithM :: Monad m => (a -> b -> m c) -> Stream m a -> Stream m b -> Stream m c Source

Zip two Streams with the given monadic function

zipWith3 :: Monad m => (a -> b -> c -> d) -> Stream m a -> Stream m b -> Stream m c -> Stream m d Source

Zip three Streams with the given function

zipWith3M :: Monad m => (a -> b -> c -> m d) -> Stream m a -> Stream m b -> Stream m c -> Stream m d Source

Zip three Streams with the given monadic function

Filtering

filter :: Monad m => (a -> Bool) -> Stream m a -> Stream m a Source

Drop elements which do not satisfy the predicate

filterM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a Source

Drop elements which do not satisfy the monadic predicate

takeWhile :: Monad m => (a -> Bool) -> Stream m a -> Stream m a Source

Longest prefix of elements that satisfy the predicate

takeWhileM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a Source

Longest prefix of elements that satisfy the monadic predicate

dropWhile :: Monad m => (a -> Bool) -> Stream m a -> Stream m a Source

Drop the longest prefix of elements that satisfy the predicate

dropWhileM :: Monad m => (a -> m Bool) -> Stream m a -> Stream m a Source

Drop the longest prefix of elements that satisfy the monadic predicate

Searching

elem :: (Monad m, Eq a) => a -> Stream m a -> m Bool Source

Check whether the Stream contains an element

notElem :: (Monad m, Eq a) => a -> Stream m a -> m Bool Source

Inverse of elem

find :: Monad m => (a -> Bool) -> Stream m a -> m (Maybe a) Source

Yield Just the first element that satisfies the predicate or Nothing if no such element exists.

findM :: Monad m => (a -> m Bool) -> Stream m a -> m (Maybe a) Source

Yield Just the first element that satisfies the monadic predicate or Nothing if no such element exists.

findIndex :: Monad m => (a -> Bool) -> Stream m a -> m (Maybe Int) Source

Yield Just the index of the first element that satisfies the predicate or Nothing if no such element exists.

findIndexM :: Monad m => (a -> m Bool) -> Stream m a -> m (Maybe Int) Source

Yield Just the index of the first element that satisfies the monadic predicate or Nothing if no such element exists.

Folding

foldl :: Monad m => (a -> b -> a) -> a -> Stream m b -> m a Source

Left fold

foldlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a Source

Left fold with a monadic operator

foldl1 :: Monad m => (a -> a -> a) -> Stream m a -> m a Source

Left fold over a non-empty Stream

foldl1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a Source

Left fold over a non-empty Stream with a monadic operator

foldM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a Source

Same as foldlM

fold1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a Source

Same as foldl1M

foldl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> m a Source

Left fold with a strict accumulator

foldlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a Source

Left fold with a strict accumulator and a monadic operator

foldl1' :: Monad m => (a -> a -> a) -> Stream m a -> m a Source

Left fold over a non-empty Stream with a strict accumulator

foldl1M' :: Monad m => (a -> a -> m a) -> Stream m a -> m a Source

Left fold over a non-empty Stream with a strict accumulator and a monadic operator

foldM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> m a Source

Same as foldlM'

fold1M' :: Monad m => (a -> a -> m a) -> Stream m a -> m a Source

Same as foldl1M'

foldr :: Monad m => (a -> b -> b) -> b -> Stream m a -> m b Source

Right fold

foldrM :: Monad m => (a -> b -> m b) -> b -> Stream m a -> m b Source

Right fold with a monadic operator

foldr1 :: Monad m => (a -> a -> a) -> Stream m a -> m a Source

Right fold over a non-empty stream

foldr1M :: Monad m => (a -> a -> m a) -> Stream m a -> m a Source

Right fold over a non-empty stream with a monadic operator

Specialised folds

and :: Monad m => Stream m Bool -> m Bool Source

or :: Monad m => Stream m Bool -> m Bool Source

concatMapM :: Monad m => (a -> m (Stream m b)) -> Stream m a -> Stream m b Source

Unfolding

unfoldr :: Monad m => (s -> Maybe (a, s)) -> s -> Stream m a Source

Unfold

unfoldrM :: Monad m => (s -> m (Maybe (a, s))) -> s -> Stream m a Source

Unfold with a monadic function

Scans

prescanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Prefix scan

prescanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Prefix scan with a monadic operator

prescanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Prefix scan with strict accumulator

prescanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Prefix scan with strict accumulator and a monadic operator

postscanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Suffix scan

postscanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Suffix scan with a monadic operator

postscanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Suffix scan with strict accumulator

postscanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Suffix scan with strict acccumulator and a monadic operator

scanl :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Haskell-style scan

scanlM :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Haskell-style scan with a monadic operator

scanl' :: Monad m => (a -> b -> a) -> a -> Stream m b -> Stream m a Source

Haskell-style scan with strict accumulator

scanlM' :: Monad m => (a -> b -> m a) -> a -> Stream m b -> Stream m a Source

Haskell-style scan with strict accumulator and a monadic operator

scanl1 :: Monad m => (a -> a -> a) -> Stream m a -> Stream m a Source

Scan over a non-empty Stream

scanl1M :: Monad m => (a -> a -> m a) -> Stream m a -> Stream m a Source

Scan over a non-empty Stream with a monadic operator

scanl1' :: Monad m => (a -> a -> a) -> Stream m a -> Stream m a Source

Scan over a non-empty Stream with a strict accumulator

scanl1M' :: Monad m => (a -> a -> m a) -> Stream m a -> Stream m a Source

Scan over a non-empty Stream with a strict accumulator and a monadic operator

Conversions

toList :: Monad m => Stream m a -> m [a] Source

Convert a Stream to a list

fromList :: Monad m => [a] -> Stream m a Source

Convert a list to a Stream

Produced by Haddock version 2.4.2