Struct chainkov::MarkovChain

pub struct MarkovChain {
    pub transition_prob: HashMap<String, Vec<(String, f32)>>,
}

chainkov Basic Usage

Example

use std::collections::HashMap;

let mut m = chainkov::MarkovChain::new();
assert_eq!(m.transition_prob, HashMap::new());
 
m.add_state_choice("a", ("b".to_string(), 1.0));
let mut new_state = &m.transition_prob.get("a").unwrap()[0];
assert_eq!(new_state.0, "b".to_string());
assert_eq!(new_state.1, 1.0);
 
m.add_state_choice("b", ("c".to_string(), 1.0));
new_state = &m.transition_prob.get("b").unwrap()[0];
assert_eq!(new_state.0, "c".to_string());
assert_eq!(new_state.1, 1.0);
 
m.add_state_choice("c", ("d".to_string(), 1.0));
new_state = &m.transition_prob.get("c").unwrap()[0];
assert_eq!(new_state.0, "d".to_string());
assert_eq!(new_state.1, 1.0);

m.add_state_choice("d", ("a".to_string(), 1.0));
new_state = &m.transition_prob.get("d").unwrap()[0];
assert_eq!(new_state.0, "a".to_string());
assert_eq!(new_state.1, 1.0);
 
let answer_vec = m.generate_states("a".to_string(), 4);
assert_eq!(answer_vec, vec!["b", "c", "d", "a"]);
let mut answer = m.next_state("a".to_string());
assert_eq!(answer, "b");

// incrementing when a state already exists
m.increment_state("a", "b");
new_state = &m.transition_prob.get("a").unwrap()[0];
assert_eq!(new_state.0, "b");
assert_eq!(new_state.1, 2.0);
// incrementing when a key exists but the state transition doesn't
m.increment_state("a", "c");
new_state = &m.transition_prob.get("a").unwrap()[1];
assert_eq!(new_state.0, "c");
assert_eq!(new_state.1, 1.0);

// incrementing when there is a new state in the MarkovChain
m.increment_state("e", "a");
new_state = &m.transition_prob.get("e").unwrap()[0];
assert_eq!(new_state.0, "a");
assert_eq!(new_state.1, 1.0);

Fields

transition_prob: HashMap<String, Vec<(String, f32)>>

Methods

impl MarkovChain

pub fn add_state_choice(&mut self, key: &str, probability: (String, f32))

pub fn increment_state(&mut self, key: &str, state: &str)

pub fn generate_states(
    &self,
    current_state: String,
    num_of_states: u16
) -> Vec<String>

pub fn new() -> MarkovChain

pub fn next_state(&self, current_state: String) -> String

Trait Implementations

impl Clone for MarkovChain

fn clone(&self) -> MarkovChain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkovChain

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

Formats the value using the given formatter.

impl PartialEq<MarkovChain> for MarkovChain

fn eq(&self, other: &MarkovChain) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for MarkovChain