Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extract_value documentation #440

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -837,9 +837,9 @@ impl EGraph {
}
}

/// Extract a value to a [`TermDag`] and [`Term`]
/// in the [`TermDag`].
/// See also extract_value_to_string for convenience.
/// Extract a value to a [`TermDag`] and [`Term`] in the [`TermDag`].
/// Note that the `TermDag` may contain a superset of the nodes in the `Term`.
/// See also `extract_value_to_string` for convenience.
pub fn extract_value(&self, value: Value) -> (TermDag, Term) {
let mut termdag = TermDag::default();
let sort = self.type_info.sorts.get(&value.tag).unwrap();
Expand All @@ -848,7 +848,7 @@ impl EGraph {
}

/// Extract a value to a string for printing.
/// See also extract_value for more control.
/// See also `extract_value` for more control.
pub fn extract_value_to_string(&self, value: Value) -> String {
let (termdag, term) = self.extract_value(value);
termdag.to_string(&term)
Expand Down
Loading