Merge pull request #11 from segeljakt/rust-cargo-project

Add cargo project and abstract data types

Author: scotts

.gitignore

@@ -0,0 +1,11 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk

rust/Cargo.toml

@@ -0,0 +1,60 @@
+[package]
+name               = "swag"
+version            = "0.2.0"
+authors            = ["Klas Segeljakt <[email protected]>"]
+description        = "General Purpose Sliding Window Aggregator."
+homepage           = "https://github.com/IBM/sliding-window-aggregators/rust"
+repository         = "https://github.com/IBM/sliding-window-aggregators/rust"
+documentation      = "https://github.com/IBM/sliding-window-aggregators/rust"
+readme             = "README.md"
+keywords           = ["sliding-window-aggregation", "stream-processing", "incremental-computation"]
+categories         = ["database", "science"]
+license-file       = "../LICENSE"
+edition            = "2018"
+publish            = false
+
+[lib]
+name               = "swag"
+path               = "src/lib.rs"
+
+[dependencies]
+num-traits         = "0.2.12"
+arrayvec           = "0.5.1"
+alga               = "0.9.3"
+
+[dev-dependencies]
+criterion          = "0.3.3"
+
+[profile.dev]
+opt-level          = 0
+debug              = 2
+debug-assertions   = true
+rpath              = false
+lto                = false
+panic              = 'unwind'
+incremental        = true
+
+[profile.release]  
+opt-level          = 3
+debug              = 0
+debug-assertions   = false
+rpath              = false
+lto                = false
+codegen-units      = 1
+panic              = 'unwind'
+
+[profile.test]
+opt-level          = 0
+debug              = 2
+debug-assertions   = true
+rpath              = false
+lto                = false
+codegen-units      = 1
+
+[profile.bench]
+opt-level          = 3
+debug              = 0
+rpath              = false
+lto                = false
+debug-assertions   = false
+codegen-units      = 1

rust/src/lib.rs

@@ -0,0 +1,42 @@
+use alga::general::Operator;
+use std::ops::Range;
+
+/// An abstract data type which maintains a time-ordered sliding window.
+pub trait TimeWindow<Time, Value, BinOp>
+where
+    Time: Ord,
+    BinOp: Operator,
+{
+    /// Returns an empty window.
+    fn new() -> Self;
+    /// Inserts the tuple `(t,v)` at time `t` into the window.
+    fn insert(&mut self, t: Time, v: Value);
+    /// Removes the tuple `(t,v)` at time `t` from the window (if any).
+    fn evict(&mut self, t: Time);
+    /// Combines the values in time order and returns the result, e.g., `1+v1+v2+...+vn`.
+    fn query(&self) -> Value;
+}
+
+/// An abstract data type which maintains a fifo-ordered sliding window.
+pub trait FifoWindow<Value, BinOp>
+where
+    BinOp: Operator,
+{
+    /// Returns an empty window.
+    fn new() -> Self;
+    /// Inserts a value at the back of the window.
+    fn push(&mut self, v: Value);
+    /// Removes a value at the front of the window (if any).
+    fn pop(&mut self);
+    /// Combines the values in fifo order and returns the result, e.g., `1+v1+v2+...+vn`.
+    fn query(&self) -> Value;
+}
+
+/// An abstract data type which maintains sliding sub-window aggregates.
+pub trait SubWindow<Time, Value>
+where
+    Time: Ord,
+{
+    /// Returns the aggregate of a subwindow.
+    fn range_query(&self, range: Range<Time>) -> Value;
+}