README
¶
markov
Markov model library for Go
Examples
Create a store for holding your Markov table data. Two built-in types are provided:
store := markov.NewInMemoryTableStore()
store, err := markov.NewBoltTableStore("path/to/store")
Stores may need to be closed after use:
defer store.Close()
Create a Markov model using the store:
model := markov.NewModel(store)
Use an Accumulator to build the model. The Accumulator needs the order of the model to build (here, we’re specifying a 3rd-order Markov model, meaning that each symbol is dependent on the three symbols that come before it):
acc := markov.NewAccumulator(model, 3)
Symbols can be added in sequence to the accumulator. Symbols are strings, but can represent characters, words, events, or any abstract element in an ordered sequence.
err := acc.Add("first symbol")
…
err = acc.Add("second symbol")
…
err = acc.Add("third symbol")
An empty string signifies the “end” of a sequence of symbols, if such a thing makes sense for your model:
err := acc.Add("")
Use a Generator to sample from the model. The Generator needs to know the order of the model for sampling (usually the same order as used for the Accumulator), and also a SampleSource which determines how samples are drawn (here, we use a seeded pseudorandom number generator):
gen := markov.NewGenerator(model, 3, rand.New(rand.NewSource(int64(12345))))
Sequences of symbols can be generated by sampling from the Generator:
symbol, err := gen.Get()
If the end of a sequence is reached, the empty symbol ("") is returned with no error.
Documentation
¶
Index ¶
Constants ¶
const BOLT_BUCKET = "markov"
Variables ¶
var ErrTableNotFound = errors.New("table not found")
Functions ¶
This section is empty.
Types ¶
type Accumulator ¶
func NewAccumulator ¶
func NewAccumulator(m *Model, order uint) *Accumulator
func (*Accumulator) Add ¶
func (acc *Accumulator) Add(symbol string) (err error)
type BoltTableStore ¶
func NewBoltTableStore ¶
func NewBoltTableStore(filePath string) (*BoltTableStore, error)
func (*BoltTableStore) Close ¶
func (ts *BoltTableStore) Close() error
func (*BoltTableStore) Get ¶
func (ts *BoltTableStore) Get(k SequenceKey, dest *Table) error
func (*BoltTableStore) Put ¶
func (ts *BoltTableStore) Put(k SequenceKey, table *Table) error
type Generator ¶
type Generator struct {
Model *Model
CurrentSequence Sequence
SampleSource SampleSource
}
func NewGenerator ¶
func NewGenerator(m *Model, order uint, s SampleSource) *Generator
type InMemoryTableStore ¶
type InMemoryTableStore struct {
TablesBySequence map[SequenceKey]*Table
}
func NewInMemoryTableStore ¶
func NewInMemoryTableStore() *InMemoryTableStore
func (*InMemoryTableStore) Get ¶
func (ts *InMemoryTableStore) Get(key SequenceKey, dest *Table) error
func (*InMemoryTableStore) Put ¶
func (ts *InMemoryTableStore) Put(key SequenceKey, table *Table) error
type Model ¶
type Model struct {
Tables TableStore
}
func NewModel ¶
func NewModel(store TableStore) *Model
type SampleSource ¶
type SampleSource interface {
Float64() float64
}
type Sequence ¶
type Sequence struct {
Symbols []string
}
func EmptySequence ¶
func SequenceWith ¶
func (Sequence) Key ¶
func (s Sequence) Key() SequenceKey
type SequenceKey ¶
type SequenceKey string
type Table ¶
type Table struct {
TotalSymbols uint64
Entries []TableEntry
EntryIndices map[string]int
}
func EmptyTable ¶
func EmptyTable() Table
type TableEntry ¶
type TableStore ¶
type TableStore interface {
Get(key SequenceKey, dest *Table) error
Put(key SequenceKey, table *Table) error
}
Source Files