Codec.Goat

Goat is a time series compression implementation in pure Haskell. It is heavily based on Facebook's Gorilla algorithm [1].

1

http://www.vldb.org/pvldb/vol8/p1816-teller.pdf

Documentation

data Story

Representation of a time series object. The constructor arguments are as follows: * time window size * current time window number * times fluid * values fluid

Constructors

Story Word32 Word32 (Fluid Word32 TimeFrame) (Fluid Float ValueFrame)

Instances

Show Story

Pretty-printing for the Story type.

Methods

showsPrec :: Int -> Story -> ShowS

show :: Story -> String

showList :: [Story] -> ShowS

data TimeFrame

Succinct representation of a list of time points. The constructor arguments are as follows: * first time point * second time point * number of valid bits * bits

Constructors

TimeFrame (Maybe Word32) (Maybe Word32) Word32 ByteString

Instances

Eq TimeFrame

Methods

(==) :: TimeFrame -> TimeFrame -> Bool

(/=) :: TimeFrame -> TimeFrame -> Bool

Show TimeFrame

Pretty-printing of the TimeFrame type.

Methods

showsPrec :: Int -> TimeFrame -> ShowS

show :: TimeFrame -> String

showList :: [TimeFrame] -> ShowS

Serialize TimeFrame

Binary serialization of the TimeFrame type. All integers are using the big-endian byte order.

Methods

put :: Putter TimeFrame

get :: Get TimeFrame

Frame Word32 TimeFrame

Binding of Word32 and TimeFrame.

Methods

frameDecode :: TimeFrame -> [Word32]

frameEncode :: [Word32] -> TimeFrame

frameHead :: TimeFrame -> Maybe Word32

data ValueFrame

Succinct representation of a list of value points. The constructor arguments are as follows: * first value * number of valid bits * bits

Constructors

ValueFrame (Maybe Word32) Word32 ByteString

Instances

Eq ValueFrame

Methods

(==) :: ValueFrame -> ValueFrame -> Bool

(/=) :: ValueFrame -> ValueFrame -> Bool

Show ValueFrame

Pretty-printing of the ValueFrame type.

Methods

showsPrec :: Int -> ValueFrame -> ShowS

show :: ValueFrame -> String

showList :: [ValueFrame] -> ShowS

Serialize ValueFrame

Binary serialization of the ValueFrame type. All integers are using the big-endian byte order.

Methods

put :: Putter ValueFrame

get :: Get ValueFrame

Frame Float ValueFrame

Binding of Float and ValueFrame.

Methods

frameDecode :: ValueFrame -> [Float]

frameEncode :: [Float] -> ValueFrame

frameHead :: ValueFrame -> Maybe Float

storyAppend

Arguments

:: Story

old story

-> (Word32, Float)

time & value

-> Maybe Story

new story

Add new time/value pair to the story. The function will return Nothing in case that the value was invalid (NaN or Infinity) or when the time was invalid with respect to previously added times (breaking the series monotonicity).

storyDump

Arguments

:: Story

story

-> [(Word32, Float)]

times & values

Output a list of all time/value pairs stored in the story.

storyNew

Arguments

:: Word32

time window size

-> Word32

current time window number

-> Story

new story

Create a new empty story. The ratio of raw/compressed sections is 12/74. These fields will be configurable in the future versions of the module.

storyQuery

Arguments

:: Story

story

-> (Word32, Word32)

interval

-> [(Word32, Float)]

times & values

Query the story for time/value pairs within the specified time limit.

timeDecode

Arguments

:: TimeFrame

succinct frame form

-> [Word32]

time points

Unpack time points from the succinct frame.

timeEncode

Arguments

:: [Word32]

time points

-> TimeFrame

succinct frame form

Pack a list of _ascending_ time points into a succinct frame form.

valueDecode

Arguments

:: ValueFrame

succinct frame form

-> [Float]

value points

Unpack value points from the succinct frame.

valueEncode

Arguments

:: [Float]

value points

-> ValueFrame

succinct frame form

Encode a list of float values into a succinct value frame.