vector-0.4: Efficient Arrays Source code Contents Index

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

Contents Types In-place markers Size hints Length information Construction Accessing individual elements Substreams Mapping Zipping Filtering Searching Folding Specialised folds Unfolding Scans Conversions Monadic combinators

Description

Streams for stream fusion

Synopsis

data Step s a = Yield a s | Skip s | Done type Stream = Stream Id type MStream = Stream inplace :: (forall m. Monad m => Stream m a -> Stream m a) -> Stream a -> Stream a inplace' :: (forall m. Monad m => Stream m a -> Stream m b) -> Stream a -> Stream b size :: Stream a -> Size sized :: Stream a -> Size -> Stream a length :: Stream a -> Int null :: Stream a -> Bool empty :: Stream a singleton :: a -> Stream a cons :: a -> Stream a -> Stream a snoc :: Stream a -> a -> Stream a replicate :: Int -> a -> Stream a (++) :: Stream a -> Stream a -> Stream a head :: Stream a -> a last :: Stream a -> a (!!) :: Stream a -> Int -> a extract :: Stream a -> Int -> Int -> Stream a init :: Stream a -> Stream a tail :: Stream a -> Stream a take :: Int -> Stream a -> Stream a drop :: Int -> Stream a -> Stream a map :: (a -> b) -> Stream a -> Stream b concatMap :: (a -> Stream b) -> Stream a -> Stream b zipWith :: (a -> b -> c) -> Stream a -> Stream b -> Stream c zipWith3 :: (a -> b -> c -> d) -> Stream a -> Stream b -> Stream c -> Stream d filter :: (a -> Bool) -> Stream a -> Stream a takeWhile :: (a -> Bool) -> Stream a -> Stream a dropWhile :: (a -> Bool) -> Stream a -> Stream a elem :: Eq a => a -> Stream a -> Bool notElem :: Eq a => a -> Stream a -> Bool find :: (a -> Bool) -> Stream a -> Maybe a findIndex :: (a -> Bool) -> Stream a -> Maybe Int foldl :: (a -> b -> a) -> a -> Stream b -> a foldl1 :: (a -> a -> a) -> Stream a -> a foldl' :: (a -> b -> a) -> a -> Stream b -> a foldl1' :: (a -> a -> a) -> Stream a -> a foldr :: (a -> b -> b) -> b -> Stream a -> b foldr1 :: (a -> a -> a) -> Stream a -> a and :: Stream Bool -> Bool or :: Stream Bool -> Bool unfoldr :: (s -> Maybe (a, s)) -> s -> Stream a prescanl :: (a -> b -> a) -> a -> Stream b -> Stream a prescanl' :: (a -> b -> a) -> a -> Stream b -> Stream a postscanl :: (a -> b -> a) -> a -> Stream b -> Stream a postscanl' :: (a -> b -> a) -> a -> Stream b -> Stream a scanl :: (a -> b -> a) -> a -> Stream b -> Stream a scanl' :: (a -> b -> a) -> a -> Stream b -> Stream a scanl1 :: (a -> a -> a) -> Stream a -> Stream a scanl1' :: (a -> a -> a) -> Stream a -> Stream a toList :: Stream a -> [a] fromList :: [a] -> Stream a liftStream :: Monad m => Stream a -> Stream m a mapM_ :: Monad m => (a -> m ()) -> Stream a -> m () foldM :: Monad m => (a -> b -> m a) -> a -> Stream b -> m a fold1M :: Monad m => (a -> a -> m a) -> Stream a -> m a foldM' :: Monad m => (a -> b -> m a) -> a -> Stream b -> m a fold1M' :: Monad m => (a -> a -> m a) -> Stream a -> m a

Types

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

type Stream = Stream Id Source

The type of pure streams

type MStream = Stream Source

Alternative name for monadic streams

In-place markers

inplace :: (forall m. Monad m => Stream m a -> Stream m a) -> Stream a -> Stream a Source

inplace' :: (forall m. Monad m => Stream m a -> Stream m b) -> Stream a -> Stream b Source

