From 072b7b6dedff9d69f9c408bd80b264e0092d8158 Mon Sep 17 00:00:00 2001 From: Jacob Brown Date: Tue, 7 Nov 2023 14:44:50 -0700 Subject: [PATCH] updated feedback folding docstring --- spydrnet_tmr/analysis/feedback_folding.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/spydrnet_tmr/analysis/feedback_folding.py b/spydrnet_tmr/analysis/feedback_folding.py index 60528a3..92e6af3 100644 --- a/spydrnet_tmr/analysis/feedback_folding.py +++ b/spydrnet_tmr/analysis/feedback_folding.py @@ -5,9 +5,13 @@ def fold_feedback(connectivity_graph, verbose=True): ''' - Analyzes tight feedback in a design. + Analyzes feedback in a design. Takes a networkx digraph and returns the following: + + feedback_hierarchy - frozensets inside frozensets inside frozensets. Feedback hierarchy from large loops down to small loops + distances - a dictionary. Keys are frozensets of hinstances in the feedback loop. Item is the distance. + working_graph - networkx digraph. The resulting graph after all feedback has been folded down - :param connectivity_graph: + :param connectivity_graph: A networkx digraph created ''' sccs = list(sorted(nx.strongly_connected_components(connectivity_graph), key=len)) scc_count = len(sccs)