summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements/BufferedStream.md19
-rw-r--r--doc/requirements/UnbufferedStream.md19
2 files changed, 38 insertions, 0 deletions
diff --git a/doc/requirements/BufferedStream.md b/doc/requirements/BufferedStream.md
new file mode 100644
index 00000000..1ac01a0f
--- /dev/null
+++ b/doc/requirements/BufferedStream.md
@@ -0,0 +1,19 @@
+# BufferedStream
+
+## Abstract:
+
+One type that has to satisfy a BufferedStream operator and type.
+
+## Rationale:
+
+- HPC systems.
+- I/O systems.
+- HFT systems.
+
+## Example:
+
+```cpp
+BStream<BOperator, BType>;
+```
+
+BOperator must not flush at all times, but have the option to.
diff --git a/doc/requirements/UnbufferedStream.md b/doc/requirements/UnbufferedStream.md
new file mode 100644
index 00000000..80536b44
--- /dev/null
+++ b/doc/requirements/UnbufferedStream.md
@@ -0,0 +1,19 @@
+# BufferedStream
+
+## Abstract:
+
+One type that has to satisfy an unbuffered Stream operator and type.
+
+## Rationale:
+
+- Fast and direct-flush operations.
+- High-Throughput systems.
+
+## Example:
+
+```cpp
+UBStream<UBOperator, UBType>;
+```
+
+UBOperator must flush at all times!
+