kwg

Documentation

Index

• Constants
• func CacheLoadFunc(cfg *config.Config, key string) (interface{}, error)
• func FindMachineWord(d *KWG, word tilemapping.MachineWord) bool
• func FindWord(d *KWG, word string) bool
• type KWG
  • func Get(cfg *config.Config, name string) (*KWG, error)
  • func LoadKWG(cfg *config.Config, filename string) (*KWG, error)
  • func ScanKWG(data io.Reader) (*KWG, error)
  • func (k *KWG) Accepts(nodeIdx uint32) bool
  • func (k *KWG) ArcIndex(nodeIdx uint32) uint32
  • func (k *KWG) CountWords()
  • func (k KWG) GetAlphabet() *tilemapping.TileMapping
  • func (k *KWG) GetLetterSet(nodeIdx uint32) tilemapping.LetterSet
  • func (k *KWG) GetRootNodeIndex() uint32
  • func (k *KWG) GetWordIndexOf(nodeIdx uint32, letters tilemapping.MachineWord) int32
  • func (k *KWG) InLetterSet(letter tilemapping.MachineLetter, nodeIdx uint32) bool
  • func (k *KWG) IsEnd(nodeIdx uint32) bool
  • func (k *KWG) LexiconName() string
  • func (k *KWG) NextNodeIdx(nodeIdx uint32, letter tilemapping.MachineLetter) uint32
  • func (k *KWG) Tile(nodeIdx uint32) uint8
• type KWGAnagrammer
  • func (da *KWGAnagrammer) Anagram(dawg *KWG, f func(tilemapping.MachineWord) error) error
  • func (da *KWGAnagrammer) InitForMachineWord(kwg *KWG, machineTiles tilemapping.MachineWord) error
  • func (da *KWGAnagrammer) InitForString(kwg *KWG, tiles string) error
  • func (da *KWGAnagrammer) IsValidJumble(dawg *KWG, word tilemapping.MachineWord) (bool, error)
  • func (da *KWGAnagrammer) Subanagram(dawg *KWG, f func(tilemapping.MachineWord) error) error
  • func (da *KWGAnagrammer) Superanagram(dawg *KWG, f func(tilemapping.MachineWord) error) error
• type Lexicon
  • func (l Lexicon) HasAnagram(word tilemapping.MachineWord) bool
  • func (l Lexicon) HasWord(word tilemapping.MachineWord) bool
  • func (l Lexicon) Name() string

Constants

const (
	CacheKeyPrefix = "kwg:"
)

Functions

func CacheLoadFunc

func CacheLoadFunc(cfg *config.Config, key string) (interface{}, error)

CacheLoadFunc is the function that loads an object into the global cache.

func FindMachineWord

func FindMachineWord(d *KWG, word tilemapping.MachineWord) bool

FindMachineWord finds a word in a LWG

func FindWord

func FindWord(d *KWG, word string) bool

FindWord finds a word in a KWG

Types

type KWG

type KWG struct {
	// contains filtered or unexported fields
}

A KWG is a Kurnia Word Graph. More information is available here: https://github.com/andy-k/wolges/blob/main/details.txt Thanks to Andy Kurnia.

func Get

func Get(cfg *config.Config, name string) (*KWG, error)

Get loads a named KWG from the cache or from a file

func LoadKWG

func LoadKWG(cfg *config.Config, filename string) (*KWG, error)

func ScanKWG

func ScanKWG(data io.Reader) (*KWG, error)

func (*KWG) Accepts

func (k *KWG) Accepts(nodeIdx uint32) bool

func (*KWG) ArcIndex

func (k *KWG) ArcIndex(nodeIdx uint32) uint32

func (*KWG) CountWords

func (k *KWG) CountWords()

func (KWG) GetAlphabet

func (k KWG) GetAlphabet() *tilemapping.TileMapping

func (*KWG) GetLetterSet

func (k *KWG) GetLetterSet(nodeIdx uint32) tilemapping.LetterSet

func (*KWG) GetRootNodeIndex

func (k *KWG) GetRootNodeIndex() uint32

func (*KWG) GetWordIndexOf

func (k *KWG) GetWordIndexOf(nodeIdx uint32, letters tilemapping.MachineWord) int32

func (*KWG) InLetterSet

func (k *KWG) InLetterSet(letter tilemapping.MachineLetter, nodeIdx uint32) bool

func (*KWG) IsEnd

func (k *KWG) IsEnd(nodeIdx uint32) bool

func (*KWG) LexiconName

func (k *KWG) LexiconName() string

func (*KWG) NextNodeIdx

func (k *KWG) NextNodeIdx(nodeIdx uint32, letter tilemapping.MachineLetter) uint32

func (*KWG) Tile

func (k *KWG) Tile(nodeIdx uint32) uint8

type KWGAnagrammer

type KWGAnagrammer struct {
	// contains filtered or unexported fields
}

zero value works. not threadsafe.

func (*KWGAnagrammer) Anagram

func (da *KWGAnagrammer) Anagram(dawg *KWG, f func(tilemapping.MachineWord) error) error

func (*KWGAnagrammer) InitForMachineWord

func (da *KWGAnagrammer) InitForMachineWord(kwg *KWG, machineTiles tilemapping.MachineWord) error

func (*KWGAnagrammer) InitForString

func (da *KWGAnagrammer) InitForString(kwg *KWG, tiles string) error

func (*KWGAnagrammer) IsValidJumble

func (da *KWGAnagrammer) IsValidJumble(dawg *KWG, word tilemapping.MachineWord) (bool, error)

checks if a word with no blanks has any valid anagrams.

func (*KWGAnagrammer) Subanagram

func (da *KWGAnagrammer) Subanagram(dawg *KWG, f func(tilemapping.MachineWord) error) error

func (*KWGAnagrammer) Superanagram

func (da *KWGAnagrammer) Superanagram(dawg *KWG, f func(tilemapping.MachineWord) error) error

type Lexicon

type Lexicon struct {
	KWG
}

func (Lexicon) HasAnagram

func (l Lexicon) HasAnagram(word tilemapping.MachineWord) bool

func (Lexicon) HasWord

func (l Lexicon) HasWord(word tilemapping.MachineWord) bool

func (Lexicon) Name

func (l Lexicon) Name() string