Struct ProgramBase 

pub struct ProgramBase<R, Q, A, I = <R as RawRuleset<Q, A>>::Rule>
where
    Q: RawState,
    R: RawRuleset<Q, A, Rule = I> + ?Sized,
    I: Instruction<Q, A>,
{ /* private fields */ }

The ProgramBase struct is used to define a generic program capable of being executed by a Turing machine or similar computational model. It consists of an optional initial state, a set of rules (or instructions) used to indicate how the machine should respond under different circumstances, and a marker to associate the generic parameters with the struct.

Implementations

impl<R, I, Q, A> ProgramBase<R, Q, A, I>

where Q: RawState, R: RawRuleset<Q, A, Rule = I>, I: Instruction<Q, A>,

pub const fn from_rules(rules: R) -> Self

initialize a new program from the given rule set

pub const fn rules(&self) -> &R

returns a reference to the ruleset

pub fn initial_state(&self) -> Option<&State<Q>>

returns reference to the (optional) initial state

pub fn set_initial_state(&mut self, initial_state: Q)

configure the initial state

pub fn with_default_state<U>(self, initial_state: U) -> Self

where U: IntoState<Q>,

consumes the instance to create another with the given initial state

pub fn get_head(&self, head: &Head<Q, A>) -> Option<&Tail<Q, A>>

where R: Ruleset<Q, A>, R::Rule: Instruction<Q, A, Head = Head<Q, A>, Tail = Tail<Q, A>>,

pub fn find_tail(&self, state: State<&Q>, sym: &A) -> Option<&Tail<Q, A>>

where R: Ruleset<Q, A>, R::Rule: Instruction<Q, A, Head = Head<Q, A>, Tail = Tail<Q, A>>,

given a state and symbol, returns the corresponding tail if it exists within the ruleset

pub fn len(&self) -> usize

returns the number of rules within the ruleset

pub fn is_empty(&self) -> bool

returns true if the ruleset is considered empty (i.e. contains no rules), otherwise false.

impl<I, Q, A> ProgramBase<[I], Q, A, I>

where Q: RawState, I: Instruction<Q, A>,

pub fn iter(&self) -> Iter<'_, I>

returns an iterator over the elements.

pub fn iter_mut(&mut self) -> IterMut<'_, I>

returns a mutable iterator over the elements.

impl<I, Q, A> ProgramBase<&[I], Q, A, I>

where Q: RawState, I: Instruction<Q, A>,

pub fn iter(&self) -> Iter<'_, I>

returns an iterator over the elements.

impl<I, Q, A> ProgramBase<&mut [I], Q, A, I>

where Q: RawState, I: Instruction<Q, A>,

pub fn iter(&self) -> Iter<'_, I>

returns an iterator over the elements.

pub fn iter_mut(&mut self) -> IterMut<'_, I>

returns a mutable iterator over the elements.

impl<const N: usize, I, Q, A> ProgramBase<[I; N], Q, A>

where Q: RawState, I: Instruction<Q, A>,

pub fn iter(&self) -> Iter<'_, I>

returns an iterator over the elements.

pub fn iter_mut(&mut self) -> IterMut<'_, I>

returns a mutable iterator over the elements.

impl<I, Q, A> ProgramBase<Vec<I>, Q, A, I>

where Q: RawState, I: Instruction<Q, A>,

pub fn iter(&self) -> Iter<'_, I>

returns an iterator over the elements.

pub fn iter_mut(&mut self) -> IterMut<'_, I>

returns a mutable iterator over the elements.

Trait Implementations

impl<R, Q, A: Clone, I> Clone for ProgramBase<R, Q, A, I>

where Q: RawState + Clone, R: RawRuleset<Q, A, Rule = I> + Clone + ?Sized, I: Instruction<Q, A> + Clone,

fn clone(&self) -> ProgramBase<R, Q, A, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R, I, Q, A> Debug for ProgramBase<R, Q, A, I>

where R: RawRuleset<Q, A, Rule = I> + Debug, Q: RawState + Debug, I: Instruction<Q, A> + Debug,

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

