Struct sunscreen_fhe_program::GraphQuery

pub struct GraphQuery<'a>(_);

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

Implementations

impl<'a> GraphQuery<'a>

pub fn new(ir: &'a FheProgram) -> Self

Creates a new GraphQuery from a reference to an FheProgram.

pub fn get_node(&self, x: NodeIndex) -> &NodeInfo

Returns the NodeInfo for the graph node with the given index x.

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

Returns the children or parents of the node with index x. If direction is [Direction::Outgoing], this will return the children. If the direction is [Direction::Incoming`], this will return the parents.

Typically, you want children writing forward traversal compiler passes and parents when writing reverse traversal compiler passes.

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

Returns incoming our outgoing edges for the node with index x.`

Typically, you want outgoing writing forward traversal compiler passes and incoming when writing reverse traversal compiler passes.