Struct MarkovChain

pub struct MarkovChain<I: ChainItem> { /* private fields */ }

The Markov Chain data structure

A Markov chain is a statistical model that is used to predict random sequences based on the probability of one symbol coming after another. For a basic introduction you can read this article. For a more technical overview you can read the wikipedia article on the subject.

Items in markov chains in gmarkov-lib must implement the Eq, Hash, and Clone traits for use.

Implementations

impl<I: ChainItem> MarkovChain<I>

pub fn with_order<T>(order: usize) -> MarkovChain<I>

Create a Markov chain with order order.

The order specifies how many steps back in the sequence the chain keeps track of. A higher order allows for better results but also requires a much larger dataset.

Examples found in repository

examples/dictionary.rs (line 8)

fn main() -> Result<()> {
    let mut chain = MarkovChain::with_order::<char>(2);

    let reader = BufReader::new(File::open("dictionary_sample.txt")?);

    for line in reader.lines() {
        chain.feed(line?.chars());
    }

    println!("New word: {}", chain.into_iter().collect::<String>());

    Ok(())
}

pub fn feed(&mut self, input: impl Iterator<Item = I>)

Train the Markov chain by “feeding” it the iterator input.

This adds the input to the current Markov chain. The generated output will resemble this input.

Examples found in repository

examples/dictionary.rs (line 13)

fn main() -> Result<()> {
    let mut chain = MarkovChain::with_order::<char>(2);

    let reader = BufReader::new(File::open("dictionary_sample.txt")?);

    for line in reader.lines() {
        chain.feed(line?.chars());
    }

    println!("New word: {}", chain.into_iter().collect::<String>());

    Ok(())
}

Trait Implementations

impl<I: Clone + ChainItem> Clone for MarkovChain<I>

fn clone(&self) -> MarkovChain<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + ChainItem> Debug for MarkovChain<I>

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

Formats the value using the given formatter.

impl<I: ChainItem> IntoIterator for MarkovChain<I>

fn into_iter(self) -> Self::IntoIter

Transform the Markov chain into an iterator.

You will usually want to clone the Markov chain before turning it into an iterator so that you don’t have to retrain it every time.

type Item = I

The type of the elements being iterated over.

type IntoIter = MarkovIterator<I>

Which kind of iterator are we turning this into?