Merge branch 'master' of github.com:loopperfect/conduit

Author: nikhedonia

.travis.yml

@@ -31,3 +31,17 @@ before_install:
 script:
 - buckaroo install
 - ./test.sh
+- buck build :bundle
+
+deploy:
+  provider: releases
+  api_key:
+    secure: fKnFdbsFZqotefPp0VrAN3CnUWsjizAs0Jnr71ZhrAX6yv82bJwa0sy3TPdWeGQcMEGWaEZYU/t1ovZ2NX1uVrkNXv9BI1GMiJdkM7IVVZ1tUYskmfr9Xvtgr84AVJbsKu775r84jUQ3/wNw2FeDBvvPbZ/1WM1nN4XaKup5rpjIU01uc1Xyzz4PhuaT4LXP7lQ82uV838cDGFn2le9AKtCLlcI5+fe6/ttjGm+46m32xSIwwbuzFNdO/Epw4TEq+VbFeoRSKmxENXa70I4CXxqaKcmSxvS5yRmQQENjNYqNXmI6Gx/9Ro7lJMni7P7jPGyh5G4G/s9UEhHefklecIgsq/eXuGprN5NcBJIOvZP5dReMR/9zAonzI4qS0V2/igoZau5VEH/twhCA2nOk4pTLRFsLbBibs2JmT6WTbAMsJuliae4EvivdQ+b99TphxTJia3EPTd2THwOfvHJ1zEc23Vgd7B7j5laVE9G553i03U/d7Cc3KNDt7yz+VDOVxm1f2CxhD1KpmQ93TDe42oNs96bcABtEQyi7IJZNz8zClBSyF1e1HwdImNojlYHnT5EkguVNpCm45dVcecHLGTvlWTkNY6J+6Br6s6BEGWTiEZDHngsi0PJ4S8La1wBJ0UGdHfxvijtAmqfCZoRUPLwDkIb/meZ7Eav/VYTIu4A=
+  file_glob: true
+  file:
+    - "buck-out/gen/bundle/bundle.zip"
+  skip_cleanup: true
+  on:
+    repo: LoopPerfect/conduit
+    tags: true
+    all_branches: true

BUCK

@@ -41,3 +41,17 @@ cxx_library(
     'PUBLIC', 
   ],
 )
+
+genrule(
+  name = 'bundle', 
+  out = 'bundle.zip', 
+  srcs = glob([
+    'include/conduit/**/*.hpp', 
+  ]), 
+  cmd = ' && '.join([
+    'cp -r $SRCDIR/. $TMP', 
+    'cp $(location :mega-header) $TMP/include/conduit/conduit.hpp', 
+    'cd $TMP', 
+    'zip -r $OUT .', 
+  ]), 
+)

README.md

@@ -13,6 +13,34 @@ Conduit's goals are:
 
 These are attained by adopting a monadic interface that leverages zero-cost abstractions.
 
+## Build
+
+To fetch dependencies (only required for testing and benchmarks): 
+
+```bash=
+buckaroo install
+```
+
+To build the library: 
+
+```bash=
+buck build :conduit
+```
+
+To run the examples: 
+
+```bash=
+buck run examples/primes
+buck run examples/fibonacci
+# etc...
+```
+
+To run the tests: 
+
+```bash=
+buck test test
+```
+
 ## Examples
 
 Use `co_yield` to define a coroutine and transform it using high-level operators.

docs/Allocators.md

@@ -0,0 +1,30 @@
+# Allocators 
+
+The current implementation of coroutines implicitly allocates a coroutine - unless optimized - on the heap.
+As a result the user cannot initialize any coroutines using a custom allocator object.
+
+This means only static allocators can be supported.
+One way to costumize the allocation behaviour is via an extra template parameter `seq<T, AllocatorType>`.
+
+An alternative is to implement a costomization point using template specializations.
+
+We have chosen the latter solution as this does not require threading the AllocatorType through each operator.
+We believe that this reduces the cognitive overhead required to implement new algorithms and will increase developer productivity.
+This solution implies that you have to choose an allocator seq<T> before your application runs.
+
+## How does the customization point work?
+
+We have defined a generic type `template<class T> promise_allocator` which is used for each `seq<T>`.
+By default it uses the standard allocator. 
+In order to change the promise_allocator specialize this template:
+
+```c++
+template<class T>
+struct promise_allocator<seq<T>> {
+  void* allocate(std::size_t);
+  void deallocate(void*);
+};
+```
+
+This definition will be prefrred by the compiler as this a higher specificity compared to default definition.
+You can use a predifined allocator by just including `include/conduit/allocators/*.hpp` or implement your own in a same fashion.

docs/FAQ.md

@@ -21,6 +21,8 @@ Rx allows you to build and transform *push* based data processing pipelines. Con
 
 Range-V3 focuses on implementing an API compatible with the Ranges-TS. Although there is some intersection between Range-V3 and Conduit's Sequences API, Conduit's API is much leaner. This enables more composability and compiler optimizations. 
 
+Furthermore Range-V3 implements every operation using templates, leading to a unique type for each iterator/container constructed. This leads to large compile times. In Conduit every operation returns a `seq<T>`.
+
 ### Why does `seq` not implement `.base()` ? 
 
 `.base()` returns the pointer to the original iterator. For example: 

examples/random/BUCK

@@ -0,0 +1,16 @@
+cxx_binary(
+  name = 'random',
+  srcs = [
+    'main.cpp', 
+  ],
+  compiler_flags = [
+    '-fPIC', 
+    '-pthread', 
+  ],
+  linker_flags = [
+    '-pthread', 
+  ],
+  deps = [
+    '//:conduit', 
+  ], 
+)

examples/random/main.cpp

@@ -0,0 +1,27 @@
+#include <random>
+#include <iostream>
+
+#include <conduit/conduit.hpp>
+
+using namespace conduit;
+using namespace operators;
+
+auto random_seq = [](int seed) -> seq<double> {
+  // pseudo-random
+  std::mt19937 engine(seed);
+  std::uniform_real_distribution<> dist;
+
+  while (true) {
+    co_yield dist(engine);
+  }
+};
+
+int main() {
+  int seed = 1234;
+
+  for (auto x : random_seq(seed) >> take(10)) {
+    std::cout << x << std::endl;
+  }
+
+  return 0;
+}

examples/squares/BUCK

@@ -0,0 +1,16 @@
+cxx_binary(
+  name = 'squares',
+  srcs = [
+    'main.cpp', 
+  ],
+  compiler_flags = [
+    '-fPIC', 
+    '-pthread', 
+  ],
+  linker_flags = [
+    '-pthread', 
+  ],
+  deps = [
+    '//:conduit', 
+  ], 
+)

examples/squares/main.cpp

@@ -0,0 +1,23 @@
+#include <iostream>
+#include <conduit/conduit.hpp>
+
+using namespace conduit;
+using namespace operators;
+
+auto squares = []() -> seq<int> {
+  int x = 0;
+
+  while ( true ) {
+    co_yield x * x;
+
+    ++x;
+  }
+};
+
+int main() {
+  for (auto x : squares() >> take(10)) {
+    std::cout << x << std::endl;
+  }
+
+  return 0;
+}