Changes between Version 5 and Version 6 of Architecture

Timestamp:

03/20/10 19:12:26 (3 years ago)

Author:

blamario (IP: 99.241.117.248)

Comment:

--

Architecture

@@ -7 +7 @@
 The framework relies on the following packages:
  * [wiki:monad-parallel monad-parallel] to enable parallel execution of monadic computations, and
- * [wiki:monad-coroutine monad-coroutine] to enable the same monadic computations to suspend and resume each other.
+ * [wiki:monad-coroutine monad-coroutine] for the ability to suspend and resume monadic computations.
 
 == Streams ==
 
-The lowest layer builds on the coroutine foundation to provide streaming computations. The main idea here is to introduce sinks and sources:
+The lowest layer builds on the monad-coroutine foundation to provide streaming computations. The main idea here is to introduce sinks and sources:
 
 {{{
 data Sink (m :: * -> *) a x = Sink {
-   put :: forall d. (AncestorFunctor a d) => x -> Coroutine d m Bool,
-   canPut :: forall d. (AncestorFunctor a d) => Coroutine d m Bool
+   put :: forall d. (AncestorFunctor a d) => x -> Coroutine d m ()
    }
 
@@ -31 +30 @@
 }}}
 
-This function takes two coroutines as arguments, ''producer'' and ''consumer''. The producer gets a sink argument, and the consumer a source argument. All data that the producer writes to the sink can be read from the source by the consumer. The arrangement couldn't be simpler. Here is a contrived example of a producer/consumer pair:
+This function takes two coroutines as arguments, ''producer'' and ''consumer''. The producer takes a sink argument, and the consumer a source argument. All data that the producer writes to the sink can be read from the source by the consumer. The arrangement couldn't be simpler. Here is a contrived example of a producer/consumer pair:
 
 {{{
@@ -47 +46 @@
 }}}
 
-The {{{rangeProducer}}} coroutine produces a range of integers while the {{{sumConsumer}}} consumes all the numbers and sums them up. The two coroutines are bound together by {{{pipe}}}. Note that either of them could be bound to a different coroutine and still perform its job. Furthermore, though in this example both coroutines run in the IO monad, they are completely generic and could run in any monad.
+The {{{rangeProducer}}} coroutine produces a range of integers while the {{{sumConsumer}}} consumes all the numbers and sums them up. The two coroutines are bound together by {{{pipe}}}. Note that either of them could be replaced by a different coroutine of the same type and the other coroutine would still perform its job. Furthermore, though in this example both coroutines run in the IO monad, they are completely generic and could run in any monad.
 
 == Components and combinators ==
@@ -56 +55 @@
 type OpenConsumer m a d x r = AncestorFunctor a d => Source m a x -> Coroutine d m r
 type OpenProducer m a d x r = AncestorFunctor a d => Sink m a x -> Coroutine d m r
-type OpenTransducer m a1 a2 d x y = 
-   (AncestorFunctor a1 d, AncestorFunctor a2 d) => Source m a1 x -> Sink m a2 y -> Coroutine d m [x]
-type OpenSplitter m a1 a2 a3 a4 d x b =
+type OpenTransducer m a1 a2 d x y r = 
+   (AncestorFunctor a1 d, AncestorFunctor a2 d) => Source m a1 x -> Sink m a2 y -> Coroutine d m r
+type OpenSplitter m a1 a2 a3 a4 d x b r =
    (AncestorFunctor a1 d, AncestorFunctor a2 d, AncestorFunctor a3 d, AncestorFunctor a4 d) =>
-   Source m a1 x -> Sink m a2 x -> Sink m a3 x -> Sink m a4 b -> Coroutine d m [x]
+   Source m a1 x -> Sink m a2 x -> Sink m a3 x -> Sink m a4 b -> Coroutine d m r
 
 newtype Consumer m x r = Consumer {consume :: forall a d. OpenConsumer m a d x r}
 newtype Producer m x r = Producer {produce :: forall a d. OpenProducer m a d x r}
-newtype Transducer m x y = Transducer {transduce :: forall a1 a2 d. OpenTransducer m a1 a2 d x y}
-newtype Splitter m x b = Splitter {split :: forall a1 a2 a3 a4 d. OpenSplitter m a1 a2 a3 a4 d x b}
+newtype Transducer m x y = Transducer {transduce :: forall a1 a2 d. OpenTransducer m a1 a2 d x y ()}
+newtype Splitter m x b = Splitter {split :: forall a1 a2 a3 a4 d. OpenSplitter m a1 a2 a3 a4 d x b ()}
 }}}