mapgraph 0.12.0

A directed graph that can also be used as an arbitrary map.
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

//! Contains type aliases of the [`Graph`] type that use specific node and edge maps and the maps themselves.

use crate::{graph::Node, FrozenGraph, Graph};
#[cfg(feature = "alloc")]
use alloc::collections::BTreeMap;
#[cfg(feature = "std")]
use std::{collections::HashMap, hash::RandomState};
#[cfg(feature = "slotmap")]
use {
    crate::{
        graph::Edge,
        map::slotmap::{EdgeIndex, NodeIndex},
    },
    slotmap::{DenseSlotMap, HopSlotMap, SecondaryMap, SlotMap, SparseSecondaryMap},
};

/// A type alias for a [`SlotMap`] that maps a certain key type (the default is [`NodeIndex`]) to
/// [`Node`] structures.
///
/// This is intended to be used as a node map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type SlotNodeMap<N, NI = NodeIndex, EI = EdgeIndex> = SlotMap<NI, Node<N, EI>>;

/// A type alias for a [`SlotMap`] that maps a certain key type (the default is [`EdgeIndex`]) to
/// [`Edge`] structures.
///
/// This is intended to be used as an edge map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type SlotEdgeMap<E, NI = NodeIndex, EI = EdgeIndex> = SlotMap<EI, Edge<E, NI, EI>>;

/// A type alias for a [`HopSlotMap`] that maps a certain key type (the default is [`NodeIndex`]) to
/// [`Node`] structures.
///
/// This is intended to be used as a node map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type HopSlotNodeMap<N, NI = NodeIndex, EI = EdgeIndex> = HopSlotMap<NI, Node<N, EI>>;

/// A type alias for a [`HopSlotMap`] that maps a certain key type (the default is [`EdgeIndex`]) to
/// [`Edge`] structures.
///
/// This is intended to be used as an edge map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type HopSlotEdgeMap<E, NI = NodeIndex, EI = EdgeIndex> = HopSlotMap<EI, Edge<E, NI, EI>>;

/// A type alias for a [`DenseSlotMap`] that maps a certain key type (the default is [`NodeIndex`]) to
/// [`Node`] structures.
///
/// This is intended to be used as a node map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type DenseSlotNodeMap<N, NI = NodeIndex, EI = EdgeIndex> = DenseSlotMap<NI, Node<N, EI>>;

/// A type alias for a [`DenseSlotMap`] that maps a certain key type (the default is [`EdgeIndex`]) to
/// [`Edge`] structures.
///
/// This is intended to be used as an edge map type by the [`Graph`] type.
#[cfg(feature = "slotmap")]
pub type DenseSlotEdgeMap<E, NI = NodeIndex, EI = EdgeIndex> = DenseSlotMap<EI, Edge<E, NI, EI>>;

/// A reexport of [`SecondaryMap`] from the [`slotmap`] crate.
#[cfg(feature = "slotmap")]
pub type SecondarySlotMap<K, V> = SecondaryMap<K, V>;

/// A reexport of [`SparseSecondaryMap`] from the [`slotmap`] crate.
#[cfg(all(feature = "slotmap", feature = "std"))]
pub type SparseSecondarySlotMap<K, V> = SparseSecondaryMap<K, V>;

/// A type alias for a [`SecondaryMap`] with the unit type as the value type.
///
/// This is intended to be used by algorithms on graphs that use [`SlotMap`]s (or equivalents) to
/// back either their node or edge maps.
#[cfg(feature = "slotmap")]
pub type SecondarySlotKeySet<K> = SecondaryMap<K, ()>;

/// A type alias for a [`SparseSecondaryMap`] with the unit type as the value type.
///
/// This is intended to be used by algorithms on graphs that use [`SlotMap`]s (or equivalents) to
/// back either their node or edge maps.
///
/// For differences between a [`SecondaryMap`] and a [`SparseSecondaryMap`] see docs for these
/// types.
#[cfg(all(feature = "slotmap", feature = "std"))]
pub type SparseSecondarySlotKeySet<K> = SparseSecondaryMap<K, ()>;

/// A type alias for a [`BTreeMap`] that maps a certain key type to [`Node`] structures.
///
/// This is intended to be used as a node map type by the [`Graph`] type.
#[cfg(feature = "alloc")]
pub type BTreeNodeMap<N, NI, EI> = BTreeMap<NI, Node<N, EI>>;

/// A type alias for a [`Graph`] that uses a [`BTreeMap`] to store its
/// nodes.
#[cfg(feature = "alloc")]
pub type BTreeNodeGraph<N, E, NI, EI, EM> = Graph<N, E, NI, EI, BTreeNodeMap<N, NI, EI>, EM>;

/// A type alias for a [`FrozenGraph`] that uses a [`BTreeMap`] to
/// store its nodes.
#[cfg(feature = "alloc")]
pub type FrozenBTreeNodeGraph<N, E, NI, EI, EM> =
    FrozenGraph<N, E, NI, EI, BTreeNodeMap<N, NI, EI>, EM>;

