Copilot.Language.Stream

Abstract syntax for streams and operators.

Documentation

data Stream :: * -> * where

A stream in Copilot is an infinite succession of values of the same type.

Streams can be built using simple primities (e.g., Const), by applying step-wise (e.g., Op1) or temporal transformations (e.g., Append, Drop) to streams, or by combining existing streams to form new streams (e.g., Op2, Op3).

Constructors

Append :: Typed a => [a] -> Maybe (Stream Bool) -> Stream a -> Stream a

Const :: Typed a => a -> Stream a

Drop :: Typed a => Int -> Stream a -> Stream a

Extern :: Typed a => String -> Maybe [a] -> Stream a

Local :: (Typed a, Typed b) => Stream a -> (Stream a -> Stream b) -> Stream b

Var :: Typed a => String -> Stream a

Op1 :: (Typed a, Typed b) => Op1 a b -> Stream a -> Stream b

Op2 :: (Typed a, Typed b, Typed c) => Op2 a b c -> Stream a -> Stream b -> Stream c

Op3 :: (Typed a, Typed b, Typed c, Typed d) => Op3 a b c d -> Stream a -> Stream b -> Stream c -> Stream d

Label :: Typed a => String -> Stream a -> Stream a

Instances

(Typed a, Bits a) => Bits (Stream a)

Instance of the Bits class for Streams.

Only the methods .&., complement, .|. and xor are defined.

Defined in Copilot.Language.Operators.BitWise

Methods

(.&.) :: Stream a -> Stream a -> Stream a

(.|.) :: Stream a -> Stream a -> Stream a

xor :: Stream a -> Stream a -> Stream a

complement :: Stream a -> Stream a

shift :: Stream a -> Int -> Stream a

rotate :: Stream a -> Int -> Stream a

zeroBits :: Stream a

bit :: Int -> Stream a

setBit :: Stream a -> Int -> Stream a

clearBit :: Stream a -> Int -> Stream a

complementBit :: Stream a -> Int -> Stream a

testBit :: Stream a -> Int -> Bool

bitSizeMaybe :: Stream a -> Maybe Int

bitSize :: Stream a -> Int

isSigned :: Stream a -> Bool

shiftL :: Stream a -> Int -> Stream a

unsafeShiftL :: Stream a -> Int -> Stream a

shiftR :: Stream a -> Int -> Stream a

unsafeShiftR :: Stream a -> Int -> Stream a

rotateL :: Stream a -> Int -> Stream a

rotateR :: Stream a -> Int -> Stream a

popCount :: Stream a -> Int

(Typed a, Eq a, Floating a) => Floating (Stream a)

Streams carrying floating point numbers are instances of Floating, and you can apply to them the Floating functions, point-wise.

Defined in Copilot.Language.Stream

Methods

pi :: Stream a

exp :: Stream a -> Stream a

log :: Stream a -> Stream a

sqrt :: Stream a -> Stream a

(**) :: Stream a -> Stream a -> Stream a

logBase :: Stream a -> Stream a -> Stream a

sin :: Stream a -> Stream a

cos :: Stream a -> Stream a

tan :: Stream a -> Stream a

asin :: Stream a -> Stream a

acos :: Stream a -> Stream a

atan :: Stream a -> Stream a

sinh :: Stream a -> Stream a

cosh :: Stream a -> Stream a

tanh :: Stream a -> Stream a

asinh :: Stream a -> Stream a

acosh :: Stream a -> Stream a

atanh :: Stream a -> Stream a

log1p :: Stream a -> Stream a

expm1 :: Stream a -> Stream a

log1pexp :: Stream a -> Stream a

log1mexp :: Stream a -> Stream a

(Typed a, Eq a, Num a) => Num (Stream a)

Streams carrying numbers are instances of Num, and you can apply to them the Num functions, point-wise.

Defined in Copilot.Language.Stream

Methods

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

(-) :: Stream a -> Stream a -> Stream a

(*) :: Stream a -> Stream a -> Stream a

negate :: Stream a -> Stream a

abs :: Stream a -> Stream a

signum :: Stream a -> Stream a

fromInteger :: Integer -> Stream a

(Typed a, Eq a, Fractional a) => Fractional (Stream a)

Streams carrying fractional numbers are instances of Fractional, and you can apply to them the Fractional functions, point-wise.

Defined in Copilot.Language.Stream

Methods

(/) :: Stream a -> Stream a -> Stream a

recip :: Stream a -> Stream a

fromRational :: Rational -> Stream a

Show (Stream a)

Dummy instance in order to make Stream an instance of Num.

Defined in Copilot.Language.Stream

Methods

showsPrec :: Int -> Stream a -> ShowS

show :: Stream a -> String

showList :: [Stream a] -> ShowS

Eq (Stream a)

Dummy instance in order to make Stream an instance of Num.

Defined in Copilot.Language.Stream

Methods

(==) :: Stream a -> Stream a -> Bool

(/=) :: Stream a -> Stream a -> Bool

data Arg where

Wrapper to use Streams as arguments to triggers.

Constructors

Arg :: Typed a => Stream a -> Arg

ceiling :: (Typed a, RealFrac a) => Stream a -> Stream a

Point-wise application of ceiling to a stream.

Unlike the Haskell variant of this function, this variant takes and returns two streams of the same type. Use a casting function to convert the result to an intergral type of your choice.

Note that the result can be too big (or, if negative, too small) for that type (see the man page of ceil for details), so you must check that the value fits in the desired integral type before casting it.

This definition clashes with one in RealFrac in Haskell's Prelude, re-exported from Language.Copilot, so you need to import this module qualified to use this function.

floor :: (Typed a, RealFrac a) => Stream a -> Stream a

Point-wise application of floor to a stream.

Unlike the Haskell variant of this function, this variant takes and returns two streams of the same type. Use a casting function to convert the result to an intergral type of your choice.

Note that the result can be too big (or, if negative, too small) for that type (see the man page of floor for details), so you must check that the value fits in the desired integral type before casting it.

This definition clashes with one in RealFrac in Haskell's Prelude, re-exported from Language.Copilot, so you need to import this module qualified to use this function.

atan2 :: (Typed a, RealFloat a) => Stream a -> Stream a -> Stream a

Point-wise application of atan2 to the values of two streams.

For each pair of real floating-point samples x and y, one from each stream, atan2 computes the angle of the vector from (0, 0) to the point (x, y).

This definition clashes with one in RealFloat in Haskell's Prelude, re-exported from Language.Copilot, so you need to import this module qualified to use this function.