Trait VisitableGraph 

pub trait VisitableGraph {
    type GData;
    type NData: Clone;
    type EData: Clone;

    // Required methods
    fn data(&self) -> &Self::GData;
    fn node_data(
        &self,
        id: impl AsRef<NodeID>,
    ) -> Result<Cow<'static, Self::NData>>;
    fn edge_data(
        &self,
        id: impl AsRef<EdgeID>,
    ) -> Result<Cow<'static, Self::EData>>;
    fn is_empty(&self) -> bool;
    fn node_count(&self) -> usize;
    fn edge_count(&self) -> usize;
    fn all_nodes(&self) -> Nodes;
    fn all_edges(&self) -> Edges;
    fn has_node(&self, id: impl AsRef<NodeID>) -> bool;
    fn has_edge(&self, id: impl AsRef<EdgeID>) -> bool;
    fn has_edge_from_to(
        &self,
        source: impl AsRef<NodeID>,
        target: impl AsRef<NodeID>,
    ) -> bool;
    fn has_edge_between(
        &self,
        a: impl AsRef<NodeID>,
        b: impl AsRef<NodeID>,
    ) -> bool;
    fn source(&self, id: impl AsRef<EdgeID>) -> Result<NodeID>;
    fn target(&self, id: impl AsRef<EdgeID>) -> Result<NodeID>;
    fn endpoints(&self, id: impl AsRef<EdgeID>) -> Result<(NodeID, NodeID)>;
    fn out_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>;
    fn in_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>;
    fn incident_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>;
    fn out_degree(&self, id: impl AsRef<NodeID>) -> Result<usize>;
    fn in_degree(&self, id: impl AsRef<NodeID>) -> Result<usize>;
    fn degree(&self, id: impl AsRef<NodeID>) -> Result<usize>;
    fn successors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>;
    fn predecessors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>;
    fn neighbors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>;
    fn has_successors(&self, id: impl AsRef<NodeID>) -> Result<bool>;
    fn has_predecessors(&self, id: impl AsRef<NodeID>) -> Result<bool>;
    fn has_neighbors(&self, id: impl AsRef<NodeID>) -> Result<bool>;
    fn all_roots(&self) -> Nodes;
    fn all_leaves(&self) -> Nodes;
    fn non_roots(&self) -> Nodes;
    fn non_leaves(&self) -> Nodes;
    fn all_internals(&self) -> Nodes;
    fn is_leaf(&self, id: impl AsRef<NodeID>) -> Result<bool>;
    fn is_root(&self, id: impl AsRef<NodeID>) -> Result<bool>;
    fn is_internal(&self, id: impl AsRef<NodeID>) -> Result<bool>;

    // Provided methods
    fn elements(&self) -> Elements { ... }
    fn edges_from_to(
        &self,
        source: impl AsRef<NodeID>,
        target: impl AsRef<NodeID>,
    ) -> Result<Edges> { ... }
    fn edges_between(
        &self,
        a: impl AsRef<NodeID>,
        b: impl AsRef<NodeID>,
    ) -> Result<Edges> { ... }
    fn edges_from_to_nodes(
        &self,
        sources: &Nodes,
        targets: &Nodes,
    ) -> Result<Edges> { ... }
    fn edges_between_nodes(&self, a: &Nodes, b: &Nodes) -> Result<Edges> { ... }
    fn nodes_successors(&self, ids: &Nodes) -> Result<Nodes> { ... }
    fn nodes_predecessors(&self, ids: &Nodes) -> Result<Nodes> { ... }
    fn transitive_successors(&self, ids: &Nodes) -> Result<Nodes> { ... }
    fn transitive_predecessors(&self, ids: &Nodes) -> Result<Nodes> { ... }
}

Required Associated Types

type GData

type NData: Clone

type EData: Clone

Required Methods

fn data(&self) -> &Self::GData

Returns a reference to the graph’s data.

fn node_data(&self, id: impl AsRef<NodeID>) -> Result<Cow<'static, Self::NData>>

Returns a reference to the node’s data.

fn edge_data(&self, id: impl AsRef<EdgeID>) -> Result<Cow<'static, Self::EData>>

Returns a reference to the edge’s data.

fn is_empty(&self) -> bool

Returns true if the graph is empty.

fn node_count(&self) -> usize

Returns the number of nodes in the graph.

fn edge_count(&self) -> usize

Returns the number of edges in the graph.

fn all_nodes(&self) -> Nodes

Returns a set of all nodes in the graph.

fn all_edges(&self) -> Edges

Returns a set of all edges in the graph.

fn has_node(&self, id: impl AsRef<NodeID>) -> bool

Returns true if the graph contains the given node.

fn has_edge(&self, id: impl AsRef<EdgeID>) -> bool

Returns true if the graph contains the given edge.

fn has_edge_from_to( &self, source: impl AsRef<NodeID>, target: impl AsRef<NodeID>, ) -> bool

Returns true if the graph contains an edge from source to target.

fn has_edge_between(&self, a: impl AsRef<NodeID>, b: impl AsRef<NodeID>) -> bool

Returns true if the graph contains an edge between a and b, regardless of direction.

fn source(&self, id: impl AsRef<EdgeID>) -> Result<NodeID>

Returns the source node of the edge.

fn target(&self, id: impl AsRef<EdgeID>) -> Result<NodeID>

Returns the target node of the edge.

