geometric-traits 0.2.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! A generic edges builder that can be used to build a edges for any type of
//! graph.

use core::marker::PhantomData;

use super::GenericEdgesBuilder;
use crate::{
    errors::builder::edges::EdgesBuilderError,
    traits::{
        DirectedEdges, Edges, EdgesBuilder, FromDirectedMonopartiteEdges, GrowableEdges,
        MonopartiteEdges, SparseMatrixMut, Symmetrize, UndirectedMonopartiteEdges,
    },
};

#[cfg_attr(feature = "mem_size", derive(mem_dbg::MemSize))]
#[cfg_attr(feature = "mem_size", mem_size(rec))]
#[cfg_attr(feature = "mem_dbg", derive(mem_dbg::MemDbg))]
/// A generic edges builder that can be used to build a edges for any type of
/// graph.
pub struct GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE: GrowableEdges, UE> {
    /// The inner builder for the edges.
    builder: GenericEdgesBuilder<EdgeIterator, GE>,
    /// The actual undirected graph that will be built.
    _undirected_edges: core::marker::PhantomData<UE>,
}

impl<EdgeIterator, GE, UE> Clone for GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE, UE>
where
    GE: GrowableEdges,
    GenericEdgesBuilder<EdgeIterator, GE>: Clone,
{
    #[inline]
    fn clone(&self) -> Self {
        Self { builder: self.builder.clone(), _undirected_edges: self._undirected_edges }
    }
}

impl<EdgeIterator, GE, UE> core::fmt::Debug
    for GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE, UE>
where
    GE: GrowableEdges,
    GenericEdgesBuilder<EdgeIterator, GE>: core::fmt::Debug,
{
    #[inline]
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("GenericUndirectedMonopartiteEdgesBuilder")
            .field("builder", &self.builder)
            .finish()
    }
}

impl<EdgeIterator, GE: GrowableEdges, UE> Default
    for GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE, UE>
{
    #[inline]
    fn default() -> Self {
        Self { builder: GenericEdgesBuilder::default(), _undirected_edges: PhantomData }
    }
}

impl<EdgeIterator, GE, UE> EdgesBuilder
    for GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE, UE>
where
    UE: UndirectedMonopartiteEdges<Edge = GE::Edge, EdgeId = GE::EdgeId>
        + FromDirectedMonopartiteEdges<GE>,
    GE: GrowableEdges<Error = EdgesBuilderError<GE>>
        + MonopartiteEdges<MonopartiteMatrix = GE::GrowableMatrix>
        + DirectedEdges<Matrix = GE::GrowableMatrix>,
    EdgeIterator: IntoIterator<Item = GE::Edge>,
    EdgesBuilderError<UE>: From<EdgesBuilderError<GE>>,
    <GE as GrowableEdges>::GrowableMatrix:
        Symmetrize<<UE as UndirectedMonopartiteEdges>::SymmetricSquaredMatrix>,
{
    type EdgeIterator = EdgeIterator;
    type IntermediateEdges = GE;
    type Edges = UE;

    #[inline]
    fn expected_number_of_edges(mut self, number_of_edges: GE::EdgeId) -> Self {
        self.builder = self.builder.expected_number_of_edges(number_of_edges);
        self
    }

    #[inline]
    fn get_expected_number_of_edges(&self) -> Option<GE::EdgeId> {
        self.builder.get_expected_number_of_edges()
    }

    #[inline]
    fn ignore_duplicates(mut self) -> Self {
        self.builder = self.builder.ignore_duplicates();
        self
    }

    #[inline]
    fn should_ignore_duplicates(&self) -> bool {
        self.builder.should_ignore_duplicates()
    }

    #[inline]
    fn expected_shape(
        mut self,
        shape: <<Self::IntermediateEdges as GrowableEdges>::GrowableMatrix as SparseMatrixMut>::MinimalShape,
    ) -> Self {
        self.builder = self.builder.expected_shape(shape);
        self
    }

    #[inline]
    fn get_expected_shape(&self) -> Option<<<Self::IntermediateEdges as GrowableEdges>::GrowableMatrix as SparseMatrixMut>::MinimalShape>{
        self.builder.get_expected_shape()
    }

    #[inline]
    fn edges(mut self, edges: Self::EdgeIterator) -> Self {
        self.builder = self.builder.edges(edges);
        self
    }
}

impl<EdgeIterator, GE, UE> GenericUndirectedMonopartiteEdgesBuilder<EdgeIterator, GE, UE>
where
    UE: UndirectedMonopartiteEdges<Edge = GE::Edge, EdgeId = GE::EdgeId>
        + FromDirectedMonopartiteEdges<GE>,
    GE: GrowableEdges<Error = EdgesBuilderError<GE>>
        + MonopartiteEdges<MonopartiteMatrix = GE::GrowableMatrix>
        + DirectedEdges<Matrix = GE::GrowableMatrix>,
    Self: EdgesBuilder<EdgeIterator = EdgeIterator, Edges = UE, IntermediateEdges = GE>,
    EdgeIterator: IntoIterator<Item = <<Self as EdgesBuilder>::Edges as Edges>::Edge>,
    EdgesBuilderError<UE>: From<EdgesBuilderError<GE>>,
    <GE as GrowableEdges>::GrowableMatrix:
        Symmetrize<<UE as UndirectedMonopartiteEdges>::SymmetricSquaredMatrix>,
{
    /// Builds the undirected edges.
    ///
    /// # Errors
    ///
    /// Returns [`EdgesBuilderError`] if the edges cannot be built.
    #[inline]
    pub fn build(self) -> Result<UE, EdgesBuilderError<UE>> {
        let directed_edges: GE = self.builder.build()?;
        let undirected_edges: UE = UE::from_directed_edges(directed_edges);
        Ok(undirected_edges)
    }
}