usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: note that Array and ArrayLayout are distinct.

Browse source
This commit is contained in:
Catherine 2024-05-12 13:27:34 +00:00
parent cd679dd9b3
commit 001f7c78dc
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
amaranth/lib/data.py
View file

@ -481,6 +481,11 @@ class ArrayLayout(Layout):
Arrays that have padding can be described with a :class:`FlexibleLayout`.
.. note::
This class, :class:`amaranth.lib.data.ArrayLayout`, is distinct from and serves a different
function than :class:`amaranth.hdl.Array`.
Attributes
----------
elem_shape : :class:`.ShapeLike`

4
docs/guide.rst
View file

@ -813,6 +813,10 @@ Crucially, this means that any Python object can be added to an array; the only
Each time an array proxy object with :py:`n` elements is used in an expression, it generates a multiplexer with :py:`n` branches. However, using :py:`k` of such array proxy objects in an expression generates a multiplexer with :py:`n**k` branches. This can generate extremely large circuits that may quickly exhaust the resources of the synthesis target or even the available RAM.
.. note::
Arrays, :class:`amaranth.hdl.Array`, are distinct from and serve a different function than :class:`amaranth.lib.data.ArrayLayout`.
.. _lang-data: