soundex(3tcl)

📦
version 2.0 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ soundex — bestie edition 💖

okay so this is soundex(3tcl), aka section 3tcl of the manual, and it's literally all about matching words by how they sound, not how they're spelled. obsessed. 🎀

🌸 NAME 🌸

soundex — Soundex. that's it, that's the name, no notes. 💅

🦋 SYNOPSIS 🦋

package require Tcl 8.5 9

package require soundex ?1.1?

::soundex::knuth string

so you need Tcl 8.5 or 9 (yes, both, the package is flexible like that 💜), you pull in the soundex package, and the version is optional — it'll take 1.1 if you wanna be specific. 🫶

👑 DESCRIPTION 👑

this package hands you soundex algorithms, and the whole point of them is that you can compare words based on their phonetic likeness — like, do these two words sound the same? not "are they spelled the same?" it's giving vibes-based linguistics, no cap. 🗣️✨

right now there's exactly one algorithm in here, and it's the one by Knuth. it's tuned for english names and english words specifically, so don't come at it with your multilingual chaos and expect it to slay. 🧚

  • ::soundex::knuth string — computes the soundex code of the input string using Knuth's algorithm and returns it as the result of the command. that's the whole thing. it's a one-trick pony but the trick is iconic. 💅

🔥 EXAMPLES 🔥

look at this, look at her go:

% ::soundex::knuth Knuth
K530

Knuth in, K530 out. literally the main character of phonetic codes. ⭐

😭 BUGS, IDEAS, FEEDBACK 😭

real talk bestie, this document and the package it describes will undoubtedly contain bugs and other problems. it's not a maybe, it's a will. no cap. 🙈

please report such bugs in the category soundex of the Tcllib Trackers:

http://core.tcl.tk/tcllib/reportlist

and please also report any ideas for enhancements you might have — for the package and/or the documentation. we want both, fr fr. 🫶

when you're proposing code changes, please provide unified diffs, i.e. the output of diff -u. that's the format. periodt. 🎀

also note, and this one matters: attachments are strongly preferred over inlined patches. you can make an attachment 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. iykyk. 💜

💀 KEYWORDS 💀

  • knuth
  • soundex
  • text comparison
  • text likeness

🌈 CATEGORY 🌈

Hashes, checksums, and encryption — yes she lives there, yes it's a bit of a weird neighborhood for a phonetics girlie, we don't make the rules. 💅

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

okay that's the whole page, bestie, you're officially soundex-pilled. 🍓✨ this was tcllib version 1.1, dated with the manual page soundex(3tcl) — go forth and phonetically match some names, ily, bye! 👑💜

📦 where this page comes from