Size hints

size :: Stream a -> Size Source

Size hint of a Stream

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

Attach a Size hint to a Stream

Length information

length :: Stream a -> Int Source

Length of a Stream

null :: Stream a -> Bool Source

Check if a Stream is empty

Construction

empty :: Stream a Source

Empty Stream

singleton :: a -> Stream a Source

Singleton Stream

cons :: a -> Stream a -> Stream a Source

Prepend an element

snoc :: Stream a -> a -> Stream a Source

Append an element

replicate :: Int -> a -> Stream a Source

Replicate a value to a given length

(++) :: Stream a -> Stream a -> Stream a Source

Concatenate two Streams

Accessing individual elements

head :: Stream a -> a Source

First element of the Stream or error if empty

last :: Stream a -> a Source

Last element of the Stream or error if empty

(!!) :: Stream a -> Int -> a Source

Element at the given position

Substreams

extract Source

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

init :: Stream a -> Stream a Source

All but the last element

tail :: Stream a -> Stream a Source

All but the first element

take :: Int -> Stream a -> Stream a Source

The first n elements

drop :: Int -> Stream a -> Stream a Source

All but the first n elements

Mapping

map :: (a -> b) -> Stream a -> Stream b Source

Map a function over a Stream

concatMap :: (a -> Stream b) -> Stream a -> Stream b Source

Zipping

zipWith :: (a -> b -> c) -> Stream a -> Stream b -> Stream c Source

Zip two Streams with the given function

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

Zip three Streams with the given function

Filtering

filter :: (a -> Bool) -> Stream a -> Stream a Source

Drop elements which do not satisfy the predicate

takeWhile :: (a -> Bool) -> Stream a -> Stream a Source

Longest prefix of elements that satisfy the predicate

dropWhile :: (a -> Bool) -> Stream a -> Stream a Source

Drop the longest prefix of elements that satisfy the predicate

Searching

elem :: Eq a => a -> Stream a -> Bool Source

Check whether the Stream contains an element

notElem :: Eq a => a -> Stream a -> Bool Source

Inverse of elem

find :: (a -> Bool) -> Stream a -> Maybe a Source

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

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

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

Folding

foldl :: (a -> b -> a) -> a -> Stream b -> a Source

Left fold

foldl1 :: (a -> a -> a) -> Stream a -> a Source

Left fold on non-empty Streams

foldl' :: (a -> b -> a) -> a -> Stream b -> a Source

Left fold with strict accumulator

foldl1' :: (a -> a -> a) -> Stream a -> a Source

Left fold on non-empty Streams with strict accumulator

foldr :: (a -> b -> b) -> b -> Stream a -> b Source

Right fold

foldr1 :: (a -> a -> a) -> Stream a -> a Source

Right fold on non-empty Streams

Specialised folds

and :: Stream Bool -> Bool Source

or :: Stream Bool -> Bool Source

Unfolding

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

Unfold

Scans

prescanl :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Prefix scan

prescanl' :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Prefix scan with strict accumulator

postscanl :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Suffix scan

postscanl' :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Suffix scan with strict accumulator

scanl :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Haskell-style scan

scanl' :: (a -> b -> a) -> a -> Stream b -> Stream a Source

Haskell-style scan with strict accumulator

scanl1 :: (a -> a -> a) -> Stream a -> Stream a Source

Scan over a non-empty Stream

scanl1' :: (a -> a -> a) -> Stream a -> Stream a Source

Scan over a non-empty Stream with a strict accumulator

Conversions

toList :: Stream a -> [a] Source

Convert a Stream to a list

fromList :: [a] -> Stream a Source

Create a Stream from a list

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

Convert a pure stream to a monadic stream

Monadic combinators

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

Apply a monadic action to each element of the stream

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

Monadic fold

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

Monadic fold over non-empty stream

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

Monadic fold with strict accumulator

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

Monad fold over non-empty stream with strict accumulator

Produced by Haddock version 2.4.2