/// A type alias for a [`Graph`] that uses a [`BTreeMap`] to store its
/// nodes and a [`SlotMap`] to store its edges.
///
/// The default edge index type is [`EdgeIndex`].
#[cfg(all(feature = "alloc", feature = "slotmap"))]
pub type BTreeSlotMapGraph<N, E, NI, EI = EdgeIndex> =
    BTreeNodeGraph<N, E, NI, EI, SlotEdgeMap<E, NI, EI>>;

/// A type alias for a [`FrozenGraph`] that uses a [`BTreeMap`] to
/// store its nodes and a [`SlotMap`] to store its edges.
///
/// The default edge index type is [`EdgeIndex`].
#[cfg(all(feature = "alloc", feature = "slotmap"))]
pub type FrozenBTreeSlotMapGraph<N, E, NI, EI = EdgeIndex> =
    FrozenBTreeNodeGraph<N, E, NI, EI, SlotEdgeMap<E, NI, EI>>;

/// A type alias for a [`HashMap`] that maps a certain key type to [`Node`] structures.
///
/// This is intended to be used as a node map type by the [`Graph`] type.
///
/// # Custom hashers
///
/// [`HashNodeMap`] supports passing a custom hasher type to [`HashMap`] via its last generic
/// parameter `S`, the default is [`RandomState`] which is also the default type used by the Rust
/// standard library.
#[cfg(feature = "std")]
pub type HashNodeMap<N, NI, EI, S = RandomState> = HashMap<NI, Node<N, EI>, S>;

/// A type alias for a [`Graph`] that uses a [`HashMap`] to store its
/// nodes.
///
/// # Custom hashers
///
/// [`HashNodeGraph`] supports passing a custom hasher type to [`HashMap`] via its last generic
/// parameter `S`, the default is [`RandomState`] which is also the default type used by the Rust
/// standard library.
#[cfg(feature = "std")]
pub type HashNodeGraph<N, E, NI, EI, EM, S = RandomState> =
    Graph<N, E, NI, EI, HashNodeMap<N, NI, EI, S>, EM>;

#[cfg(feature = "std")]
/// A type alias for a [`FrozenGraph`] that uses a [`HashMap`] to store
/// its nodes.
///
/// # Custom hashers
///
/// [`FrozenHashNodeGraph`] supports passing a custom hasher type to [`HashMap`] via its last
/// generic parameter `S`, the default is [`RandomState`] which is also the default type used by the
/// Rust standard library.
pub type FrozenHashNodeGraph<N, E, NI, EI, EM, S = RandomState> =
    FrozenGraph<N, E, NI, EI, HashNodeMap<N, NI, EI, S>, EM>;

/// A type alias for a [`Graph`] that uses a [`HashMap`] to store its
/// nodes and a [`SlotMap`] to store its edges.
///
/// The default edge index type is [`EdgeIndex`].
///
/// # Custom hashers
///
/// [`HashSlotMapGraph`] supports passing a custom hasher type to [`HashMap`] via its last generic
/// parameter `S`, the default is [`RandomState`] which is also the default type used by the Rust
/// standard library.
#[cfg(all(feature = "std", feature = "slotmap"))]
pub type HashSlotMapGraph<N, E, NI, EI = EdgeIndex, S = RandomState> =
    HashNodeGraph<N, E, NI, EI, SlotEdgeMap<E, NI, EI>, S>;

/// A type alias for a [`FrozenGraph`] that uses a [`HashMap`] to store
/// its nodes and a [`SlotMap`] to store its edges.
///
/// The default edge index type is [`EdgeIndex`].
///
/// # Custom hashers
///
/// [`FrozenHashSlotMapGraph`] supports passing a custom hasher type to [`HashMap`] via its last
/// generic parameter `S`, the default is [`RandomState`] which is also the default type used by the
/// Rust standard library.
#[cfg(all(feature = "std", feature = "slotmap"))]
pub type FrozenHashSlotMapGraph<N, E, NI, EI = EdgeIndex, S = RandomState> =
    FrozenHashNodeGraph<N, E, NI, EI, SlotEdgeMap<E, NI, EI>, S>;

/// A type alias for a [`Graph`] that uses [`SlotMap`]s to store nodes and edges.
///
/// The default node and edge index types are [`NodeIndex`] and [`EdgeIndex`].
#[cfg(feature = "slotmap")]
pub type SlotMapGraph<N, E, NI = NodeIndex, EI = EdgeIndex> =
    Graph<N, E, NI, EI, SlotNodeMap<N, NI, EI>, SlotEdgeMap<E, NI, EI>>;

/// A type alias for a [`FrozenGraph`] that uses [`SlotMap`]s to store nodes and edges.
///
/// The default node and edge index types are [`NodeIndex`] and [`EdgeIndex`].
#[cfg(feature = "slotmap")]
pub type FrozenSlotMapGraph<N, E, NI = NodeIndex, EI = EdgeIndex> =
    FrozenGraph<N, E, NI, EI, SlotNodeMap<N, NI, EI>, SlotEdgeMap<E, NI, EI>>;