Struct calyx_opt::analysis::GraphAnalysis

pub struct GraphAnalysis { /* private fields */ }

Constructs a graph based representation of a component. Each node represents a ir::Port and each directed edge (X -> Y) means that X’s value written to Y.

Example

c.in = G[done] & b.done ? add.out

creates the edges:

add.out -> c.in
G[done] -> c.in
b.done -> c.in

This representation is useful for asking graph based queries such as all the reads from a port or all the write to a port.

Implementations

impl GraphAnalysis

pub fn reads_from(&self, port: &Port) -> PortIterator<'_>

Returns an iterator over all the reads from a port. Returns an empty iterator if this is an Input port.

pub fn writes_to(&self, port: &Port) -> PortIterator<'_>

Returns an iterator over all the writes to this port. Returns an empty iterator if this is an Output port.

pub fn add_edges(self, edges: &[(RRC<Port>, RRC<Port>)]) -> Self

Add each edge in edges to the graph.

pub fn toposort(&self) -> PortIterator<'_>

Return a topological sort of this graph.

pub fn paths(&self, start: &Port, finish: &Port) -> Vec<Vec<RRC<Port>>>

Return a Vec of paths from start to finish, each path a Vec of ports.

pub fn edge_induced_subgraph<F>(self, filter: F) -> Selfwhere
    F: FnMut(&Port, &Port) -> bool,

Restricts the analysis graph to only include edges that are specified by the filter.

filter is passed references to the src and dst of each edge. When filter(src, dst) is true, then the edge between src and dst is kept. Otherwise, it is removed.

pub fn ports(&self) -> Vec<RRC<Port>>

Returns all the Port associated with this instance.

pub fn remove_isolated_vertices(self) -> Self

Remove all vertices that have no undirected neighbors from the analysis graph.

pub fn has_cycles(&self) -> bool

Checks if there are cycles in the analysis graph.

Trait Implementations

impl Clone for GraphAnalysis

fn clone(&self) -> GraphAnalysis

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphAnalysis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GraphAnalysis

fn default() -> GraphAnalysis

Returns the “default value” for a type.

impl From<&Component> for GraphAnalysis

fn from(component: &Component) -> Self

Converts to this type from the input type.

impl From<&Group> for GraphAnalysis

fn from(group: &Group) -> Self

Converts to this type from the input type.

impl ToString for GraphAnalysis

fn to_string(&self) -> String

Converts the given value to a String.