Data.ZoomCache.Codec

This module re-exports the required interfaces and some useful functions for developing zoom-cache codecs.

To implement a codec, specify SummaryData and SummaryWork types, and implement the methods of the ZoomReadable and ZoomWritable classes.

For sample implementations, read the source of the provided instances Data.ZoomCache.Int and Data.ZoomCache.Double.

Required interfaces

class Typeable a => ZoomReadable a where

A codec instance must specify a SummaryData type, and implement all methods of this class.

Associated Types

data SummaryData a :: *

Summaries of a subsequence of values of type a. In the default instances for Int and Double, this is a record containing values such as the maximum, minimum and mean of the subsequence.

Methods

trackIdentifier :: a -> ByteString

The track identifier used for streams of type a. The value of the argument should be ignored by any instance of ZoomReadable, so that is safe to pass undefined as the argument.

readRaw :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m a

An iteratee to read one value of type a from a stream of something like '[Word8]' or ByteString.

readSummary :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m (SummaryData a)

An iteratee to read one value of type 'SummaryData a' from a stream of something like '[Word8]' or ByteString.

prettyRaw :: a -> String

Pretty printing, used for dumping values of type a.

prettySummaryData :: SummaryData a -> String

Pretty printing for values of type 'SummaryData a'.

Instances

ZoomReadable Bool

ZoomReadable Double

ZoomReadable Float

ZoomReadable Int

ZoomReadable Int8

ZoomReadable Int16

ZoomReadable Int32

ZoomReadable Int64

ZoomReadable ()

class ZoomReadable a => ZoomWritable a where

A codec instance must additionally specify a SummaryWork type

Associated Types

data SummaryWork a :: *

Intermediate calculations

Methods

fromRaw :: a -> Builder

Serialize a value of type a

fromSummaryData :: SummaryData a -> Builder

Serialize a 'SummaryData a'

initSummaryWork :: TimeStamp -> SummaryWork a

Generate a new 'SummaryWork a', given an initial timestamp.

updateSummaryData :: TimeStamp -> a -> SummaryWork a -> SummaryWork a

Update a SummaryData with the value of a occuring at the given TimeStamp.

toSummaryData :: TimeStampDiff -> SummaryWork a -> SummaryData a

Finalize a 'SummaryWork a', generating a 'SummaryData a'.

appendSummaryData :: TimeStampDiff -> SummaryData a -> TimeStampDiff -> SummaryData a -> SummaryData a

Append two SummaryData

Instances

ZoomWritable Bool

ZoomWritable Double

ZoomWritable Float

ZoomWritable Int

ZoomWritable Int8

ZoomWritable Int16

ZoomWritable Int32

ZoomWritable Int64

ZoomWritable ()

class ZoomWrite t where

The ZoomWrite class provides write, a method to write a Haskell value to an open ZoomCache file.

Methods

write :: TrackNo -> t -> ZoomW ()

Write a value to an open ZoomCache file.

Instances

ZoomWrite Bool

ZoomWrite Double

ZoomWrite Float

ZoomWrite Int

ZoomWrite Int8

ZoomWrite Int16

ZoomWrite Int32

ZoomWrite Int64

ZoomWrite ()

ZoomWrite (TimeStamp, Bool)

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Float)

ZoomWrite (TimeStamp, Int)

ZoomWrite (TimeStamp, Int8)

ZoomWrite (TimeStamp, Int16)

ZoomWrite (TimeStamp, Int32)

ZoomWrite (TimeStamp, Int64)

ZoomWrite (TimeStamp, ())

Identification

identifyCodec :: ZoomReadable a => a -> IdentifyCodec

Generate an IdentifyTrack function for a given type.

Raw data reading iteratees

readInt8 :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

Read 1 byte as an Integral

readInt16be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

Read 2 bytes as a big-endian Integral

readInt32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

Read 4 bytes as a big-endian Integral

readInt64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

Read 8 bytes as a big-endian Integral

readFloat32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Float

Read 4 bytes as a big-endian Float

readDouble64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Double

Read 8 bytes as a big-endian Double

readRational64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Rational

Read 16 bytes as a big-endian Rational, encoded as an 8 byte big endian numerator followed by an 8 byte big endian denominator.

ZoomWrite instance helpers

writeData :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> a -> ZoomW ()

writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()

Builders

fromRational64 :: Rational -> Builder

Serialize a Rational as a sequence of two 64bit big endian format integers.

fromIntegral32be :: forall a. Integral a => a -> Builder

Serialize an Integral in 32bit big endian format.

fromFloat :: Float -> Builder

Serialize a Float in big-endian IEEE 754-2008 binary32 format (IEEE 754-1985 single format).

fromDouble :: Double -> Builder

Serialize a Double in big-endian IEEE 754-2008 binary64 format (IEEE 754-1985 double format).

ZoomCache Types

data Codec

Instances

Show Codec

data TimeStamp

Constructors

TS

Fields

unTS :: !Int64

Instances

Eq TimeStamp

Ord TimeStamp

Show TimeStamp

ZoomWrite (TimeStamp, Bool)

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Float)

ZoomWrite (TimeStamp, Int)

ZoomWrite (TimeStamp, Int8)

ZoomWrite (TimeStamp, Int16)

ZoomWrite (TimeStamp, Int32)

ZoomWrite (TimeStamp, Int64)

ZoomWrite (TimeStamp, ())

data TimeStampDiff

Constructors

TSDiff

Fields

unTSDiff :: !Int64

Instances

Eq TimeStampDiff

Ord TimeStampDiff

Show TimeStampDiff

timeStampDiff :: TimeStamp -> TimeStamp -> TimeStampDiff

timeStampDiff (TS t1) (TS t2) = TSDiff (t1 - t2)

Minimum and maximum floating point

module Data.ZoomCache.Numeric.FloatMinMax