Struct rustemo::Forest

pub struct Forest<'i, I, P, TK>
where
    I: Input + ?Sized,
    TK: Copy,
{ /* private fields */ }

Shared Packed Parse Forest (SPPF) returned by the GLR parser.

A forest is an ordered collection of trees. Basically, a wrapper around GSS structure to provide information about number of trees/solutions, ambiguities and to provide tree extraction/navigation.

Trees of the forest are ordered and each tree can be extracted as either an eager or a lazy tree given its index.

Implementations

impl<'i, I, P, TK> Forest<'i, I, P, TK>

where I: Input + ?Sized, TK: Copy,

pub fn new(results: Vec<Rc<SPPFTree<'i, I, P, TK>>>) -> Self

pub fn get_first_tree(&self) -> Option<Tree<'i, I, P, TK>>

pub fn get_tree(&self, idx: usize) -> Option<Tree<'i, I, P, TK>>

Extracts a tree with the given index

pub fn is_empty(&self) -> bool

pub fn solutions(&self) -> usize

The total number of trees/solutions in this forest.

pub fn ambiguities(&self) -> usize

Total number of ambiguous places/nodes in this forest.

Extracted trees are unambiguous but forests may have ambiguities. If there is >1 trees in the forest there are ambiguities.

impl<'i, I, P, TK> Forest<'i, I, P, TK>

where I: Input + ?Sized, TK: Copy,

Support for iter()

pub fn iter<'f>(&'f self) -> ForestIterator<'i, 'f, I, P, TK>

Trait Implementations

impl<'i, I, P: Debug, TK> Debug for Forest<'i, I, P, TK>

where I: Input + ?Sized + Debug, TK: Copy + Debug,

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

Formats the value using the given formatter.

impl<'i, 'f, I, P, TK> IntoIterator for &'f Forest<'i, I, P, TK>

where I: Input + ?Sized, TK: Copy,

For loop iteration over borrowed Forest

type Item = Tree<'i, I, P, TK>

The type of the elements being iterated over.

type IntoIter = ForestIterator<'i, 'f, I, P, TK>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'i, I, P, TK> IntoIterator for Forest<'i, I, P, TK>

where I: Input + ?Sized, TK: Copy,

type Item = Tree<'i, I, P, TK>

The type of the elements being iterated over.

type IntoIter = ForestIntoIter<'i, I, P, TK>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.