Struct LearnedRule 

pub struct LearnedRule<C = f32, Q = usize, S = usize>
where
    Q: RawState,
{
    pub confidence: C,
    pub rule: Rule<Q, S>,
}

A LearnedRule is an extension of the basic Rule structure, incorporating a confidence metric to quantify the reliability or certainty of the rule within the scope of a learning context. This is particularly useful in scenarios where rules are derived from data or experience, allowing for a more nuanced application of rules based on their confidence levels.

Fields

confidence: C

rule: Rule<Q, S>

Implementations

impl<T, Q, S> LearnedRule<T, Q, S>

where Q: RawState,

pub const fn new(head: Head<Q, S>, tail: Tail<Q, S>, confidence: T) -> Self

create a new LearnedRule using the given head, tail, and confidence

pub const fn from_rule(rule: Rule<Q, S>, confidence: T) -> Self

returns a new instance using the given rule and confidence

pub const fn from_parts( state: Q, symbol: S, direction: Direction, next_state: Q, write_symbol: S, confidence: T, ) -> Self

returns a new instance from its constituent parts

pub const fn confidence(&self) -> &T

returns an immutable reference to the confidence of the rule

pub const fn confidence_mut(&mut self) -> &mut T

returns a mutable reference to the confidence of the rule

pub const fn rule(&self) -> &Rule<Q, S>

returns an immutable reference to the learned rule

pub const fn rule_mut(&mut self) -> &mut Rule<Q, S>

returns a mutable reference to the learned rule

pub fn set_confidence(&mut self, confidence: T)

update the confidence level of the rule

pub fn set_rule(&mut self, rule: Rule<Q, S>)

update the rule

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

returns an immutable reference to the head of the rule

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

returns a mutable reference to the head of the rule

pub const fn tail(&self) -> &Tail<Q, S>

returns an immutable reference to the tail of the rule

pub const fn tail_mut(&mut self) -> &mut Tail<Q, S>

returns a mutable reference to the tail of the rule

Methods from Deref<Target = Rule<Q, A>>

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

returns an immutable reference to the Head

pub fn tail(&self) -> &Tail<Q, A>

returns an immutable reference to the Tail of the [Instruction]

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

returns an instance of the Head whose elements are immutable references

pub fn tail_view(&self) -> Tail<&Q, &A>

returns an instance of the Tail whose elements are immutable references

pub fn direction(&self) -> Direction

returns the direction of the shift

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

returns the current State of the system

pub fn symbol(&self) -> &A

returns the symbol of the Head

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

returns the next State of the system

pub fn next_symbol(&self) -> &A

returns the symbol which will be written by the Head

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

returns the next Head of the system

pub fn write_symbol(&self) -> &A

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

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

where Q: Clone, A: Clone,

returns a new instance of the Rule with cloned elements

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

where Q: Clone, A: Clone,

returns a new instance of the Rule with copied elements

Trait Implementations

impl<C: Clone, Q, S: Clone> Clone for LearnedRule<C, Q, S>

where Q: RawState + Clone,

fn clone(&self) -> LearnedRule<C, Q, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug, Q, S: Debug> Debug for LearnedRule<C, Q, S>

where Q: RawState + Debug,

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

Formats the value using the given formatter.

impl<C: Default, Q, S: Default> Default for LearnedRule<C, Q, S>

where Q: RawState + Default,

fn default() -> LearnedRule<C, Q, S>

Returns the “default value” for a type.

impl<Q, A, T> Deref for LearnedRule<T, Q, A>

where Q: RawState,

type Target = Rule<Q, A>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, C, Q, S> Deserialize<'de> for LearnedRule<C, Q, S>

where Q: RawState + Deserialize<'de>, C: Deserialize<'de>, S: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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<C: Hash, Q, S: Hash> Hash for LearnedRule<C, Q, S>

where Q: 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<C: Ord, Q, S: Ord> Ord for LearnedRule<C, Q, S>

where Q: RawState + Ord,

fn cmp(&self, other: &LearnedRule<C, Q, S>) -> 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<C: PartialEq, Q, S: PartialEq> PartialEq for LearnedRule<C, Q, S>

where Q: RawState + PartialEq,

fn eq(&self, other: &LearnedRule<C, 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<C: PartialOrd, Q, S: PartialOrd> PartialOrd for LearnedRule<C, Q, S>

where Q: RawState + PartialOrd,

fn partial_cmp(&self, other: &LearnedRule<C, Q, S>) -> 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<C, Q, S> Serialize for LearnedRule<C, Q, S>

where Q: RawState + Serialize, C: Serialize, S: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Copy, Q, S: Copy> Copy for LearnedRule<C, Q, S>

where Q: RawState + Copy,

impl<C: Eq, Q, S: Eq> Eq for LearnedRule<C, Q, S>

where Q: RawState + Eq,

impl<C, Q, S> StructuralPartialEq for LearnedRule<C, Q, S>

where Q: RawState,