FPGA/myhdl
1
0
Fork 0
mirror of https://github.com/myhdl/myhdl.git synced 2025-01-24 21:52:56 +08:00
Code Issues Projects Releases Wiki Activity

bin

Browse Source
This commit is contained in:
jand 2003-02-17 10:08:01 +00:00
parent 283882d29b
commit f8eb9e6d49
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/reference.tex
View File

@ -22,7 +22,7 @@ Run the simulation forever (by default) or for a specified duration.
\section{The \class{Signal} class}
\label{signal}
\begin{classdesc}{Signal}{val, \optional{delay}}
\begin{classdesc}{Signal}{val \optional{, delay}}
This class is used to construct a new signal and to initialize its
value to \var{val}. Optionally, a delay can be specified.
\end{classdesc}
@ -128,7 +128,7 @@ stop a simulation. Can be subclassed and raised in generator code.
Return the current simulation time.
\end{funcdesc}
\begin{funcdesc}{downrange}{high, \optional{low=0}}
\begin{funcdesc}{downrange}{high \optional{, low=0}}
Generates a downward range list of integers. Modeled after the
standard \code{range} function, but works in the downward
direction. The returned interval is half-open, with \var{high} not
@ -138,6 +138,17 @@ This function is especially useful with the \class{intbv} class, that
also works with downward indexing.
\end{funcdesc}
\begin{funcdesc}{bin}{num \optional{, width}}
Return a representation as a bit string. If \var{width} is provided,
and if it is larger that the width of the default representation, the
bit string is padded with the sign bit.
This function complements the standard Python conversion functions
\code{hex} and \code{oct}. A binary string representation is often
needed in hardware design.
\end{funcdesc}
\section{The \class{intbv} class}
\begin{classdesc}{intbv}{arg}
@ -229,17 +240,6 @@ this method as an unbound method with an explicit first \class{intbv}
argument.
\end{methoddesc}
\class{intbv} objects support the standary Python \code{hex} and
\code{oct} conversions to a string representation. In hardware design, a
binary string representation is often needed. Therefore, they also
have a method that converts to a binary string:
\begin{methoddesc}[intbv]{bin}{\optional{width}}
Return a representation as a bit string. If \var{width} is provided,
and if it is larger that the width of the default representation, the
bit string is padded with the sign bit.
\end{methoddesc}
In addition, an \class{intbv} object supports the iterator protocol. This
makes it possible to iterate over all its bits, from the high index to
index 0. Again, this is only possible for \class{intbv} objects with a