libvarnam

Documentation

Index

• func GetSchemeFileDirectory() string
• type CorpusDetails
• type LearnStatus
• type SchemeDetails
  • func GetAllSchemeDetails() []*SchemeDetails
• type Varnam
  • func Init(schemeIdentifier string) (*Varnam, error)
  • func (v *Varnam) DeleteWord(text string) error
  • func (v *Varnam) Destroy()
  • func (v *Varnam) GetCorpusDetails() (*CorpusDetails, error)
  • func (v *Varnam) GetSchemeFilePath() string
  • func (v *Varnam) GetSuggestionsFilePath() string
  • func (v *Varnam) ImportFromFile(filePath string) error
  • func (v *Varnam) Learn(text string) error
  • func (v *Varnam) LearnFromFile(filePath string) (*LearnStatus, error)
  • func (v *Varnam) ReverseTransliterate(text string) (string, error)
  • func (v *Varnam) Train(pattern, word string) error
  • func (v *Varnam) Transliterate(text string) ([]string, error)
• type VarnamError
  • func (e *VarnamError) Error() string

Functions

func GetSchemeFileDirectory

func GetSchemeFileDirectory() string

GetSchemeFileDirectory returns the folder where scheme file (.vst) are stored

Types

type CorpusDetails

type CorpusDetails struct {
	WordsCount int `json:"wordsCount"`
}

CorpusDetails returns corpus details.

type LearnStatus

type LearnStatus struct {
	TotalWords int
	Failed     int
}

LearnStatus .

type SchemeDetails

type SchemeDetails struct {
	LangCode     string
	Identifier   string
	DisplayName  string
	Author       string
	CompiledDate string
	IsStable     bool
}

SchemeDetails returns language and other changes.

func GetAllSchemeDetails

func GetAllSchemeDetails() []*SchemeDetails

GetAllSchemeDetails returns all scheme related details.

type Varnam

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

Varnam app binding.

func Init

func Init(schemeIdentifier string) (*Varnam, error)

Init initializes varnam bindings.

func (*Varnam) DeleteWord

func (v *Varnam) DeleteWord(text string) error

DeleteWord from given input text.

func (*Varnam) Destroy

func (v *Varnam) Destroy()

Destroy closes handle.

func (*Varnam) GetCorpusDetails

func (v *Varnam) GetCorpusDetails() (*CorpusDetails, error)

GetCorpusDetails will return corpus details.

func (*Varnam) GetSchemeFilePath

func (v *Varnam) GetSchemeFilePath() string

GetSchemeFilePath returns the scheme file (.vst)

func (*Varnam) GetSuggestionsFilePath

func (v *Varnam) GetSuggestionsFilePath() string

GetSuggestionsFilePath returns suggestions.

func (*Varnam) ImportFromFile

func (v *Varnam) ImportFromFile(filePath string) error

ImportFromFile Import learnigns from file (varnam exported file)

func (*Varnam) Learn

func (v *Varnam) Learn(text string) error

Learn from given input text.

func (*Varnam) LearnFromFile

func (v *Varnam) LearnFromFile(filePath string) (*LearnStatus, error)

LearnFromFile learns from file from the given filepath.

func (*Varnam) ReverseTransliterate

func (v *Varnam) ReverseTransliterate(text string) (string, error)

ReverseTransliterate given string.

func (*Varnam) Train

func (v *Varnam) Train(pattern, word string) error

Train methods adds a word with pattern, eg: pattern=firefox, word=ഫയർഫോക്സ്

func (*Varnam) Transliterate

func (v *Varnam) Transliterate(text string) ([]string, error)

Transliterate given string to corresponding language.

type VarnamError

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

VarnamError satisfies error interface.

func (*VarnamError) Error

func (e *VarnamError) Error() string