LpExtractor

Struct LpExtractor 

Source
pub struct LpExtractor<'a, L: Language, N: Analysis<L>> { /* private fields */ }
Available on crate feature lp only.
Expand description

A structure to perform extraction using integer linear programming. This uses the cbc solver. You must have it installed on your machine to use this feature. You can install it using:

OSCommand
Fedora / Red Hatsudo dnf install coin-or-Cbc-devel
Ubuntu / Debiansudo apt-get install coinor-libcbc-dev
macOSbrew install cbc

On macOS, you might also need the following in your .zshrc file: export LIBRARY_PATH=$LIBRARY_PATH:$(brew --prefix)/lib

§Example

use egg::*;
let mut egraph = EGraph::<SymbolLang, ()>::default();

let f = egraph.add_expr(&"(f x x x)".parse().unwrap());
let g = egraph.add_expr(&"(g (g x))".parse().unwrap());
egraph.union(f, g);
egraph.rebuild();

let best = Extractor::new(&egraph, AstSize).find_best(f).1;
let lp_best = LpExtractor::new(&egraph, AstSize).solve(f);

// In regular extraction, cost is measures on the tree.
assert_eq!(best.to_string(), "(g (g x))");

// Using ILP only counts common sub-expressions once,
// so it can lead to a smaller DAG expression.
assert_eq!(lp_best.to_string(), "(f x x x)");
assert_eq!(lp_best.len(), 2);

Implementations§

Source§

impl<'a, L, N> LpExtractor<'a, L, N>
where L: Language, N: Analysis<L>,

Source

pub fn new<CF>(egraph: &'a EGraph<L, N>, cost_function: CF) -> Self
where CF: LpCostFunction<L, N>,

Create an LpExtractor using costs from the given LpCostFunction. See those docs for details.

Source

pub fn timeout(&mut self, seconds: f64) -> &mut Self

Set the cbc timeout in seconds.

Source

pub fn solve(&mut self, root: Id) -> RecExpr<L>

Extract a single rooted term.

This is just a shortcut for LpExtractor::solve_multiple.

Source

pub fn solve_multiple(&mut self, roots: &[Id]) -> (RecExpr<L>, Vec<Id>)

Extract (potentially multiple) roots

Auto Trait Implementations§

§

impl<'a, L, N> Freeze for LpExtractor<'a, L, N>

§

impl<'a, L, N> RefUnwindSafe for LpExtractor<'a, L, N>

§

impl<'a, L, N> Send for LpExtractor<'a, L, N>
where N: Sync, L: Sync, <L as Language>::Discriminant: Sync, <N as Analysis<L>>::Data: Sync,

§

impl<'a, L, N> Sync for LpExtractor<'a, L, N>
where N: Sync, L: Sync, <L as Language>::Discriminant: Sync, <N as Analysis<L>>::Data: Sync,

§

impl<'a, L, N> Unpin for LpExtractor<'a, L, N>

§

impl<'a, L, N> UnwindSafe for LpExtractor<'a, L, N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.