Struct Markov

pub struct Markov<P: Prefix = PrefixDefault>(/* private fields */);

Markov-Chain based pronounceable word generator.

Implementations

impl<P: Prefix> Markov<P>

pub fn new(depth: usize) -> Self

Create new Markov-Chain with the given depth.

A Markov-Chain contains a letter frequency table for prefixes of depth codepoints. If depth is zero, then only a single table is used and the output is not context-sensitive. Higher values of depth lead to better results, but take up more memory and time to build.

pub fn load(path: &Path, depth: usize) -> Result<Self, Error>

pub fn insert(&mut self, word: &str, count: usize)

Insert a word with a given weight into the table.

pub fn window(&self) -> Box<[char]>

pub fn generate( &self, rng: &mut dyn RngCore, window: &mut [char], ) -> (Option<char>, f64)

pub fn generate_word(&self, rng: &mut dyn RngCore) -> (String, f64)

Generates a single word from the Markov chain.

Panics

This will panic if the Markov chain is empty.

pub fn generate_chars<'a>( &'a self, rng: &'a mut dyn RngCore, ) -> impl Iterator<Item = (char, f64)> + 'a

Returns an iterator over characters of a random word generated by the table.

Trait Implementations

impl<P: Clone + Prefix> Clone for Markov<P>

fn clone(&self) -> Markov<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + Prefix> Debug for Markov<P>

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

Formats the value using the given formatter.

impl<P: Default + Prefix> Default for Markov<P>

fn default() -> Markov<P>

Returns the “default value” for a type.

impl<P: PartialEq + Prefix> PartialEq for Markov<P>

fn eq(&self, other: &Markov<P>) -> 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<P: Prefix> StructuralPartialEq for Markov<P>