Docs for Stanojevic (+added "minimal" for others' doc)

Author: SebVde

bafna.py

@@ -74,13 +74,13 @@ def find_semidisjoint_cycle(G):
 
 def get_fvs(og_G):
     """
-    Computes an approximate FVS using a weight-reduction approach described in Bafna et al.'s paper.
+    Computes an approximate minimal FVS using a weight-reduction approach described in Bafna et al.'s paper.
 
     Args:
         og_G (nx.Graph): The input graph.
 
     Returns:
-        set: A set of nodes forming the approximate FVS.
+        set: A set of nodes forming the approximate minimal FVS.
     """
     F = set()
     stack = []

bar_yehuda.py

@@ -227,13 +227,13 @@ def get_set_covering_cycles(H, X, Y):
 
 def subG_2_3(G):
     """
-    Approximates a FVS for G using Bar-Yehuda's algorithm.
+    Approximates a minimal FVS for G using Bar-Yehuda's algorithm.
 
     Args:
         G (nx.Graph): The input graph.
 
     Returns:
-        set: An approximated FVS for G.
+        set: An approximated minimal FVS for G.
     """
     if nx.is_forest(G):
         return set()

stanojevic.py

@@ -2,6 +2,15 @@
 
 
 def find_min_fvs(G):
+    """
+    Finds an approximate minimal FVS for the input graph.
+
+    Args:
+        G (nx.Graph): The input graph.
+
+    Returns:
+        set: A set of vertices forming the approximate minimal FVS.
+    """
     fvs = set()
     while True:
         try:
@@ -10,6 +19,7 @@ def find_min_fvs(G):
             break
 
         cycle_nodes = {node for e in cycle for node in e}
+        # Select the node with the highest degree to remove
         v = max(cycle_nodes, key=lambda x: G.degree(x))
         fvs.add(v)
         G.remove_node(v)
@@ -18,4 +28,13 @@ def find_min_fvs(G):
 
 
 def approx_decycling_number_stanojevic(G):
+    """
+    Approximates the decycling number of the graph using Stanojevic's algorithm.
+
+    Args:
+        G (nx.Graph): The input graph.
+
+    Returns:
+        int: The approximate decycling number of the graph.
+    """
     return len(find_min_fvs(G.copy()))