.. _utilities_prbs_prbs:

====
PRBS
====

The Prbs class provides both a PRBS transmitter and receiver.

Python binding
==============

This C++ class is also exported into Python as ``rogue.utilities.Prbs``.

Python API page:
- :doc:`/api/python/rogue/utilities/prbs/prbs`

Prbs objects in C++ are referenced by the following shared pointer typedef:

.. doxygentypedef:: rogue::utilities::PrbsPtr

The class description is shown below:

.. doxygenclass:: rogue::utilities::Prbs
   :members: