Skip to content

Commit 001f7c7

Browse files
committed
docs: note that Array and ArrayLayout are distinct.
1 parent cd679dd commit 001f7c7

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

amaranth/lib/data.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,11 @@ class ArrayLayout(Layout):
481481
482482
Arrays that have padding can be described with a :class:`FlexibleLayout`.
483483
484+
.. note::
485+
486+
This class, :class:`amaranth.lib.data.ArrayLayout`, is distinct from and serves a different
487+
function than :class:`amaranth.hdl.Array`.
488+
484489
Attributes
485490
----------
486491
elem_shape : :class:`.ShapeLike`

docs/guide.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -813,6 +813,10 @@ Crucially, this means that any Python object can be added to an array; the only
813813

814814
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.
815815

816+
.. note::
817+
818+
Arrays, :class:`amaranth.hdl.Array`, are distinct from and serve a different function than :class:`amaranth.lib.data.ArrayLayout`.
819+
816820

817821
.. _lang-data:
818822

0 commit comments

Comments
 (0)