Data.Stream.Optimized

An optimization layer on Data.Stream.

Since both variants are semantically the same, not the full API of Data.Stream is replicated here.

Documentation

data OptimizedStreamT m a

An optimized version of StreamT which has an extra constructor for stateless streams.

In most cases, using OptimizedStreamT is preferable over StreamT, because building up bigger programs with StreamT will build up big accumulations of trivial states. The API of OptimizedStreamT only keeps the nontrivial parts of the state.

Semantically, both types are the same.

Constructors

Stateful (StreamT m a)

Embed a StreamT. Take care only to use this constructor on streams with nontrivial state.

Stateless (m a)

A stateless stream is simply an action in a monad which is performed repetitively.

Instances

MFunctor OptimizedStreamT

Defined in Data.Stream.Optimized

Methods

hoist :: forall m n (b :: k). Monad m => (forall a. m a -> n a) -> OptimizedStreamT m b -> OptimizedStreamT n b

Alternative m => Alternative (OptimizedStreamT m)

Defined in Data.Stream.Optimized

Methods

empty :: OptimizedStreamT m a

(<|>) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

some :: OptimizedStreamT m a -> OptimizedStreamT m [a]

many :: OptimizedStreamT m a -> OptimizedStreamT m [a]

Applicative m => Applicative (OptimizedStreamT m)

Only builds up tuples of states if both streams are stateful.

Defined in Data.Stream.Optimized

Methods

pure :: a -> OptimizedStreamT m a

(<*>) :: OptimizedStreamT m (a -> b) -> OptimizedStreamT m a -> OptimizedStreamT m b

liftA2 :: (a -> b -> c) -> OptimizedStreamT m a -> OptimizedStreamT m b -> OptimizedStreamT m c

(*>) :: OptimizedStreamT m a -> OptimizedStreamT m b -> OptimizedStreamT m b

(<*) :: OptimizedStreamT m a -> OptimizedStreamT m b -> OptimizedStreamT m a

Functor m => Functor (OptimizedStreamT m)

Defined in Data.Stream.Optimized

Methods

fmap :: (a -> b) -> OptimizedStreamT m a -> OptimizedStreamT m b

(<$) :: a -> OptimizedStreamT m b -> OptimizedStreamT m a

Selective m => Selective (OptimizedStreamT m)

Defined in Data.Stream.Optimized

Methods

select :: OptimizedStreamT m (Either a b) -> OptimizedStreamT m (a -> b) -> OptimizedStreamT m b

Align m => Align (OptimizedStreamT m)

Defined in Data.Stream.Optimized

Methods

nil :: OptimizedStreamT m a

Semialign m => Semialign (OptimizedStreamT m)

Defined in Data.Stream.Optimized

Methods

align :: OptimizedStreamT m a -> OptimizedStreamT m b -> OptimizedStreamT m (These a b)

alignWith :: (These a b -> c) -> OptimizedStreamT m a -> OptimizedStreamT m b -> OptimizedStreamT m c

(Applicative m, Floating a) => Floating (OptimizedStreamT m a)

Defined in Data.Stream.Optimized

Methods

pi :: OptimizedStreamT m a

exp :: OptimizedStreamT m a -> OptimizedStreamT m a

log :: OptimizedStreamT m a -> OptimizedStreamT m a

sqrt :: OptimizedStreamT m a -> OptimizedStreamT m a

(**) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

logBase :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

sin :: OptimizedStreamT m a -> OptimizedStreamT m a

cos :: OptimizedStreamT m a -> OptimizedStreamT m a

tan :: OptimizedStreamT m a -> OptimizedStreamT m a

asin :: OptimizedStreamT m a -> OptimizedStreamT m a

acos :: OptimizedStreamT m a -> OptimizedStreamT m a

atan :: OptimizedStreamT m a -> OptimizedStreamT m a

sinh :: OptimizedStreamT m a -> OptimizedStreamT m a

cosh :: OptimizedStreamT m a -> OptimizedStreamT m a

tanh :: OptimizedStreamT m a -> OptimizedStreamT m a

asinh :: OptimizedStreamT m a -> OptimizedStreamT m a

acosh :: OptimizedStreamT m a -> OptimizedStreamT m a

atanh :: OptimizedStreamT m a -> OptimizedStreamT m a

log1p :: OptimizedStreamT m a -> OptimizedStreamT m a

expm1 :: OptimizedStreamT m a -> OptimizedStreamT m a

log1pexp :: OptimizedStreamT m a -> OptimizedStreamT m a

log1mexp :: OptimizedStreamT m a -> OptimizedStreamT m a

(Applicative m, Num a) => Num (OptimizedStreamT m a)

Defined in Data.Stream.Optimized

Methods

(+) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

(-) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

(*) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

negate :: OptimizedStreamT m a -> OptimizedStreamT m a

abs :: OptimizedStreamT m a -> OptimizedStreamT m a

signum :: OptimizedStreamT m a -> OptimizedStreamT m a

fromInteger :: Integer -> OptimizedStreamT m a

(Applicative m, Fractional a) => Fractional (OptimizedStreamT m a)

Defined in Data.Stream.Optimized

Methods

(/) :: OptimizedStreamT m a -> OptimizedStreamT m a -> OptimizedStreamT m a

recip :: OptimizedStreamT m a -> OptimizedStreamT m a

fromRational :: Rational -> OptimizedStreamT m a

(VectorSpace v s, Eq s, Floating s, Applicative m) => VectorSpace (OptimizedStreamT m v) (OptimizedStreamT m s)

Defined in Data.Stream.Optimized

Methods

zeroVector :: OptimizedStreamT m v

(*^) :: OptimizedStreamT m s -> OptimizedStreamT m v -> OptimizedStreamT m v

(^/) :: OptimizedStreamT m v -> OptimizedStreamT m s -> OptimizedStreamT m v

(^+^) :: OptimizedStreamT m v -> OptimizedStreamT m v -> OptimizedStreamT m v

(^-^) :: OptimizedStreamT m v -> OptimizedStreamT m v -> OptimizedStreamT m v

negateVector :: OptimizedStreamT m v -> OptimizedStreamT m v

dot :: OptimizedStreamT m v -> OptimizedStreamT m v -> OptimizedStreamT m s

norm :: OptimizedStreamT m v -> OptimizedStreamT m s

normalize :: OptimizedStreamT m v -> OptimizedStreamT m v

toStreamT :: Functor m => OptimizedStreamT m b -> StreamT m b

Remove the optimization layer.

For stateful streams, this is just the identity. A stateless stream is encoded as a stream with state ().

hoist' :: (forall x. m1 x -> m2 x) -> OptimizedStreamT m1 a -> OptimizedStreamT m2 a

Like hoist, but without the Monad m2 constraint.

mapOptimizedStreamT :: (Functor m, Functor n) => (forall s. m (Result s a) -> n (Result s b)) -> OptimizedStreamT m a -> OptimizedStreamT n b

Change the output type and effect of a stream without changing its state type.

withOptimized :: Monad n => (forall m. Monad m => StreamT m a -> StreamT m b) -> OptimizedStreamT n a -> OptimizedStreamT n b

Map a monad-independent morphism of streams to optimized streams.

In contrast to handleOptimized, the stream morphism must be independent of the monad.

handleOptimized :: Functor m => (StreamT m a -> StreamT n b) -> OptimizedStreamT m a -> OptimizedStreamT n b

Map a morphism of streams to optimized streams.

In contrast to withOptimized, the monad type is allowed to change.

reactimate :: Monad m => OptimizedStreamT m () -> m void

Run a stream with trivial output.

See reactimate.

constM :: m a -> OptimizedStreamT m a

A stateless stream.

This function is typically preferable over constM, since the optimized version doesn't create a state type.

stepOptimizedStream :: Functor m => OptimizedStreamT m a -> m (Result (OptimizedStreamT m a) a)

Perform one step of a stream, resulting in an updated stream and an output value.

toFinal :: Functor m => OptimizedStreamT m a -> Final m a

Translate to the final encoding of streams.

This will typically be a performance penalty.

fromFinal :: Final m a -> OptimizedStreamT m a

Translate a stream from final encoding to stateful, initial encoding. The internal state is the stream itself.

concatS :: Monad m => OptimizedStreamT m [a] -> OptimizedStreamT m a

See concatS.

exceptS :: Monad m => OptimizedStreamT (ExceptT e m) b -> OptimizedStreamT m (Either e b)

See exceptS.

applyExcept :: Monad m => OptimizedStreamT (ExceptT (e1 -> e2) m) a -> OptimizedStreamT (ExceptT e1 m) a -> OptimizedStreamT (ExceptT e2 m) a

See applyExcept.

selectExcept :: Monad m => OptimizedStreamT (ExceptT (Either e1 e2) m) a -> OptimizedStreamT (ExceptT (e1 -> e2) m) a -> OptimizedStreamT (ExceptT e2 m) a

See selectExcept.