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

//! Submodule defining the trait for Options for building a edges.

use crate::traits::{Edges, GrowableEdges, SparseMatrixMut};

/// Trait for Options for building edges.
pub trait EdgesBuilder {
    /// The type of the edges being built.
    type Edges: Edges;
    /// The intermediate type of the edges, if any.
    type IntermediateEdges: GrowableEdges;
    /// The iterator of edges.
    type EdgeIterator: IntoIterator<Item = <Self::Edges as Edges>::Edge>;

    #[must_use]
    /// Set whether to ignore duplicated edges.
    fn ignore_duplicates(self) -> Self;

    /// Returns whether to ignore duplicated edges.
    fn should_ignore_duplicates(&self) -> bool;

    #[must_use]
    /// Set the expected number of edges.
    ///
    /// # Arguments
    ///
    /// * `number_of_edges` - The expected number of edges.
    fn expected_number_of_edges(self, number_of_edges: <Self::Edges as Edges>::EdgeId) -> Self;

    /// Returns the expected number of edges.
    fn get_expected_number_of_edges(&self) -> Option<<Self::Edges as Edges>::EdgeId>;

    #[must_use]
    /// Set the expected shape of the graph.
    ///
    /// # Arguments
    ///
    /// * `shape` - The expected shape of the graph.
    fn expected_shape(
        self,
        shape: <<Self::IntermediateEdges as GrowableEdges>::GrowableMatrix as SparseMatrixMut>::MinimalShape,
    ) -> Self;

    /// Returns the expected shape of the graph.
    fn get_expected_shape(&self) -> Option<<<Self::IntermediateEdges as GrowableEdges>::GrowableMatrix as SparseMatrixMut>::MinimalShape>;

    #[must_use]
    /// Set the iterator of edges.
    ///
    /// # Arguments
    ///
    /// * `edges` - The iterator of edges.
    fn edges(self, edges: Self::EdgeIterator) -> Self;
}