Skip to main content

Chain

Struct Chain 

Source
pub struct Chain { /* private fields */ }
Expand description

A Markov chain representing processes that have both beginnings and ends.

The chain is represented as a HashMap where keys are states (tuples of words) and values are HashMaps of possible next words with their frequencies.

Implementations§

Source§

impl Chain

Source

pub fn new(corpus: &[Vec<String>], state_size: usize) -> Self

Create a new Markov chain from a corpus

§Arguments
  • corpus - A list of runs, where each run is a sequence of items (e.g., words in a sentence)
  • state_size - The number of items used to represent the chain’s state
Source

pub fn compile(&self) -> Self

Compile the chain for faster generation

This converts the frequency dictionaries into cumulative frequency lists for more efficient random selection.

Source

pub fn gen(&self, init_state: Option<&[String]>) -> ChainGenerator<'_>

Generate items from the chain

Returns an iterator that yields successive items until the END state is reached.

Source

pub fn walk(&self, init_state: Option<&[String]>) -> Vec<String>

Walk the chain and return a complete sequence

Returns a vector representing a single run of the Markov model.

Source

pub fn state_size(&self) -> usize

Get the state size

Source

pub fn model(&self) -> &FxHashMap<Vec<String>, FxHashMap<String, usize>>

Get the model (for inspection or combination)

Source

pub fn is_compiled(&self) -> bool

Check if the chain is compiled

Source

pub fn to_json(&self) -> Result<String>

Serialize the chain to JSON

Source

pub fn from_json(json_str: &str) -> Result<Self>

Deserialize a chain from JSON

Source

pub fn from_combined_model( model: FxHashMap<Vec<String>, FxHashMap<String, usize>>, state_size: usize, ) -> Self

Create a chain from a pre-built model (used for combining models)

Trait Implementations§

Source§

impl Clone for Chain

Source§

fn clone(&self) -> Chain

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Chain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Chain

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Chain

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Chain

§

impl RefUnwindSafe for Chain

§

impl Send for Chain

§

impl Sync for Chain

§

impl Unpin for Chain

§

impl UnsafeUnpin for Chain

§

impl UnwindSafe for Chain

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,