Struct hypergraph::Hypergraph

pub struct Hypergraph<V, HE> {
    pub vertices: IndexMap<V, IndexSet<usize>>,
    pub hyperedges: IndexSet<HyperedgeKey<HE>>,
    // some fields omitted
}

A directed hypergraph composed of generic vertices and hyperedges.

Fields

vertices: IndexMap<V, IndexSet<usize>>

Vertices are stored as a map whose unique keys are the weights and the values are a set of the hyperedges indexes which include

hyperedges: IndexSet<HyperedgeKey<HE>>

Hyperedges are stored as a set whose unique keys are a combination of vertices indexes and a weight. Two or more hyperedges can contain the exact same vertices (non-simple hypergraph).

Implementations

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn add_hyperedge(
    &mut self,
    vertices: Vec<VertexIndex>,
    weight: HE
) -> Result<HyperedgeIndex, HypergraphError<V, HE>>

Adds a hyperedge as an array of vertices indexes and a custom weight in the hypergraph. Returns the weighted index of the hyperedge.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn clear_hyperedges(&mut self) -> Result<(), HypergraphError<V, HE>>

Clears all the hyperedges from the hypergraph.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn contract_hyperedge_vertices(
    &mut self,
    hyperedge_index: HyperedgeIndex,
    vertices: Vec<VertexIndex>,
    target: VertexIndex
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Contracts a set of the vertices of a hyperedge into one single vertex. Returns the updated vertices. Based on https://en.wikipedia.org/wiki/Edge_contraction

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn count_hyperedges(&self) -> usize

Returns the number of hyperedges in the hypergraph.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_hyperedge_vertices(
    &self,
    hyperedge_index: HyperedgeIndex
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Gets the vertices of a hyperedge.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_hyperedge_weight(
    &self,
    hyperedge_index: HyperedgeIndex
) -> Result<HE, HypergraphError<V, HE>>

Gets the weight of a hyperedge from its index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_hyperedges_connecting(
    &self,
    from: VertexIndex,
    to: VertexIndex
) -> Result<Vec<HyperedgeIndex>, HypergraphError<V, HE>>

Gets the hyperedges directly connecting a vertex to another.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_hyperedges_intersections(
    &self,
    hyperedges: Vec<HyperedgeIndex>
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Gets the intersections of a set of hyperedges as a vector of vertices.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn remove_hyperedge(
    &mut self,
    hyperedge_index: HyperedgeIndex
) -> Result<(), HypergraphError<V, HE>>

Removes a hyperedge by index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn reverse_hyperedge(
    &mut self,
    hyperedge_index: HyperedgeIndex
) -> Result<(), HypergraphError<V, HE>>

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn update_hyperedge_vertices(
    &mut self,
    hyperedge_index: HyperedgeIndex,
    vertices: Vec<VertexIndex>
) -> Result<(), HypergraphError<V, HE>>

Updates the vertices of a hyperedge by index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn update_hyperedge_weight(
    &mut self,
    hyperedge_index: HyperedgeIndex,
    weight: HE
) -> Result<(), HypergraphError<V, HE>>

Updates the weight of a hyperedge by index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn add_vertex(
    &mut self,
    weight: V
) -> Result<VertexIndex, HypergraphError<V, HE>>

Adds a vertex with a custom weight to the hypergraph. Returns the index of the vertex.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn count_vertices(&self) -> usize

Returns the number of vertices in the hypergraph.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_adjacent_vertices_from(
    &self,
    from: VertexIndex
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Gets the list of all vertices connected from a given vertex.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_adjacent_vertices_to(
    &self,
    to: VertexIndex
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Gets the list of all vertices connected to a given vertex.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_dijkstra_connections(
    &self,
    from: VertexIndex,
    to: VertexIndex
) -> Result<Vec<VertexIndex>, HypergraphError<V, HE>>

Gets a list of the shortest path of vertices between two vertices. The implementation of the algorithm is based on https://doc.rust-lang.org/std/collections/binary_heap/#examples

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_full_vertex_hyperedges(
    &self,
    vertex_index: VertexIndex
) -> Result<Vec<Vec<VertexIndex>>, HypergraphError<V, HE>>

Gets the hyperedges of a vertex as a vector of vectors of VertexIndex.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_vertex_degree_in(
    &self,
    to: VertexIndex
) -> Result<usize, HypergraphError<V, HE>>

Gets the in-degree of a vertex. https://en.wikipedia.org/wiki/Directed_graph#Indegree_and_outdegree

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_vertex_degree_out(
    &self,
    from: VertexIndex
) -> Result<usize, HypergraphError<V, HE>>

Gets the out-degree of a vertex. https://en.wikipedia.org/wiki/Directed_graph#Indegree_and_outdegree

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_vertex_hyperedges(
    &self,
    vertex_index: VertexIndex
) -> Result<Vec<HyperedgeIndex>, HypergraphError<V, HE>>

Gets the hyperedges of a vertex as a vector of HyperedgeIndex.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn get_vertex_weight(
    &self,
    vertex_index: VertexIndex
) -> Result<V, HypergraphError<V, HE>>

Gets the weight of a vertex from its index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn remove_vertex(
    &mut self,
    vertex_index: VertexIndex
) -> Result<(), HypergraphError<V, HE>>

Removes a vertex by index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

pub fn update_vertex_weight(
    &mut self,
    vertex_index: VertexIndex,
    weight: V
) -> Result<(), HypergraphError<V, HE>>

Updates the weight of a vertex by index.

impl<V, HE> Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

Hypergraph implementations.

pub fn clear(&mut self)

Clears the hypergraph.

pub fn new() -> Self

Creates a new hypergraph with no allocation.

pub fn with_capacity(vertices: usize, hyperedges: usize) -> Self

Creates a new hypergraph with the specified capacity.

Trait Implementations

impl<V: Eq + Hash + Debug, HE: Debug> Debug for Hypergraph<V, HE>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<V, HE> Default for Hypergraph<V, HE> where
    V: SharedTrait,
    HE: SharedTrait, 

fn default() -> Self

Returns the “default value” for a type.