Skip to content

Commit

Permalink
Merge pull request #440 from Alex-Fischman/extract-docs
Browse files Browse the repository at this point in the history
`extract_value` documentation
  • Loading branch information
Alex-Fischman authored Oct 10, 2024
2 parents b3a5416 + 85a5542 commit 8bacebf
Showing 1 changed file with 4 additions and 4 deletions.
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

0 comments on commit 8bacebf

Please sign in to comment.