Crate rshyper_algo

rshyper-algo

this crate provides algorithms and operators for hypergraphs.

Features

• astar: enables the A* search algorithm for hypergraphs
• breadth_first: enables the breadth-first search algorithm for hypergraphs
• depth_first: enables the depth-first search algorithm for hypergraphs
• dijkstra: enables Dijkstra’s algorithm for finding the shortest path in hypergraphs

Re-exports

pub use self::astar::AStarSearch;

pub use self::breadth_first::BreadthFirstTraversal;

pub use self::depth_first::DepthFirstTraversal;

pub use self::dijkstra::Dijkstra;

Modules

astar

this module implements the A* search algorithm

breadth_first

this module implements the breadth-first search algorithm

depth_first

this module implements the depth-first search algorithm

dijkstra

this module implements the Dijkstra’s algorithm for finding the shortest path in a hypergraph

error

this module implements the AlgoError type for algorithms in the rshyper crate.

traits

this module implements additional traits for defining algorithmic operators on hypergraphs.

Enums

AlgoError

The error type for this crate

Traits

GraphOperator

this trait is used to denote an algorithmic operator that can be applied to a hypergraph.

GraphSearch

The GraphSearch trait is an automatically implemented trait for types that implement both the Search and Traversal traits indicating it can successfully perform a search on some graph structure while also allowing traversal of the graph.

GraphicAlgorithm

this trait is used to denote an algorithm that can be applied to a hypergraph

Heuristic

Heuristic defines a common interface for heuristic functions compatible with the A* search implementation

PathFinder

The PathFinder establishes an interface for path-finding operators on hypergraphs. Each implementor will provide a particular algorithm for finding paths between any two vertices in a hypergraph.

Search

A trait defining a search algorithm for a hypergraph

Traversal

Traversal trait defines an interface for operators capable of traversing some type, which in this case is a hypergraph.

Type Aliases

AlgoResult

A type alias for a Result with the crate-specific error type AlgoError