Skip to content

Commit

Permalink
Documented queue_t and integer_array_t
Browse files Browse the repository at this point in the history
  • Loading branch information
kraigher committed Feb 21, 2018
1 parent 6943a98 commit f85268c
Show file tree
Hide file tree
Showing 7 changed files with 800 additions and 746 deletions.
35 changes: 35 additions & 0 deletions docs/data_types/user_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _data_types_library:

Data Types
==========

Introduction
------------
VUnit comes with a number of convenient data types included:

:queue_t: A queue (fifo) which to which any VHDL primitive data type
can be pushed and popped by serializing the data to bytes
internally. This queue can be used to for example push
expected data from a driver process to a checker process in
a test bench. :ref:`Queue API <queue_pkg>`

:integer_array_t: An dynamic array of integers in up to 3 dimensions.
Supports dynamic append and reshape operations.
Supports reading and writing data to/from *.csv* or *.raw* byte files.
:ref:`Integer array API <integer_array_pkg>`

.. _queue_pkg:

queue package
-------------
.. literalinclude:: ../../vunit/vhdl/data_types/src/queue_pkg.vhd
:language: vhdl
:lines: 7-

.. _integer_array_pkg:

integer_array package
----------------------
.. literalinclude:: ../../vunit/vhdl/data_types/src/integer_array_pkg.vhd
:language: vhdl
:lines: 7-
1 change: 1 addition & 0 deletions docs/vhdl_libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ VHDL Libraries
check/user_guide
run/user_guide
com/user_guide
data_types/user_guide
verification_components/user_guide
Loading

0 comments on commit f85268c

Please sign in to comment.