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

//! Public canonization API plus lower-level building blocks for
//! individualization-refinement over dense vertex identifiers.

use num_traits::AsPrimitive;

use crate::traits::MonoplexMonopartiteGraph;

mod partition;
mod refine;
mod search;

pub use partition::{
    BacktrackableOrderedPartition, OrderedPartitionCells, PartitionBacktrackPoint, PartitionCellId,
    PartitionCellView,
};
pub(crate) use refine::RefinementTrace;
pub use refine::refine_partition_to_labeled_equitable;
pub use search::{
    CanonSplittingHeuristic, CanonicalLabelingOptions, CanonicalLabelingResult,
    CanonicalSearchStats, LabeledSimpleGraphCertificate,
};

/// Trait exposing canonical labeling for simple undirected graphs with
/// total-order vertex and edge labels.
///
/// This is the public canonization API for the current module. The underlying
/// search entry points stay internal so the public surface remains trait-based,
/// like the rest of the crate's algorithm layer.
pub trait CanonicalLabeling: MonoplexMonopartiteGraph {
    /// Computes a canonical labeling using the default canonizer options.
    #[inline]
    fn canonical_labeling<VertexLabel, EdgeLabel, VF, EF>(
        &self,
        vertex_label: VF,
        edge_label: EF,
    ) -> CanonicalLabelingResult<VertexLabel, EdgeLabel>
    where
        Self: Sized,
        Self::NodeId: AsPrimitive<usize>,
        VertexLabel: Ord + Clone,
        EdgeLabel: Ord + Clone,
        VF: FnMut(Self::NodeId) -> VertexLabel,
        EF: FnMut(Self::NodeId, Self::NodeId) -> EdgeLabel,
    {
        search::canonical_label_labeled_simple_graph(self, vertex_label, edge_label)
    }

    /// Computes a canonical labeling using explicit canonizer options.
    #[inline]
    fn canonical_labeling_with_options<VertexLabel, EdgeLabel, VF, EF>(
        &self,
        vertex_label: VF,
        edge_label: EF,
        options: CanonicalLabelingOptions,
    ) -> CanonicalLabelingResult<VertexLabel, EdgeLabel>
    where
        Self: Sized,
        Self::NodeId: AsPrimitive<usize>,
        VertexLabel: Ord + Clone,
        EdgeLabel: Ord + Clone,
        VF: FnMut(Self::NodeId) -> VertexLabel,
        EF: FnMut(Self::NodeId, Self::NodeId) -> EdgeLabel,
    {
        search::canonical_label_labeled_simple_graph_with_options(
            self,
            vertex_label,
            edge_label,
            options,
        )
    }
}

impl<G: ?Sized + MonoplexMonopartiteGraph> CanonicalLabeling for G {}