soundex

README

Soundex

Soundex is a go implementation of the Soundex algorithm.

"Soundex is a phonetic algorithm for indexing names by sound, as pronounced in English. The goal is for homophones to be encoded to the same representation so that they can be matched despite minor differences in spelling." - Wikipedia

Installation

$ go get github.com/umahmood/soundex

Usage

package main

import (
    "fmt"

    "github.com/umahmood/soundex"
)

func main() {
    fmt.Println(soundex.Code("Miller"))
    fmt.Println(soundex.Code("Muller"))
}

Output:

M460
M460

Documentation

http://godoc.org/github.com/umahmood/soundex

License

See the LICENSE file for license rights and limitations (MIT).

Documentation

Overview

Package soundex an implementation of the Soundex algorithm.

package main

import (
    "fmt"

    "github.com/umahmood/soundex"
)

func main() {
    fmt.Println(soundex.Code("Miller"))
    fmt.Println(soundex.Code("Muller"))
}

Index

• Constants
• func Code(word string) string
• func Version() string

Constants

const (
	Major = 1
	Minor = 0
	Patch = 1
)

Semantic versioning - http://semver.org/

Functions

func Code

func Code(word string) string

Code generates the soundex code for a given word

func Version

func Version() string

Version returns library version.