Struct GraphQuery

pub struct GraphQuery<'a, N, E>(/* private fields */);

A wrapper for ascertaining the structure of the underlying graph. This type is used in forward_traverse and reverse_traverse callbacks.

Implementations

impl<'a, N, E> GraphQuery<'a, N, E>

pub fn new(ir: &'a StableGraph<N, E>) -> Self

Creates a new GraphQuery from a reference to a StableGraph.

pub fn get_node(&self, x: NodeIndex) -> Option<&N>

Gets a node from its index.

pub fn neighbors_directed( &self, x: NodeIndex, direction: Direction, ) -> Neighbors<'_, E>

Gets information about the immediate parent or child nodes of the node at the given index.

Remarks

Direction::Outgoing gives children, while Direction::Incoming gives parents.

pub fn edges_directed( &self, x: NodeIndex, direction: Direction, ) -> Edges<'_, E, Directed>

Gets edges pointing at the parent or child nodes of the node at the given index.

Remarks

Direction::Outgoing gives children, while Direction::Incoming gives parents.

impl<'a, O> GraphQuery<'a, NodeInfo<O>, EdgeInfo>

where O: Operation,

pub fn get_binary_operands( &self, index: NodeIndex, ) -> Result<(NodeIndex, NodeIndex), GraphQueryError>

Returns the left and right node indices to a binary operation.

Errors

• No node exists at the given index.
• The node at the given index isn’t a binary operation.
• The node at the given index doesn’t have a 1 left and 1 right parent

pub fn get_unary_operand( &self, index: NodeIndex, ) -> Result<NodeIndex, GraphQueryError>

Returns the unary operand node index to a unary operation.

Errors

• No node exists at the given index.
• The node at the given index isn’t a unary operation.
• The node at the given index doesn’t have a single unary operand.

pub fn get_unordered_operands( &self, index: NodeIndex, ) -> Result<Vec<NodeIndex>, GraphQueryError>

Returns the unordered operands to the given operation.

Remarks

As these operands are unordered, their order is undefined. Use EdgeInfo::Ordered and call GraphQuery::get_ordered_operands if you need a defined order.

• Errors

• No node exists at the given index.
• The node at the given index isn’t a unary operation.
• The node at the given index doesn’t have a single unary operand.

pub fn get_ordered_operands( &self, index: NodeIndex, ) -> Result<Vec<NodeIndex>, GraphQueryError>

Returns the unordered operands to the given operation.

Remarks

The operands node indices are returned in order.

• Errors

• No node exists at the given index.
• The node at the given index isn’t a unary operation.
• The node at the given index doesn’t have a single unary operand.

Trait Implementations

impl<'a, N, E> From<&'a StableGraph<N, E>> for GraphQuery<'a, N, E>

fn from(x: &'a StableGraph<N, E>) -> Self

Converts to this type from the input type.