fn endpoints(&self, id: impl AsRef<EdgeID>) -> Result<(NodeID, NodeID)>

Returns the endpoints of the edge.

fn out_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>

Returns the out-edges of the node.

fn in_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>

Returns the in-edges of the node.

fn incident_edges(&self, id: impl AsRef<NodeID>) -> Result<Edges>

Returns the incident edges of the node.

fn out_degree(&self, id: impl AsRef<NodeID>) -> Result<usize>

Returns the number of out-edges of the node.

fn in_degree(&self, id: impl AsRef<NodeID>) -> Result<usize>

Returns the number of in-edges of the node.

fn degree(&self, id: impl AsRef<NodeID>) -> Result<usize>

Returns the number of incident edges of the node.

fn successors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>

Returns the immediate successors of the node.

fn predecessors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>

Returns the immediate predecessors of the node.

fn neighbors(&self, id: impl AsRef<NodeID>) -> Result<Nodes>

Returns the immediate neighbors of the node.

fn has_successors(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node has successors.

fn has_predecessors(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node has predecessors.

fn has_neighbors(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node has neighbors.

fn all_roots(&self) -> Nodes

The set of all “roots” (nodes with no predecessors) in the graph.

fn all_leaves(&self) -> Nodes

The set of all “leaves” (nodes with no successors) in the graph.

fn non_roots(&self) -> Nodes

The set of all nodes that are not roots (i.e., nodes with at least one predecessor).

fn non_leaves(&self) -> Nodes

The set of all nodes that are not leaves (i.e., nodes with at least one successor).

fn all_internals(&self) -> Nodes

The set of all nodes that are neither roots nor leaves (i.e., nodes with at least one predecessor and at least one successor).

fn is_leaf(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node is a leaf (i.e., has no successors).

fn is_root(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node is a root (i.e., has no predecessors).

fn is_internal(&self, id: impl AsRef<NodeID>) -> Result<bool>

Returns true if the node is neither a root nor a leaf (i.e., has at least one predecessor and at least one successor).

Provided Methods

fn elements(&self) -> Elements

Returns the set of all elements in the graph.

fn edges_from_to( &self, source: impl AsRef<NodeID>, target: impl AsRef<NodeID>, ) -> Result<Edges>

Returns the edges that have the given source and target nodes.

Only returns more than one edge in the case of codirected edges.

fn edges_between( &self, a: impl AsRef<NodeID>, b: impl AsRef<NodeID>, ) -> Result<Edges>

Returns the edges that have the given nodes as endpoints.

Only returns more than one edge in the case of parallel edges.

fn edges_from_to_nodes(&self, sources: &Nodes, targets: &Nodes) -> Result<Edges>

Returns the edges connecting the given source nodes to the given target nodes.

fn edges_between_nodes(&self, a: &Nodes, b: &Nodes) -> Result<Edges>

Returns the edges connecting the given sets of nodes.

fn nodes_successors(&self, ids: &Nodes) -> Result<Nodes>

Returns the immediate successors of all the given nodes.

fn nodes_predecessors(&self, ids: &Nodes) -> Result<Nodes>

Returns the immediate predecessors of all the given nodes.

fn transitive_successors(&self, ids: &Nodes) -> Result<Nodes>

Returns the transitive successors of all the given nodes (i.e., all the nodes reachable from the out-edges of the given nodes).

The given nodes will not be included unless they are also reachable from the out-edges of other nodes.

fn transitive_predecessors(&self, ids: &Nodes) -> Result<Nodes>

Returns the transitive predecessors of all the given nodes (i.e., all the nodes reachable from the in-edges of the given nodes).

The given nodes will not be included unless they are also reachable from the in-edges of other nodes.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<GData, NData, EData> VisitableGraph for Graph<GData, NData, EData>

where GData: Clone + 'static, NData: Clone + 'static, EData: Clone + 'static,

type GData = GData

type NData = NData

type EData = EData

impl<Inner> VisitableGraph for DAG<Inner>

where Inner: MutableGraph,

type GData = <Inner as VisitableGraph>::GData

type NData = <Inner as VisitableGraph>::NData

type EData = <Inner as VisitableGraph>::EData

impl<Inner> VisitableGraph for Forest<Inner>

where Inner: VisitableGraph + MutableTree<GData = (), NData = (), EData = ()>,

type GData = <Inner as VisitableGraph>::GData

type NData = <Inner as VisitableGraph>::NData

type EData = <Inner as VisitableGraph>::EData

impl<Inner> VisitableGraph for ReversedGraph<Inner>

where Inner: VisitableGraph,

type GData = <Inner as VisitableGraph>::GData

type NData = <Inner as VisitableGraph>::NData

type EData = <Inner as VisitableGraph>::EData

impl<Inner> VisitableGraph for Tree<Inner>

where Inner: MutableGraph,

type GData = <Inner as VisitableGraph>::GData

type NData = <Inner as VisitableGraph>::NData

type EData = <Inner as VisitableGraph>::EData

impl<InnerGraph, InnerForest> VisitableGraph for CompoundBase<InnerGraph, InnerForest>

where InnerGraph: MutableGraph, InnerForest: MutableForest<GData = (), NData = (), EData = ()>,

type GData = <InnerGraph as VisitableGraph>::GData

type NData = <InnerGraph as VisitableGraph>::NData

type EData = <InnerGraph as VisitableGraph>::EData