Skip to content

Commit

Permalink
doc: arithmetic and logic actors
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastien Bourdeauducq committed Jun 24, 2012
1 parent fd233d5 commit bbfa120
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/dataflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions migen/actorlib/composer.py
Original file line number Diff line number Diff line change
@@ -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 *
Expand Down

0 comments on commit bbfa120

Please sign in to comment.