Struct term_rewriting::trace::TraceNode

pub struct TraceNode(_);

A TraceNode describes a specific evaluation step in the Trace.

Methods

impl TraceNode

pub fn state(&self) -> TraceState

The TraceState associated with this evaluation step.

pub fn term(&self) -> Term

The Term associated with this evaluation step.

pub fn log_p(&self) -> f64

The log probability of reaching this particular evaluation step.

pub fn depth(&self) -> usize

The depth (i.e. number of previous evaluation steps) of this evaluation step.

pub fn parent(&self) -> Option<TraceNode>

The parent TraceNode of this evaluation step.

pub fn children(&self) -> Vec<TraceNode>

The children TraceNodes of this evaluation step.

pub fn is_leaf(&self) -> bool

Whether this evaluation step has no associated children.

Important traits for TraceNodeIter

impl Iterator for TraceNodeIter type Item = TraceNode;

pub fn iter(&self) -> TraceNodeIter

Returns an iterator over all nodes that descend from this node.

pub fn progeny(&self, states: &[TraceState]) -> Vec<TraceNode>

All the nodes descending from this node.

pub fn leaves(&self, states: &[TraceState]) -> Vec<TraceNode>

All the leaf nodes that descend from this node.

pub fn leaf_terms(&self, states: &[TraceState]) -> Vec<Term>

Like leaves, but returns Terms instead of TraceNodess.

Trait Implementations

impl PartialEq<TraceNode> for TraceNode

fn eq(&self, other: &TraceNode) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for TraceNode

fn clone(&self) -> TraceNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for TraceNode

fn cmp(&self, other: &TraceNode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> IntoIterator for &'a TraceNode

type Item = TraceNode

The type of the elements being iterated over.

type IntoIter = TraceNodeIter

Which kind of iterator are we turning this into?

Important traits for TraceNodeIter

impl Iterator for TraceNodeIter type Item = TraceNode;

fn into_iter(self) -> TraceNodeIter

Creates an iterator from a value.

impl IntoIterator for TraceNode

type Item = TraceNode

The type of the elements being iterated over.

type IntoIter = TraceNodeIter

Which kind of iterator are we turning this into?

Important traits for TraceNodeIter

impl Iterator for TraceNodeIter type Item = TraceNode;

fn into_iter(self) -> TraceNodeIter

Creates an iterator from a value.

impl Eq for TraceNode

impl PartialOrd<TraceNode> for TraceNode

fn partial_cmp(&self, other: &TraceNode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for TraceNode

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

Formats the value using the given formatter.