Add documentation for Graph and AppendGraph EntityMap types
This commit is contained in:
@@ -7,7 +7,10 @@ pub struct Vertex(usize);
|
|||||||
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
||||||
pub struct Edge(usize);
|
pub struct Edge(usize);
|
||||||
|
|
||||||
|
/// An [`EntityMap`] for [`AppendGraph`] vertices.
|
||||||
pub type AppendGraphVertexMap<T> = EntityMap<Vertex, T>;
|
pub type AppendGraphVertexMap<T> = EntityMap<Vertex, T>;
|
||||||
|
|
||||||
|
/// An [`EntityMap`] for [`AppendGraph`] edges.
|
||||||
pub type AppendGraphEdgeMap<T> = EntityMap<Edge, T>;
|
pub type AppendGraphEdgeMap<T> = EntityMap<Edge, T>;
|
||||||
|
|
||||||
impl Edge {
|
impl Edge {
|
||||||
|
|||||||
@@ -6,7 +6,10 @@ use crate::traits::{GraphTopology, GraphTopologyDeletion, IncidenceCursor};
|
|||||||
pub type Vertex = Index<VertexIncidenceHeader, usize, usize>;
|
pub type Vertex = Index<VertexIncidenceHeader, usize, usize>;
|
||||||
pub type Edge = Index<IncidenceEntry, usize, usize>;
|
pub type Edge = Index<IncidenceEntry, usize, usize>;
|
||||||
|
|
||||||
|
/// An [`EntityMap`] for [`Graph`] vertices.
|
||||||
pub type GraphVertexMap<T> = EntityMap<Vertex, T>;
|
pub type GraphVertexMap<T> = EntityMap<Vertex, T>;
|
||||||
|
|
||||||
|
/// An [`EntityMap`] for [`Graph`] edges.
|
||||||
pub type GraphEdgeMap<T> = EntityMap<Edge, T>;
|
pub type GraphEdgeMap<T> = EntityMap<Edge, T>;
|
||||||
|
|
||||||
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
||||||
|
|||||||
Reference in New Issue
Block a user