Documenting circuit module

This commit is contained in:
Stefan Holst committed 2020-12-18 21:14:00 +09:00
1 parent cff18e0915
commit 5830608527
5 files changed
+169 -61

No files matched your search

+11 -7
View File
@@ -1,26 +1,30 @@
Core Data Structures
====================
Data Structures
===============
KyuPy provides two types of core data structures, one for gate-level circuits, and a few others for representing and storing logic data and signal values.
The data structures are designed to work together nicely with numpy arrays.
For example, all the nodes and connections in the circuit graph have numerical indices that can be used to access ndarrays with associated data.
For example, all the nodes and connections in the circuit graph have consecutive integer indices that can be used to access ndarrays with associated data.
Circuit graphs also define an ordering of inputs, outputs and other nodes to easily process test vector data and alike.
Module :mod:`kyupy.circuit`
---------------------------
Circuit Graph - :mod:`kyupy.circuit`
------------------------------------
.. automodule:: kyupy.circuit
.. autoclass:: kyupy.circuit.Node
:members:
.. autoclass:: kyupy.circuit.Line
:members:
.. autoclass:: kyupy.circuit.Circuit
:members:
Logic Values and Arrays
-----------------------
M-Valued Logic - :mod:`kyupy.logic`
-----------------------------------
.. automodule:: kyupy.logic
:members:
.. autoclass:: kyupy.logic.MVArray
:members: