wordmarkov 0.1.4

A simple but flexible Markov chain library, specifically for text sentences, which handles punctuation and whitespace
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

/*!
 * The Selector interface, a trait whose implementors can be used as a way of
 * deciding the next state of a Markov chain.
 */

use crate::prelude::{MarkovToken, MarkovTraverseDir};

/**
 * The way in which the weights returned by [MarkovSelector::weight] should be
 * interpreted.
 */
pub enum SelectionType {
    WeightedRandom,
    Highest,
    Lowest,
}
/**
 * An object which can be used as a selector for a Markov chain.
 */
pub trait MarkovSelector {
    /**
     * Reset the state of this MarkovSelector.
     *
     * Must always be called before composing a new sentence.
     */
    fn reset(&mut self, direction: MarkovTraverseDir);

    /**
     * The weight of a particular link.
     *
     * A numeric value. Can be interpreted as either a probability or a
     * preference, depending on the return value of [Self::selection_type()].
     * If the latter is the case, the highest (or lowest!) weight is always the
     * final selection.
     *
     * Stateful.
     */
    fn weight<'a>(
        &mut self,
        from: &MarkovToken<'a>,
        to: &MarkovToken<'a>,
        punct: &MarkovToken<'a>,
        occurrences: usize,
    ) -> f32;

    /**
     * Returns the [SelectionType] of this Selector; this will decide how the
     * weight returned by [Self::weight()] should be interpreted.
     */
    fn selection_type(&mut self) -> SelectionType;
}