Trait petgraph::visit::IntoNeighbors

pub trait IntoNeighbors: GraphRef {
    type Neighbors: Iterator<Item = Self::NodeId>;
    fn neighbors(self, a: Self::NodeId) -> Self::Neighbors;
}

Access to the neighbors of each node

The neighbors are, depending on the graph’s edge type:

• Directed: All targets of edges from a.
• Undirected: All other endpoints of edges connected to a.

Associated Types

type Neighbors: Iterator<Item = Self::NodeId>

Loading content...

Required methods

fn neighbors(self, a: Self::NodeId) -> Self::Neighbors

Return an iterator of the neighbors of node a.

Loading content...

Implementations on Foreign Types

impl<'a, G> IntoNeighbors for &'a G where
    G: IntoNeighbors, 

type Neighbors = G::Neighbors

fn neighbors(self, a: Self::NodeId) -> Self::Neighbors

Loading content...

Implementors

impl<'a, 'b, G> IntoNeighbors for &'b Frozen<'a, G> where
    G: IntoNeighbors, 

type Neighbors = G::Neighbors

fn neighbors(self, a: Self::NodeId) -> Self::Neighbors

impl<'a, G, F> IntoNeighbors for &'a EdgeFiltered<G, F> where
    G: IntoEdges,
    F: FilterEdge<G::EdgeRef>, 

type Neighbors = EdgeFilteredNeighbors<'a, G, F>

fn neighbors(self, n: G::NodeId) -> Self::Neighbors

impl<'a, G, F> IntoNeighbors for &'a NodeFiltered<G, F> where
    G: IntoNeighbors,
    F: FilterNode<G::NodeId>, 

type Neighbors = NodeFilteredNeighbors<'a, G::Neighbors, F>

fn neighbors(self, n: G::NodeId) -> Self::Neighbors

impl<'a, N, E, Ty, Ix> IntoNeighbors for &'a Csr<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, 

type Neighbors = Neighbors<'a, Ix>

fn neighbors(self, a: Self::NodeId) -> Self::Neighbors

Return an iterator of all neighbors of a.

• Directed: Targets of outgoing edges from a.
• Undirected: Opposing endpoints of all edges connected to a.

Panics if the node a does not exist.
Iterator element type is NodeIndex<Ix>.

impl<'a, N, E: 'a, Ty, Ix> IntoNeighbors for &'a Graph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, 

type Neighbors = Neighbors<'a, E, Ix>

Important traits for Neighbors<'a, E, Ix>

impl<'a, E, Ix> Iterator for Neighbors<'a, E, Ix> where
    Ix: IndexType,  type Item = NodeIndex<Ix>;

fn neighbors(self, n: NodeIndex<Ix>) -> Neighbors<'a, E, Ix>

impl<'a, N, E: 'a, Ty, Ix> IntoNeighbors for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, 

type Neighbors = Neighbors<'a, E, Ix>

fn neighbors(self, n: Self::NodeId) -> Self::Neighbors

impl<'a, N, E: 'a, Ty: EdgeType, Null: Nullable<Wrapped = E>, Ix: IndexType> IntoNeighbors for &'a MatrixGraph<N, E, Ty, Null, Ix>

type Neighbors = Neighbors<'a, Ty, Null, Ix>

fn neighbors(self, a: NodeIndex<Ix>) -> Self::Neighbors

impl<'a, N: 'a, E, Ty> IntoNeighbors for &'a GraphMap<N, E, Ty> where
    N: Copy + Ord + Hash,
    Ty: EdgeType, 

type Neighbors = Neighbors<'a, N, Ty>

fn neighbors(self, n: Self::NodeId) -> Self::Neighbors

impl<G> IntoNeighbors for Reversed<G> where
    G: IntoNeighborsDirected, 

type Neighbors = G::NeighborsDirected

fn neighbors(self, n: G::NodeId) -> G::NeighborsDirected

Loading content...