hypergraph 3.0.0

Hypergraph is data structure library to create a directed hypergraph in which an hyperedge can join any number of vertices.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use itertools::Itertools;
use rayon::prelude::*;

use crate::{
    HyperedgeIndex,
    HyperedgeTrait,
    Hypergraph,
    VertexIndex,
    VertexTrait,
    errors::HypergraphError,
};

/// Enumeration of the different types of connection.
/// Only used as a guard argument for the `get_connections` method.
pub(crate) enum Connection<Index = VertexIndex> {
    In(Index),
    Out(Index),
    InAndOut(Index, Index),
}

type Connections = Vec<(HyperedgeIndex, Option<VertexIndex>)>;

impl<V, HE> Hypergraph<V, HE>
where
    V: VertexTrait,
    HE: HyperedgeTrait,
{
    /// Private helper function used internally.
    /// Takes a connection as an enum and returns a vector of tuples of the
    /// form (hyperedge index, connected vertex index) where connected vertex
    /// index is an optional value - None for `InAndOut` connections.
    #[allow(clippy::type_complexity)]
    pub(crate) fn get_connections(
        &self,
        connections: &Connection,
    ) -> Result<Connections, HypergraphError<V, HE>> {
        let internal_index = self.get_internal_vertex(match connections {
            Connection::InAndOut(vertex_index, _)
            | Connection::In(vertex_index)
            | Connection::Out(vertex_index) => *vertex_index,
        })?;

        let (_, hyperedges_index_set) = self
            .vertices
            .get(internal_index)
            .ok_or(HypergraphError::InternalVertexIndexNotFound(internal_index))?;

        let hyperedges =
            self.get_hyperedges(&hyperedges_index_set.iter().copied().collect_vec())?;

        let hyperedges_with_vertices = hyperedges
            .into_par_iter()
            .map(|hyperedge_index| {
                self.get_hyperedge_vertices(hyperedge_index)
                    .map(|vertices| (hyperedge_index, vertices))
            })
            .collect::<Result<Vec<(HyperedgeIndex, Vec<VertexIndex>)>, HypergraphError<V, HE>>>()?;

        let capacity = hyperedges_with_vertices.len();

        let results = hyperedges_with_vertices
            .into_par_iter()
            .fold_with(
                Vec::with_capacity(capacity),
                |acc, (hyperedge_index, vertices)| {
                    vertices.iter().tuple_windows::<(_, _)>().fold(
                        acc,
                        |mut acc, (window_from, window_to)| {
                            match connections {
                                Connection::In(from) => {
                                    if *window_from == *from {
                                        acc.push((hyperedge_index, Some(*window_to)));
                                    }
                                }
                                Connection::Out(to) => {
                                    if *window_to == *to {
                                        acc.push((hyperedge_index, Some(*window_from)));
                                    }
                                }
                                Connection::InAndOut(from, to) => {
                                    if *window_from == *from && *window_to == *to {
                                        acc.push((hyperedge_index, None));
                                    }
                                }
                            }
                            acc
                        },
                    )
                },
            )
            .flatten()
            .collect::<Connections>();

        Ok(results)
    }
}