subword

Documentation

Overview

Package subword implements a word replacement with a level.

Index

• type Builder
  • func NewBuilder(subwords []Subword) *Builder
  • func (b *Builder) Reset()
  • func (b *Builder) String() string
  • func (b *Builder) Subwords() []Subword
  • func (b *Builder) Write(subwords ...Subword)
• type Replacement
  • func NewReplacement(start, stop int, word string) Replacement
  • func (r Replacement) String() string
• type Replacer
  • func NewReplacer(word string, prevLevel, nextLevel int) *Replacer
  • func (r *Replacer) Replace(start, stop int, word string)
  • func (r *Replacer) ReplaceBy(repls ...Replacement)
  • func (r *Replacer) String() string
  • func (r *Replacer) Subwords() []Subword
• type Subword
  • func New(word string, level int) Subword

Types

type Builder

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

Builder is a buffer to build a []Subword array.

func NewBuilder

func NewBuilder(subwords []Subword) *Builder

NewBuilder creates a Builder from subwords.

func (*Builder) Reset

func (b *Builder) Reset()

Reset discards the underlying subwords.

func (*Builder) String

func (b *Builder) String() string

String() concatenates buffered subwords to assemble the full word.

func (*Builder) Subwords

func (b *Builder) Subwords() []Subword

Subwords builds the buffered subwords into a []Subword array. It merges adjoin subwords if they share the same level.

func (*Builder) Write

func (b *Builder) Write(subwords ...Subword)

Write extends the underlying subwords by the given ones.

type Replacement

type Replacement struct {
	Start int
	Stop  int
	Word  string
}

Replacement is a deferred sw Replacement.

func NewReplacement

func NewReplacement(start, stop int, word string) Replacement

NewReplacement creates a Replacement.

func (Replacement) String

func (r Replacement) String() string

type Replacer

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

Replacer remembers replacements in a buffer. Finally, it applies the replacements and splits the result in several subwords.

func NewReplacer

func NewReplacer(word string, prevLevel, nextLevel int) *Replacer

NewReplacer creates a SubwordReplacer for a word.

func (*Replacer) Replace

func (r *Replacer) Replace(start, stop int, word string)

Replace buffers a replacement.

func (*Replacer) ReplaceBy

func (r *Replacer) ReplaceBy(repls ...Replacement)

ReplaceBy buffers multiple replacements.

func (*Replacer) String

func (r *Replacer) String() string

String applies the buffered replacements and returns the replaced full word.

func (*Replacer) Subwords

func (r *Replacer) Subwords() []Subword

Subwords applies the buffered replacements and returns the replaced word as a []Subword array.

type Subword

type Subword struct {
	Word  string
	Level int
}

Subword is a chunk of a word with a level number. The level indicates which step in the procedure generated this sw.

func New

func New(word string, level int) Subword

New creates a Subword.