Trait handlegraph::handlegraph::IntoNeighbors

pub trait IntoNeighbors: Sized {
    type Neighbors: Iterator<Item = Handle>;
    fn neighbors(self, handle: Handle, dir: Direction) -> Self::Neighbors;

    fn degree(self, handle: Handle, dir: Direction) -> usize { ... }
    fn has_edge(self, left: Handle, right: Handle) -> bool { ... }
}

Access to the neighbors of handles in the graph, and querying the graph for a node's degree.

Implementors should make sure that handles are flipped correctly depending on direction, e.g. using NeighborIter

Associated Types

type Neighbors: Iterator<Item = Handle>

Loading content...

Required methods

fn neighbors(self, handle: Handle, dir: Direction) -> Self::Neighbors

Return an iterator of the Handles adjacent to the given handle, in the provided Direction. Implementations should take the orientation of handle into account.

Loading content...

Provided methods

fn degree(self, handle: Handle, dir: Direction) -> usize

Return the number of neighbors of handle in the given direction. The default implementation uses count on Self::neighbors.

fn has_edge(self, left: Handle, right: Handle) -> bool

Returns true if the left handle has a connection on its right-hand side to the right handle. The default implementation uses any on Self::neighbors.

Loading content...

Implementors

impl<'a> IntoNeighbors for &'a HashGraph

type Neighbors = NeighborIter<'a, Iter<'a, Handle>>

fn neighbors(self, handle: Handle, dir: Direction) -> Self::Neighbors

fn degree(self, handle: Handle, dir: Direction) -> usize

impl<'a> IntoNeighbors for &'a PackedGraph

type Neighbors = EdgeListHandleIter<'a>

fn neighbors(self, handle: Handle, dir: Direction) -> Self::Neighbors

Loading content...