Struct libjp::resolver::OrderResolver

pub struct OrderResolver<'a> { /* fields omitted */ }

A utility for interactively imposing a linear order on a graggle with no cycles.

You will usually create this struct using CycleResolver::into_order_resolver, which will ensure that there are no cycles remaining.

Methods

impl<'a> OrderResolver<'a>

pub fn ordered_nodes(&self) -> &[NodeId]

Returns a slice containing the nodes that have already been put in order.

pub fn candidates<'b>(
    &'b self
) -> impl Iterator<Item = CandidateChain<'a>> + 'b

Returns an iterator over the current set of candidates.

Each of the returned values represents a node (or sequence of nodes) that could go next in the output.

pub fn choose(&mut self, next: &NodeId)

Chooses a node to go next in the ordered output.

The chosen node must be a valid choice, meaning that there cannot be an edge from the chosen node to a node that has not yet been chosen. If the chosen node was taken from the head of one of the chains returned by OrderResolver::candidates, it is guaranteed to be a valid choice.

Panics

Panics if the chosen node is not a valid choice.

pub fn delete(&mut self, u: &NodeId)

Deletes a node, instead of including it in the ordered output.

The chosen node must be valid in the sense described in OrderResolver::choose.

Panics

Panics if the chosen node is not a valid choice.

pub fn is_finished(&self) -> bool

Returns true if the entire graggle has already been put in order.

pub fn changes(&self) -> Changes

Assuming that the entire graggle has already been put in order, returns a Changes that, when applied to the graggle, will turn it from the original graggle into the linear order that we have just created (and which can be retrieved by OrderResolver::ordered_nodes).