Trait graph::prelude::DirectedNeighbors

pub trait DirectedNeighbors<NI>where
    NI: Idx,{
    type NeighborsIterator<'a>: Iterator<Item = &'a NI>
       where Self: 'a;

    // Required methods
    fn out_neighbors(&self, node: NI) -> Self::NeighborsIterator<'_>;
    fn in_neighbors(&self, node: NI) -> Self::NeighborsIterator<'_>;
}

Returns the neighbors of a given node either in outgoing or incoming direction.

An edge tuple e = (u, v) has a source node u and a target node v. From the perspective of u, the edge e is an outgoing edge. From the perspective of node v, the edge e is an incoming edge. The edges (u, v) and (v, u) are not considered equivalent.

Required Associated Types

type NeighborsIterator<'a>: Iterator<Item = &'a NI> where Self: 'a

Required Methods

fn out_neighbors(&self, node: NI) -> Self::NeighborsIterator<'_>

Returns an iterator of all nodes which are connected in outgoing direction to the given node, i.e., the given node is the source node of the connecting edge.

fn in_neighbors(&self, node: NI) -> Self::NeighborsIterator<'_>

Returns an iterator of all nodes which are connected in incoming direction to the given node, i.e., the given node is the target node of the connecting edge.

Object Safety

This trait is not object safe.

Implementors

impl<NI, NV> DirectedNeighbors<NI> for DirectedALGraph<NI, NV>where NI: Idx,

type NeighborsIterator<'a> = TargetsIter<'a, NI> where NV: 'a

impl<NI, NV> DirectedNeighbors<NI> for DirectedCsrGraph<NI, NV>where NI: Idx,

type NeighborsIterator<'a> = Iter<'a, NI> where NV: 'a