retworkx 0.6.0

This release includes a number of new features and bug fixes. The main focus of this release was to expand the retworkx API functionality to include some commonly needed functions that were missing.

This release is also the first release to provide full support for running with Python 3.9. On previous releases Python 3.9 would likely work, but it would require building retworkx from source. Also this will likely be the final release that supports Python 3.5.

Added

• Two new functions, digraph_k_shortest_path() and graph_k_shortest_path(), for finding the k shortest path lengths from a node in a PyDiGraph and PyGraph.
• A new method, is_symmetric(), to the PyDiGraph class. This method will check whether the graph is symmetric or not
• A new kwarg, as_undirected, was added to the digraph_floyd_warshall_numpy() function. This can be used to treat the input PyDiGraph object as if it was undirected for the generated output matrix.
• A new function, digraph_find_cycle(), which will return the first cycle during a depth first search of a PyDiGraph object.
• Two new functions, directed_gnm_random_graph() and undirected_gnm_random_graph(), for generating random G(n, m) graphs.
• A new method, remove_edges_from(), was added to PyDiGraph and PyGraph. This can be used to remove multiple edges from a graph object in a single call.
• A new method, subgraph(), was added to PyDiGraph and PyGraph which takes in a list of node indices and will return a new object of the same type representing a subgraph containing the node indices in that list.
• Added support for running with Python 3.9
• A new method, to_undirected(), was added to PyDiGraph. This method will generate an undirected PyGraphobject from thePyDiGraph` object.
• A new kwarg, bidirectional, was added to the directed generator functions directed_cycle_graph(), directed_path_graph(), and directed_star_graph(). When set to True the directed graphs generated by these functions will add edges in both directions.
• Added two new functions, is_weakly_connected() and weakly_connected_components(), which will either check if a PyDiGraph object is weakly connected or return the list of the weakly connected components of an input PyDiGraph.
• The weight_fn kwarg for graph_adjacency_matrix(), digraph_adjacency_matrix(), graph_floyd_warshall_numpy(), and digraph_floyd_warshall_numpy() is now optional. Previously it always had to be specified when calling these function. But instead you can now rely on a default weight float (which defaults to 1.0) to be used for all the edges in the graph.
• Add a neighbors() method to PyGraph and PyDiGraph. This function will return the node indices of the neighbor nodes for a given input node.
• Two new methods, successor_indices() and predecessor_indices(), were added to PyDiGraph. These methods will return the node indices for the successor and predecessor nodes of a given input node.
• Two new functions, graph_distance_matrix() and digraph_distance_matrix(), were added for generating a distance matrix from an input PyGraph and PyDiGraph.
• Two new functions, digraph_dijkstra_shortest_paths() and graph_dijkstra_shortest_path(), were added for returning the shortest
  paths from a node in a PyDiGraph and a PyGraph object.
• Two new methods, insert_node_on_in_edges() and insert_node_on_out_edges(), were added to PyDiGraph. These functions
  are used to insert an existing node in between an reference node and all it's predecessors or successors.
• Two new functions, graph_dfs_edges() and digraph_dfs_edges(), were added to get an edge list in depth first order from a PyGraph and
  PyDiGraph.

Upgrade

• The numpy arrays returned by graph_floyd_warshall_numpy(), digraph_floyd_warshall_numpy(), digraph_adjacency_matrix(), and graph_adjacency_matrix() will now be in a contiguous C array memory layout. Previously they would return arrays in a column-major fortran layout. This was change was made to make it easier to interface the arrays returned by these functions with other C Python extensions. There should be no change when interacting with the numpy arrays via numpy's API.
• The bfs_successors() method now returns an object of a custom type BFSSuccessors instead of a list. The BFSSuccessors type implements the Python sequence protocol so it can be used in place like a list (except for where explicit type checking is used). This was done to defer the type conversion between Rust and Python since doing it all at once can be a performance bottleneck especially for large graphs. The BFSSuccessors class will only do the type conversion when an element is accessed.

Fixes

• When pickling PyDiGraph objects the original node indices will be preserved across the pickle.
• The random gnp functions, directed_gnp_random_graph() and undirected_gnp_random_graph(), will now also handle exact 0 or 1
  probabilities. Previously it would fail in these cases. Fixes #172

retworkx 0.5.0

This release include a number of new features and bug fixes. The main
focus of the improvements of this release was to increase the ease of
interacting with graph objects. This includes adding support for generating dot
output which can be used with graphviz (or similar tools) for visualizing
graphs adding more methods to query the state of graph, adding a generator
module for easily creating graphs of certain shape, and implementing the
mapping protocol so you can directly interact with graph objects.

Added

• A new method, to_dot(), was added to PyGraph and PyDiGraph. It will
  generate a dot format representation of the object which can be used
  with Graphivz (or similar tooling) to generate visualizations of the
  graph.
• Added a new function, strongly_connected_components(), to get the list
  of strongly connected components of a PyDiGraph object.
• A new method, compose(), for combing another graph object of the same
  type was added to PyGraph and PyDiGraph.
• The PyGraph and PyDigraph classes now implement the Python mapping
  protocol for interacting with graph nodes. You can now access and
  interact with node data directly by using standard map access patterns
  in python. For example, running graph[1] will return the data for the
  index at node 1.
• A new module, retworkx.generators, has been added. Functions in this
  module can be used for quickly generating graphs of certain shape.
• A new method, remove_node_retain_edges(), has been added to the
  PyDiGraph class. This method can be used to remove a node and add
  edges from its predecesors to its successors.
• Two new methods, edge_list() and weighted_edge_list(), for getting a
  list of tuples with the edge source and target (with or without edge
  weights) have been added to PyGraph and PyDigraph.
• A new function, cycle_basis(), for getting a list of cycles which form
  a basis for cycles of a PyGraph object.
• Two new functions, graph_floyd_warshall_numpy() and
  digraph_floyd_warshall_numpy(), were added for running the Floyd Warshall
  algorithm and returning all the shortest path lengths as a distance
  matrix.
• A new constructor method, read_edge_list(), has been added to PyGraph and
  PyDigraph. This method will take in a path to an edge list file and
  will read that file and generate a new object from the contents.
• A new method, extend_from_edge_list(), has been added to PyGraph and
  PyDiGraph. This method takes in an edge list and will add both the edges and
  nodes (if a node index used doesn't exist yet) in the list to the graph.

Fixes

• The limitation with is_isomorphic() and is_isomorphic_node_match() functions
  that would cause segfaults when comparing graphs with node removals
  has been fixed. You can now run either function with any
  PyDiGraph/PyDAG objects, even if there are node removals. Fixes #27
• If an invalid node index was passed as part of the first_layer
  argument to the layers() function

retworkx 0.4.0

Changelog

This release includes many new features and fixes, including improved
performance and better documentation. But, the biggest change for this
release is that this is the first release of retworkx that supports
compilation with a stable released version of rust. This was made
possible thanks to all the hard work of the PyO3 maintainers and
contributors in the PyO3 0.11.0 release.

Added

• A new class for undirected graphs, PyGraph, was added.
• 2 new functions graph_adjacency_matrix() and
  digraph_adjacency_matrix() to get the adjacency matrix of a PyGraph
  and PyDiGraph object.
• A new PyDiGraph method, find_adjacent_node_by_edge(), was added. This is
  used to locate an adjacent node given a condition based on the edge between them.
• New methods, add_nodes_from(), add_edges_from(),
  add_edges_from_no_data(), and remove_nodes_from() were added to PyDiGraph
  (and PyGraph). These methods allow for the addition (and removal) of
  multiple nodes or edges from a graph in a single call.
• A new function, graph_greedy_coloring(), which is used to return a
  coloring map from a PyGraph object.
• 2 new functions, graph_astar_shortest_path() and digraph_astar_shortest_path(),
  to find the shortest path from a node to a specified goal using the A*
  search algorithm.
• 2 new functions, graph_all_simple_paths() and
  digraph_all_simple_paths(), to return a list of all the simple paths
  between 2 nodes in a PyGraph or PyDiGraph object.
• 2 new functions, directed_gnp_random_graph() and
  undirected_gnp_random_graph(), to generate Gnp random PyDiGraph and
  PyGraph objects.
• 2 new functions, graph_dijkstra_shortest_path_lengths() and
  digraph_dijkstra_shortest_path_lengths(), were added for find the shortest paths
  between nodes in PyGraph or PyDiGraph object using Dijkstra's
  algorithm.

Changed

• The PyDAG class was renamed PyDiGraph to better reflect it's
  functionality. For backwards compatibility PyDAG still exists as a python
  subclass of PyDiGraph. No changes should be required for existing
  users.
• numpy is now a dependency of retworkx. This is used for the adjacency
  matrix functions to return numpy arrays. The minimum version of numpy
  supported is 1.16.0.

Fixes

• The retworkx exception classes are now properly exported from the
  retworkx module. In prior releases it was not possible to import the
  exception classes (normally to catch one being raised) requiring users
  to catch the base Exception class. This has been fixed so a
  specialized retworkx exception class can be used.

retworkx 0.3.4

Release 0.3.4

retworkx 0.3.3

Release 0.3.3

retworkx 0.3.2

Release 0.3.2

This release includes a performance fix on the ancestors() and
descendants() functions. It also changes the return type from those
functions to be a set instead of a list.

retworkx 0.3.1

Release 0.3.1

retworkx 0.3.0

Release 0.3.0

retworkx 0.2.0

Release 0.2.0

retworkx 0.1.1

Release 0.1.1