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

hdl.ast: clarify docs for Value.rotate_{left,right}.

Browse source 
"Rotate modulo 2**len(self)" is redundant because that's just how
rotates work.
This commit is contained in:
whitequark 2020-05-19 23:43:25 +00:00
parent 404b2e07e4
commit 72ef4303a9
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
nmigen/hdl/ast.py
View file

@ -424,7 +424,7 @@ class Value(metaclass=ABCMeta):
return Cat(*matches).any()
def rotate_left(self, offset):
"""Rotate left by constant modulo 2**len(self).
"""Rotate left by constant amount.
Parameters
----------
@ -434,7 +434,7 @@ class Value(metaclass=ABCMeta):
Returns
-------
Value, out
The input rotated left by offset if offset is positive, else the input rotated right by -offset.
If the offset is positive, the input rotated left. Otherwise, the input rotated right.
"""
if not isinstance(offset, int):
raise TypeError("Rotate amount must be an integer, not {!r}".format(offset))
@ -442,7 +442,7 @@ class Value(metaclass=ABCMeta):
return Cat(self[-offset:], self[:-offset]) # meow :3
def rotate_right(self, offset):
"""Rotate right by constant modulo 2**len(self).
"""Rotate right by constant amount.
Parameters
----------
@ -452,7 +452,7 @@ class Value(metaclass=ABCMeta):
Returns
-------
Value, out
The input rotated right by offset if offset is positive, else the input rotated left by -offset.
If the offset is positive, the input rotated right. Otherwise, the input rotated right.
"""
if not isinstance(offset, int):
raise TypeError("Rotate amount must be an integer, not {!r}".format(offset))