Formats the value using the given formatter.

impl<R, Q, A: Default, I> Default for ProgramBase<R, Q, A, I>

where Q: RawState + Default, R: RawRuleset<Q, A, Rule = I> + Default + ?Sized, I: Instruction<Q, A> + Default,

fn default() -> ProgramBase<R, Q, A, I>

Returns the “default value” for a type.

impl<R, I, Q, A> Display for ProgramBase<R, Q, A, I>

where R: RawRuleset<Q, A, Rule = I> + Debug, Q: RawState + Display, I: Instruction<Q, A> + Debug + Display,

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

Formats the value using the given formatter.

impl<X, R, Q, A> Extend<X> for ProgramBase<R, Q, A, X>

where Q: RawState, X: Instruction<Q, A>, R: RawRuleset<Q, A, Rule = X> + Extend<X>,

fn extend<Iter>(&mut self, iter: Iter)

where Iter: IntoIterator<Item = X>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<X, R, Q, A> FromIterator<X> for ProgramBase<R, Q, A, X>

where Q: RawState, X: Instruction<Q, A>, R: RawRuleset<Q, A, Rule = X> + FromIterator<X>,

fn from_iter<Iter>(iter: Iter) -> Self

where Iter: IntoIterator<Item = X>,

Creates a value from an iterator.

impl<R, Q, A: Hash, I> Hash for ProgramBase<R, Q, A, I>

where Q: RawState + Hash, R: RawRuleset<Q, A, Rule = I> + Hash + ?Sized, I: Instruction<Q, A> + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, X, I, R, Q, A> IntoIterator for &'a ProgramBase<R, Q, A, X>

where Q: RawState, X: 'a + Instruction<Q, A>, R: RawRuleset<Q, A, Rule = X>, I: Iterator<Item = &'a X>, for<'b> &'b R: IntoIterator<Item = &'b X, IntoIter = I>,

type Item = &'a X

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<I, X, R, Q, A> IntoIterator for ProgramBase<R, Q, A, X>

where I: Iterator<Item = X>, Q: RawState, X: Instruction<Q, A>, R: RawRuleset<Q, A, Rule = X> + IntoIterator<Item = X, IntoIter = I>,

type Item = <R as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <R as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<R, Q, A: Ord, I> Ord for ProgramBase<R, Q, A, I>

where Q: RawState + Ord, R: RawRuleset<Q, A, Rule = I> + Ord + ?Sized, I: Instruction<Q, A> + Ord,

fn cmp(&self, other: &ProgramBase<R, Q, A, I>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<R, Q, A: PartialEq, I> PartialEq for ProgramBase<R, Q, A, I>

where Q: RawState + PartialEq, R: RawRuleset<Q, A, Rule = I> + PartialEq + ?Sized, I: Instruction<Q, A> + PartialEq,

fn eq(&self, other: &ProgramBase<R, Q, A, I>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R, Q, A: PartialOrd, I> PartialOrd for ProgramBase<R, Q, A, I>

where Q: RawState + PartialOrd, R: RawRuleset<Q, A, Rule = I> + PartialOrd + ?Sized, I: Instruction<Q, A> + PartialOrd,

fn partial_cmp(&self, other: &ProgramBase<R, Q, A, I>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<R, Q, A: Copy, I> Copy for ProgramBase<R, Q, A, I>

where Q: RawState + Copy, R: RawRuleset<Q, A, Rule = I> + Copy + ?Sized, I: Instruction<Q, A> + Copy,

impl<R, Q, A: Eq, I> Eq for ProgramBase<R, Q, A, I>

where Q: RawState + Eq, R: RawRuleset<Q, A, Rule = I> + Eq + ?Sized, I: Instruction<Q, A> + Eq,

impl<R, Q, A, I> StructuralPartialEq for ProgramBase<R, Q, A, I>

where Q: RawState, R: RawRuleset<Q, A, Rule = I> + ?Sized, I: Instruction<Q, A>,