Struct Dot

pub struct Dot<'a, L: Language, N: Analysis<L>> {
    pub config: Vec<String>,
    pub use_anchors: bool,
    /* private fields */
}

A wrapper for an EGraph that can output GraphViz for visualization.

The EGraph::dot method creates Dots.

Example

use egg::{*, rewrite as rw};

let rules = &[
    rw!("mul-commutes"; "(* ?x ?y)" => "(* ?y ?x)"),
    rw!("mul-two";      "(* ?x 2)" => "(<< ?x 1)"),
];

let mut egraph: EGraph<SymbolLang, ()> = Default::default();
egraph.add_expr(&"(/ (* 2 a) 2)".parse().unwrap());
let egraph = Runner::default().with_egraph(egraph).run(rules).egraph;

// Dot implements std::fmt::Display
println!("My egraph dot file: {}", egraph.dot());

// create a Dot and then compile it assuming `dot` is on the system
egraph.dot().to_svg("target/foo.svg").unwrap();
egraph.dot().to_png("target/foo.png").unwrap();
egraph.dot().to_pdf("target/foo.pdf").unwrap();
egraph.dot().to_dot("target/foo.dot").unwrap();

Note that self-edges (from an enode to its containing eclass) will be rendered improperly due to a deficiency in GraphViz. So the example above will render with an from the “+” enode to itself instead of to its own eclass.

Fields

config: Vec<String>

A list of strings to be output top part of the dot file.

use_anchors: bool

Whether or not to anchor the edges in the output. True by default.

Implementations

impl<'a, L, N> Dot<'a, L, N>

where L: Language + Display, N: Analysis<L>,

pub fn to_dot(&self, filename: impl AsRef<Path>) -> Result<()>

Writes the Dot to a .dot file with the given filename. Does not require a dot binary.

pub fn with_config_line(self, line: impl Into<String>) -> Self

Adds a line to the dot output. Indentation and a newline will be added automatically.

pub fn with_anchors(self, use_anchors: bool) -> Self

Set whether or not to anchor the edges in the output.

pub fn to_png(&self, filename: impl AsRef<Path>) -> Result<()>

Renders the Dot to a .png file with the given filename. Requires a dot binary to be on your $PATH.

pub fn to_svg(&self, filename: impl AsRef<Path>) -> Result<()>

Renders the Dot to a .svg file with the given filename. Requires a dot binary to be on your $PATH.

pub fn to_pdf(&self, filename: impl AsRef<Path>) -> Result<()>

Renders the Dot to a .pdf file with the given filename. Requires a dot binary to be on your $PATH.

pub fn run_dot<S, I>(&self, args: I) -> Result<()>

where S: AsRef<OsStr>, I: IntoIterator<Item = S>,

Invokes dot with the given arguments, piping this formatted Dot into stdin.

pub fn run<S1, S2, I>(&self, program: S1, args: I) -> Result<()>

where S1: AsRef<OsStr>, S2: AsRef<OsStr>, I: IntoIterator<Item = S2>,

Invokes some program with the given arguments, piping this formatted Dot into stdin.

Can be used to run a different binary than dot:

egraph.dot().run(
    "/path/to/my/dot",
    &["arg1", "-o", "outfile"]
).unwrap();

Trait Implementations

impl<'a, L: Language, N: Analysis<L>> Debug for Dot<'a, L, N>

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

Formats the value using the given formatter.

impl<'a, L, N> Display for Dot<'a, L, N>

where L: Language + Display, N: Analysis<L>,

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

Formats the value using the given formatter.