Struct Rule 

#[repr(C)]
pub struct Rule<Q1 = String, A = char, Q2 = Q1, B = A>
where
    Q1: RawState,
    Q2: RawState,
{
    pub head: Head<Q1, A>,
    pub tail: Tail<Q2, B>,
}

The Rule implementation is a concrete representation of a single instruction, or rule, within a given Turing machine program. It encapsulates the necessary components to define the behavior of the Turing machine when it encounters a specific state and symbol.

Note: The inner fields are flattened for serialization purposes when using serde; this means that the fields of the Head and Tail structs will be serialized as if they were direct fields of the Rule struct itself.

Fields

head: Head<Q1, A>

tail: Tail<Q2, B>

Implementations

impl<Q, A, R, B> Rule<Q, A, R, B>

where Q: RawState, R: RawState,

pub const fn new(head: Head<Q, A>, tail: Tail<R, B>) -> Self

returns a new instance of the Rule from the given head and tail

pub const fn init() -> RuleBuilder<Q, A, R, B>

returns a new instance of a RuleBuilder for constructing a new Rule

pub const fn from_parts( state: Q, symbol: A, direction: Direction, next_state: R, write_symbol: B, ) -> Self

initialize a new instance of the Rule from its consituent parts

pub fn with_head(self, head: Head<Q, A>) -> Self

consumes the current object to create another with the given head

pub fn with_tail(self, tail: Tail<R, B>) -> Self

consumes the current object to create another with the given tail

pub const fn head(&self) -> &Head<Q, A>

returns an immutable reference to the Head

pub const fn head_mut(&mut self) -> &mut Head<Q, A>

returns a mutable reference to the Head

pub const fn tail(&self) -> &Tail<R, B>

returns an immutable reference to the Tail of the Rule

pub const fn tail_mut(&mut self) -> &mut Tail<R, B>

returns a mutable reference to the Tail of the Rule

pub const fn head_view(&self) -> Head<&Q, &A>

returns an instance of the Head whose elements are immutable references

pub const fn tail_view(&self) -> Tail<&R, &B>

returns an instance of the Tail whose elements are immutable references

pub const fn direction(&self) -> Direction

returns the direction of the shift

pub const fn state(&self) -> &State<Q>

returns the current State of the system

pub const fn state_mut(&mut self) -> &mut State<Q>

returns a mutable reference to the current State of the system

pub const fn symbol(&self) -> &A

returns the symbol of the Head

pub const fn symbol_mut(&mut self) -> &mut A

returns a mutable reference to the symbol of the Head

pub const fn next_state(&self) -> &State<R>

returns the next State of the system

pub const fn next_state_mut(&mut self) -> &mut State<R>

returns a mutable reference to the next State of the system

pub const fn next_symbol(&self) -> &B

returns the symbol which will be written by the Head

pub const fn next_symbol_mut(&mut self) -> &mut B

returns a mutable reference to the next symbol

pub const fn write_symbol(&self) -> &B

returns the value which for which the current object will be replaced with

pub const fn write_symbol_mut(&mut self) -> &mut B

returns a mutable reference to the next symbol

pub fn set_direction(&mut self, direction: Direction)

updates the current Direction and returns a mutable reference to the Rule

pub fn set_symbol(&mut self, symbol: A)

update the current symbol and return a mutable reference to the Rule

pub fn set_state(&mut self, state: Q)

updates the current State and returns a mutable reference to the Rule

pub fn set_next_state(&mut self, state: R)

updates the current State and returns a mutable reference to the Rule

pub fn set_next_symbol(&mut self, symbol: B)

updates the next symbol and returns a mutable reference to the Rule

pub fn set_head(&mut self, state: Q, symbol: A)

updates the current State and symbol and returns a mutable reference to the Rule

pub fn set_tail(&mut self, state: R, symbol: B)

updates the current State and symbol and returns a mutable reference to the Rule

pub fn into_tuple(self) -> (Head<Q, A>, Tail<R, B>)

consumes the current object and returns a 2-tuple consisting of the Head and Tail

pub const fn next_head(&self) -> Head<&R, &B>

returns the next Head of the system

pub fn into_next_head(self) -> Head<R, B>

consumes the current object and returns the next Head of the system

impl<Q, A, R, B> Rule<&Q, &A, &R, &B>

where Q: RawState, R: RawState,

pub fn cloned(&self) -> Rule<Q, A, R, B>

where Q: Clone, A: Clone, R: Clone, B: Clone,

returns a new instance of the Rule with cloned elements

pub const fn copied(&self) -> Rule<Q, A, R, B>

where Q: Copy, A: Copy, R: Copy, B: Copy,

returns a new instance of the Rule with copied elements

impl<Q, A> Rule<Q, usize, Q, A>

where Q: RawState,

pub fn shift(&mut self, tape: &mut [A]) -> Option<Head<Q, A>>

where A: Clone, Q: Clone,

this method shifts the head along the tape, returning a head containing the previous state and symbol.

note: this method does not check if the current nor the next state is halted, it is up to the caller to establishing halting.

Trait Implementations

impl<Q, S> AsMut<Head<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_mut(&mut self) -> &mut Head<Q, S>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Q, S> AsMut<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_mut(&mut self) -> &mut Tail<Q, S>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Q, S> AsRef<Head<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_ref(&self) -> &Head<Q, S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Q, S> AsRef<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_ref(&self) -> &Tail<Q, S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Q, S> Borrow<Head<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow(&self) -> &Head<Q, S>

Immutably borrows from an owned value.

impl<Q, S> Borrow<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow(&self) -> &Tail<Q, S>

Immutably borrows from an owned value.

