diff options
| author | Ian Johnson <ian.johnson@appliedlanguage.com> | 2012-08-14 13:46:25 +0400 |
|---|---|---|
| committer | Ian Johnson <ian.johnson@appliedlanguage.com> | 2012-08-14 13:46:25 +0400 |
| commit | b9729b7b73381b8272bf89cf43b5cbfd8b849f0c (patch) | |
| tree | 4cae5fd9225058167ae9172dbb1acae3cbcf41b1 /README.md | |
| parent | 4375281d44e94a58626937a2b2b88f09529f94d9 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 3 |
1 files changed, 3 insertions, 0 deletions
@@ -50,3 +50,6 @@ Wires can be used to convert the output of one pipeline component into the input There are no rules for creating your pipelines. Pipelines, pipeline components, and wires are instances of a Kleisli arrow, and as such any one of these objects can be used as a 'pipeline'. It's up to you how your pipeline is constructed. The helper functions allow the programmer to compose the three conceptual primatives easily. ### Pipeline Functions + +#### `helpers.cons_pipeline(input_wire, component, output_wire)` +> Construct a pipeline from a component and two wires. The input wire shall convert a real world input into the expected input for the component, and the output wire shall convert the output from the component into an expected real world value. The funtion returns a `core.arrows.KleisliArrow` object that represents the pipeline.
\ No newline at end of file |