doc: arithmetic and logic actors
authorSebastien Bourdeauducq <sebastien@milkymist.org>
Sun, 24 Jun 2012 17:56:31 +0000 (19:56 +0200)
committerSebastien Bourdeauducq <sebastien@milkymist.org>
Sun, 24 Jun 2012 17:56:31 +0000 (19:56 +0200)
doc/dataflow.rst
migen/actorlib/composer.py

index d77971a138aaf4ae30cec678f690e560496ff9b8..463daf446ddf5f1cded932ff05861152806f1ce4 100644 (file)
@@ -184,6 +184,12 @@ The ``Token`` class contains the following items:
 Arithmetic and logic actors
 ===========================
 
+The ``migen.actorlib.ala`` module provides arithmetic and logic actors for the usual integer operations.
+
+If complex operation combinations are needed, the ``ComposableSource`` class can be used. It overloads Python operators to make them instantiate the arithmetic and logic actors and connect them into an existing network. This creates a small internal domain-specific language (DSL).
+
+The ``ComposableSource`` class is a derivative of the ``ActorNode`` class (see :ref:`actornetworks`) and should be used in the place of the latter when the DSL feature is desired.
+
 .. _busactors:
 
 Bus actors
index 683186d1d9a5c886f0b2ab433685fb4c7cb47e34..d8d86ce02fe7c3eec32645cf4a20ac4b7b7b73dd 100644 (file)
@@ -1,3 +1,5 @@
+# TODO: merge this into ala + derive ComposableSource from ActorNode
+
 from migen.flow.actor import *
 from migen.flow.plumbing import *
 from migen.flow.network import *