Graaf  

Rust-powered directed graphs.

Table of Contents

• Installation
• Representations
• Generators
• Operations
• Algorithms
  • Bellman-Ford-Moore
  • Breadth-First Search
  • Depth-First Search
  • Dijkstra
  • Distance Matrix
  • Floyd-Warshall
  • Predecessor Tree
  • Tarjan
• Changelog
• License
• Contact
• Links

Installation

Add the following to your Cargo.toml:

[dependencies]
graaf = "0.87.3"

Representations

• adjacency_list represents unweighted sparse digraphs.
• adjacency_matrix represents unweighted dense digraphs.
• adjacency_list_weighted represents arc-weighted sparse digraphs.
• edge_list represents unweighted sparse digraphs.

Generators

• Biclique generates a complete bipartite digraph.
• Circuit generates a circuit digraph.
• Complete generates a complete digraph.
• Cycle generates a bidirectional circuit.
• Empty generates a digraph with no arcs.
• ErdosRenyi generates a random digraph.
• Path generates a path digraph.
• RandomTournament generates a random tournament.
• Star generates a star digraph.

Operations

• AddArcWeighted adds an arc to an arc-weighted digraph.
• AddArc adds an arc to an unweighted digraph.
• ArcWeight returns an arc's weight.
• ArcsWeighted returns a digraph's weighted arcs.
• Arcs returns a digraph's arcs.
• Complement returns a digraph's complement.
• Converse returns a digraph's converse.
• DegreeSequence returns a digraph's degree sequence.
• Degree returns a vertex's degree.
• HasArc checks whether a digraph contains an arc.
• HasEdge checks whether a digraph contains an edge.
• HasWalk checks whether a digraph contains a walk.
• InNeighbors returns a vertex's in-neighbors.
• IndegreeSequence returns a digraph's indegree sequence.
• Indegree returns a vertex's indegree.
• IsBalanced checks whether a digraph is balanced.
• IsComplete checks whether a digraph is complete.
• IsIsolated checks whether a vertex is isolated.
• IsOriented checks whether a digraph is oriented.
• IsPendant checks whether a vertex is a pendant.
• IsRegular checks whether a digraph is regular.
• IsSemicomplete checks whether a digraph is semicomplete.
• IsSimple checks whether a digraph is simple.
• IsSpanningSubdigraph checks whether a digraph spans a superdigraph.
• IsSubdigraph checks whether a digraph is a subdigraph.
• IsSuperdigraph checks whether a digraph is a superdigraph.
• IsSymmetric checks whether a digraph is symmetric.
• IsTournament checks whether a digraph is a tournament.
• Order returns the number of vertices in a digraph.
• OutNeighborsWeighted returns a vertex's weighted out-neighbors.
• OutNeighbors returns a vertex's out-neighbors.
• OutdegreeSequence returns a digraph's outdegree sequence.
• Outdegree returns a vertex's outdegree.
• RemoveArc removes an arc from a digraph.
• SemidegreeSequence returns a digraph's semidegree sequence.
• Sinks returns a digraph's sinks.
• Size returns the number of arcs in a digraph.
• Sources returns a digraph's sources.
• Vertices returns a digraph's vertices.

Algorithms

Bellman-Ford-Moore

The Bellman-Ford-Moore algorithm finds the shortest paths in an arc-weighted digraph with negative weights.

• single_source_distances finds the shortest distances.

Breadth-First Search

A breadth-first search explores the vertices of an unweighted digraph in order of their distance from a source.

• Bfs iterates over the vertices.
• BfsDist iterates over the vertices and their distance from the source.
• BfsPred iterates over the vertices and their predecessors.
• BfsDist::distances finds the shortest distances.
• BfsPred::predecessors finds the predecessors.
• BfsPred::shortest_path finds the shortest path.

Depth-First Search

A depth-first search explores the vertices of an unweighted digraph in order of their depth from a source.

• Dfs iterates over the vertices.
• DfsDist iterates over the vertices and their distance from the source.
• DfsPred iterates over the vertices and their predecessors.
• DfsPred::predecessors finds the predecessors.

Dijkstra

Dijkstra's algorithm finds the shortest paths in an arc-weighted digraph.

• Dijkstra iterates over the vertices.
• DijkstraDist iterates over the vertices.
• DijkstraPred iterates over the vertices and their predecessors.
• DijkstraDist::distances finds the shortest distances.
• DijkstraPred::predecessors finds the predecessors.
• DijkstraPred::shortest_path finds the shortest path.

Distance Matrix

A DistanceMatrix contains the shortest distances between all pairs of vertices in a digraph.

• center finds the center of the digraph.
• diameter finds the diameter of the digraph.
• eccentricities returns the eccentricities of the vertices.
• is_connected checks if the digraph is connected.
• periphery finds the periphery of the digraph.

Floyd-Warshall

The Floyd-Warshall algorithm finds the distance between each pair of vertices in an arc-weighted digraph.

• distances finds the shortest distances.

Predecessor Tree

A PredecessorTree is the result of a search and contains the predecessors of the vertices.

• search finds a vertex by value.
• search_by finds a vertex by predicate.

These functions produce a PredecessorTree:

• BfsPred::predecessors
• DfsPred::predecessors
• DijkstraPred::predecessors

Tarjan

Tarjan's algorithm finds strongly connected components in a digraph.

• strongly_connected_components finds strongly connected components.

Changelog

See CHANGELOG.md for a list of changes.

License

Licensed under Apache License, Version 2.0 or MIT license at your option.

Contact

Feel free to reach out with questions or suggestions.

• Email
• GitHub

Links

• Coveralls
• Crates.io
• Docs.rs