impl<Q, S> BorrowMut<Head<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow_mut(&mut self) -> &mut Head<Q, S>

Mutably borrows from an owned value.

impl<Q, S> BorrowMut<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow_mut(&mut self) -> &mut Tail<Q, S>

Mutably borrows from an owned value.

impl<Q1, A: Clone, Q2, B: Clone> Clone for Rule<Q1, A, Q2, B>

where Q1: RawState + Clone, Q2: RawState + Clone,

fn clone(&self) -> Rule<Q1, A, Q2, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q1, A: Debug, Q2, B: Debug> Debug for Rule<Q1, A, Q2, B>

where Q1: RawState + Debug, Q2: RawState + Debug,

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

Formats the value using the given formatter.

impl<Q1, A: Default, Q2, B: Default> Default for Rule<Q1, A, Q2, B>

where Q1: RawState + Default, Q2: RawState + Default,

fn default() -> Rule<Q1, A, Q2, B>

Returns the “default value” for a type.

impl<Q, A> Extend<Rule<Q, A>> for InstructionSet<Q, A>

where Q: RawState,

fn extend<I: IntoIterator<Item = Rule<Q, A>>>(&mut self, iter: I)

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<Q, S> From<(Head<Q, S>, Tail<Q, S>)> for Rule<Q, S>

where Q: RawState,

fn from((head, tail): (Head<Q, S>, Tail<Q, S>)) -> Self

Converts to this type from the input type.

impl<Q, S> From<Rule<Q, S>> for (Head<Q, S>, Tail<Q, S>)

where Q: RawState,

fn from(rule: Rule<Q, S>) -> Self

Converts to this type from the input type.

impl<Q, S, T> From<Rule<Q, S>> for LearnedRule<T, Q, S>

where Q: RawState, T: Default,

fn from(rule: Rule<Q, S>) -> Self

Converts to this type from the input type.

impl<Q1, A, Q2, B> From<RuleBuilder<Q1, A, Q2, B>> for Rule<Q1, A, Q2, B>

where Q1: RawState, Q2: RawState,

fn from(builder: RuleBuilder<Q1, A, Q2, B>) -> Self

Converts to this type from the input type.

impl<Q, A> FromIterator<Rule<Q, A>> for InstructionSet<Q, A>

where Q: RawState + Default,

fn from_iter<I: IntoIterator<Item = Rule<Q, A>>>(iter: I) -> Self

Creates a value from an iterator.

impl<Q1, A: Hash, Q2, B: Hash> Hash for Rule<Q1, A, Q2, B>

where Q1: RawState + Hash, Q2: RawState + 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<Q, A> Instruction<Q, A> for Rule<Q, A>

where Q: RawState,

type Head = Head<Q, A>

the type of head used by the instruction

type Tail = Tail<Q, A>

the type of tail used by the instruction

fn head(&self) -> &Self::Head

returns a reference to the head of the instruction

fn tail(&self) -> &Self::Tail

returns a reference to the tail of the instruction

fn current_state(&self) -> &State<Q>

returns a reference to the current state

fn symbol(&self) -> &A

returns a reference to the current symbol

fn next_state(&self) -> &State<Q>

returns a reference to the next state

fn next_symbol(&self) -> &A

returns a reference to the next symbol

fn direction(&self) -> Direction

returns the direction of the tail

impl<Q, A> InstructionMut<Q, A> for Rule<Q, A>

where Q: RawState,

fn head_mut(&mut self) -> &mut Self::Head

returns a mutable reference to the head of the instruction

fn tail_mut(&mut self) -> &mut Self::Tail

returns a mutable reference to the tail of the instruction

fn current_state_mut(&mut self) -> &mut State<Q>

returns a mutable reference to the current state

fn symbol_mut(&mut self) -> &mut A

returns a mutable reference to the current symbol

fn next_state_mut(&mut self) -> &mut State<Q>

returns a mutable reference to the next state

fn next_symbol_mut(&mut self) -> &mut A

returns a mutable reference to the next symbol

impl<Q1, A: Ord, Q2, B: Ord> Ord for Rule<Q1, A, Q2, B>

where Q1: RawState + Ord, Q2: RawState + Ord,

fn cmp(&self, other: &Rule<Q1, A, Q2, B>) -> 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<Q, S> PartialEq<(Head<Q, S>, Tail<Q, S>)> for Rule<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, other: &(Head<Q, S>, Tail<Q, S>)) -> 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<Q, S> PartialEq<Head<Q, S>> for Rule<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, other: &Head<Q, S>) -> 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<Q, S> PartialEq<Tail<Q, S>> for Rule<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, other: &Tail<Q, S>) -> 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<Q1, A: PartialEq, Q2, B: PartialEq> PartialEq for Rule<Q1, A, Q2, B>

where Q1: RawState + PartialEq, Q2: RawState + PartialEq,

fn eq(&self, other: &Rule<Q1, A, Q2, B>) -> 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<Q1, A: PartialOrd, Q2, B: PartialOrd> PartialOrd for Rule<Q1, A, Q2, B>

where Q1: RawState + PartialOrd, Q2: RawState + PartialOrd,

fn partial_cmp(&self, other: &Rule<Q1, A, Q2, B>) -> 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<Q1, A: Copy, Q2, B: Copy> Copy for Rule<Q1, A, Q2, B>

where Q1: RawState + Copy, Q2: RawState + Copy,

impl<Q1, A: Eq, Q2, B: Eq> Eq for Rule<Q1, A, Q2, B>

where Q1: RawState + Eq, Q2: RawState + Eq,

impl<Q1, A, Q2, B> StructuralPartialEq for Rule<Q1, A, Q2, B>

where Q1: RawState, Q2: RawState,