Possible Code Refactoring

[cczhu]

Transplanting comments by @candu on the other repo to here.

• [ ] make digraph_to_bipartite always return a directed graph; calling methods can then use .to_undirected to return an undirected graph.
• [ ] use map() to build the bipartite graph, e.g. nodesb_top = map(lambda item: str(item) + '_i', G.nodes()).
• [x] Refactor linker so that each linker algorithm is a class, inheriting from LinkerBase which houses the digraph_to_bipartite and matching_to_digraph routines. After this, we can also split up the matching_to_digraph class into subroutines to_directed_matching and directed_matching_to_digraph. This allows us to:
  • [ ] drop return_matching=True.
  • [ ] move check_degree et al. into the unit tests.
• [ ] min_edge = c_edges[0]... -> return min(c_edges, key=lambda edge: Gw.edges[edge][mintype]) because Python has solved it for us.
• [ ] self._disable_tqdm = True if not progress_bar else False -> self._disable_tqdm = not progress_bar
• [ ] Consider refactoring get_paths to

remaining_nodes = set(G.nodes)
while remaining_nodes:
  current_path = []
  cnode = remaining_nodes.pop()
  # more magic...

• [ ] Add fuzzy testing for get_paths.

[cczhu]

Now that we have OR-Tools and agent modelling in the other repo:

• [x] Refactor batched linker to require users to manually specify a linking algorithm. This might be somewhat annoying for the user, but will force them to examine the API or documentation to see which algorithms are available. Internally, we could eliminate the batched linker subclasses, making the code much more elegant.
• [ ] Similarly, we can force the user to pass a shift tracking object to the batched linker shift class.
• [ ] Possibly generalize the shift tracker to handle all linking cases. get_paths should then return a list of path objects, not a list of values (it should still be trivial to return a list of lists, since that functionality is built into the ShiftTracker class already).
• [ ] Set shift termination rules in each DriverShiftBase subclass, so that we only need one ShiftTracker class that the user needs to instantiate.

[cczhu]

Will be each of these off to individual small PRs. Updating as needed.

[cczhu]

"Refactor linker..." and "Refactor batched linker" comments partly addressed by #7.