Documentation

A Plan is a pairing of a StreamGraph with a PartitionMap that could be used for its partitioning and deployment.

The Cost of a Plan (lower is better). Nothing represents a non-viable pairing. Maybe n represents the cost n.

Apply rewrite rules to the supplied StreamGraph to possibly rewrite it; partition it when a generated PartitionMap; generate and write out Haskell source code files for each Partition, ready for deployment.

apply viableRewrites to the supplied StreamGraph. Return the lowest-cost Plan. If there are no pairings, throw an error.

TODO: rename this. It's a bad name! optimiseChoosePartitionMap?

Given a stream processing program encoded in a StreamGraph:

• generate derivative graphs via rewrite rules.
• generate all possible partitionings for each graph

• for each pair of graph and partitioning (Plan):

  • reject any pairings which are not viable
  • Cost the pairs with the cost model planCost
• return the Plan paired with with the Cost from applying the cost model.

given a StreamGraph, derives further graphs by applying rewrite rules and pairs them with all their potential partitionings

given a StreamGraph, generate all partitionings of it and pair them individually with the StreamGraph.

Return a Cost for a Plan. Return Nothing if the Plan is not viable, either due to an over-utilised operator or an over-utilised Partition.

Convenience function for specifying a simple path-style of stream processing program, with no merge or join operations. The list of tuples are converted into a series of connected Stream Vertices in a Graph. The tuple arguments are the relevant StreamOperator for the node; the parameters;the *output* type and the service time. The other parameters to StreamVertex are inferred from the neighbouring tuples. Unique and ascending vertexId values are assigned.

Partitions the supplied StreamGraph according to the supplied PartitionMap; invokes generateCode for each derived sub-graph; writes out the resulting source code to individual source code files, one per node.

• TODO*: move GenerateOpts to first parameter?

Options for source code generation are captured in instances of the GenerateOpts data-type.

Sensible default values for GenerateOpts. Users who wish to customise options in GenerateOpts are encouraged to derive from defaultOpts.