[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# soundex(n) 1.1 tcllib "Soundex"

## Name

soundex - Soundex

## Synopsis

- package require Tcl 8.5 9
- package require soundex ?1.1?

- ::soundex::knuth string

## Description

This package provides soundex algorithms which allow the comparison of words based on their phonetic likeness.

Currently only an algorithm by Knuth is provided, which is tuned to english names and words.

::soundex::knuth string

  Computes the soundex code of the input string using Knuth's algorithm and returns it as the result of the command.

## EXAMPLES

        % ::soundex::knuth Knuth
        K530

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category soundex of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## Keywords

knuth, soundex, text comparison, text likeness

## Category

Hashes, checksums, and encryption

## Copyright

Copyright © ????, Algorithm: Donald E. Knuth
Copyright © 2003, Documentation: Andreas Kupries <andreas_kupries@users.sourceforge.net>
Copyright © 1998, Tcl port: Evan Rempel <erempel@uvic.ca>