Skip to content
Snippets Groups Projects
Commit 33e7d27d authored by Oscar Gustafsson's avatar Oscar Gustafsson :bicyclist:
Browse files

Improve documentation for signal generators

parent 2ead0284
No related branches found
No related tags found
1 merge request!168Improve documentation for signal generators
Pipeline #88977 passed
......@@ -2,11 +2,18 @@
B-ASIC signal generators
These can be used as input to Simulation to algorithmically provide signal values.
Especially, all classes defined here will act as a callable which accepts an integer
time index and returns the value at that time.
It is worth noting that the standard basic arithmetic operations do work on these,
so one can, e.g., write ``0.5 * Step()`` to get a step input with height 0.5.
This is handled by a number of private generator classes. Check out the source code
if you want more information.
"""
from math import pi, sin
from numbers import Number
from typing import Callable, Sequence
from typing import Sequence
class SignalGenerator:
......
......@@ -2,5 +2,10 @@
``b_asic.signal_generator``
***************************
.. inheritance-diagram:: b_asic.signal_generator
:parts: 1
:top-classes: b_asic.signal_generator.SignalGenerator
.. automodule:: b_asic.signal_generator
:members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment