anagrammer

Documentation

Overview

Package anagrammer uses a DAWG instead of a GADDAG to simplify the algorithm and make it potentially faster - we don't need a GADDAG to generate anagrams/subanagrams.

This package generates anagrams and subanagrams and has an RPC interface.

blank_challenges has utilities for generating racks with blanks that have 1 or more solutions.

Index

• Constants
• Variables
• func Anagram(letters string, gd *gaddag.SimpleGaddag, mode AnagramMode) []string
• func LoadDawgs(dawgPath string)
• type AnagramMode
• type AnagramService
  • func (a *AnagramService) Anagram(r *http.Request, args *AnagramServiceArgs, reply *AnagramServiceReply) error
  • func (a *AnagramService) BlankChallenge(r *http.Request, args *BlankChallengeArgs, reply *BlankChallengeReply) error
  • func (a *AnagramService) BuildChallenge(r *http.Request, args *BuildChallengeArgs, reply *BuildChallengeReply) error
• type AnagramServiceArgs
• type AnagramServiceReply
• type AnagramStruct
• type BlankChallengeArgs
• type BlankChallengeReply
• type BuildChallengeArgs
• type BuildChallengeReply
• type Question
  • func GenerateBlanks(ctx context.Context, args *BlankChallengeArgs, dawg *gaddag.SimpleGaddag) ([]*Question, int, error)
  • func GenerateBuildChallenge(ctx context.Context, args *BuildChallengeArgs, dawg *gaddag.SimpleGaddag) (*Question, int, error)

Constants

const BlankPos = alphabet.MaxAlphabetSize

Variables

var AuthorizationKey = os.Getenv("AUTH_KEY")

AuthorizationKey is used for non-user exposed methods

var Dawgs map[string]*gaddag.SimpleGaddag

Functions

func Anagram

func Anagram(letters string, gd *gaddag.SimpleGaddag, mode AnagramMode) []string

func LoadDawgs

func LoadDawgs(dawgPath string)

Types

type AnagramMode

type AnagramMode int

const (
	ModeBuild AnagramMode = iota
	ModeExact
	ModePattern
)

type AnagramService

type AnagramService struct{}

func (*AnagramService) Anagram

func (a *AnagramService) Anagram(r *http.Request, args *AnagramServiceArgs,
	reply *AnagramServiceReply) error

func (*AnagramService) BlankChallenge

func (a *AnagramService) BlankChallenge(r *http.Request, args *BlankChallengeArgs,
	reply *BlankChallengeReply) error

func (*AnagramService) BuildChallenge

func (a *AnagramService) BuildChallenge(r *http.Request, args *BuildChallengeArgs,
	reply *BuildChallengeReply) error

type AnagramServiceArgs

type AnagramServiceArgs struct {
	Lexicon   string `json:"lexicon"`
	Letters   string `json:"letters"`
	Mode      string `json:"mode"`
	AuthToken string `json:"authToken"`
}

type AnagramServiceReply

type AnagramServiceReply struct {
	Words    []string `json:"words"`
	NumWords int      `json:"numWords"`
}

type AnagramStruct

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

type BlankChallengeArgs

type BlankChallengeArgs struct {
	WordLength   int    `json:"wordLength"`
	NumQuestions int    `json:"numQuestions"`
	Lexicon      string `json:"lexicon"`
	MaxSolutions int    `json:"maxSolutions"`
	// How many to generate with 2 blanks (default is 1)
	Num2Blanks int `json:"num2Blanks"`
}

type BlankChallengeReply

type BlankChallengeReply struct {
	Questions    []*Question `json:"questions"`
	NumQuestions int         `json:"numQuestions"`
	NumAnswers   int         `json:"numAnswers"`
}

type BuildChallengeArgs

type BuildChallengeArgs struct {
	WordLength            int    `json:"wordLength"`
	MinWordLength         int    `json:"minWordLength"`
	RequireLengthSolution bool   `json:"requireLengthSolution"`
	Lexicon               string `json:"lexicon"`
	MinSolutions          int    `json:"minSolutions"`
	MaxSolutions          int    `json:"maxSolutions"`
}

type BuildChallengeReply

type BuildChallengeReply struct {
	Question   *Question `json:"question"`
	NumAnswers int       `json:"numAnswers"`
}

type Question

type Question struct {
	Q string   `json:"q"`
	A []string `json:"a"`
}

func GenerateBlanks

func GenerateBlanks(ctx context.Context, args *BlankChallengeArgs,
	dawg *gaddag.SimpleGaddag) ([]*Question, int, error)

GenerateBlanks - Generate a list of blank word challenges given the parameters in args.

func GenerateBuildChallenge

func GenerateBuildChallenge(ctx context.Context, args *BuildChallengeArgs,
	dawg *gaddag.SimpleGaddag) (*Question, int, error)

GenerateBuildChallenge generates a build challenge with given args. As an additional condition, letters must anagram exactly to at least one word, if that argument is passed in.