Mnemonizer 0.1.0

dotnet add package Mnemonizer --version 0.1.0
                    
NuGet\Install-Package Mnemonizer -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Mnemonizer" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Mnemonizer" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Mnemonizer" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Mnemonizer --version 0.1.0
                    
#r "nuget: Mnemonizer, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Mnemonizer@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Mnemonizer&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Mnemonizer&version=0.1.0
                    
Install as a Cake Tool

Mnemonizer

A .NET library that maps opaque system identifiers (GUIDs, database keys, etc.) to memorable, deterministic aliases in the form adjective-adjective-noun (e.g. bright-quick-falcon).

Designed for LLM tool-call pipelines where raw IDs waste context tokens and confuse the model.

Installation

dotnet add package Mnemonizer

Targets netstandard2.0 and net10.0.

Quick start

var mapper = new MnemonicDictionary<string>();

// Map an ID to a readable alias
string alias = mapper.GetOrAddAlias("usr_8f3a2b1c");
// e.g. "bright-quick-falcon"

// Same ID always returns the same alias
mapper.GetOrAddAlias("usr_8f3a2b1c"); // "bright-quick-falcon"

// Reverse lookup
if (mapper.TryGetId(alias, out var id))
{
    // id == "usr_8f3a2b1c"
}
let mapper = MnemonicDictionary<string>()

let alias = mapper.GetOrAddAlias("usr_8f3a2b1c")

let mutable id = Unchecked.defaultof<string>
if mapper.TryGetId(alias, &id) then
    printfn $"Resolved: {id}"

How it works

  1. The identifier's hash code is bit-packed into three indices (11 + 11 + 10 = 32 bits) selecting from 2048 adjectives and 1024 nouns, yielding ~4 billion unique aliases.
  2. Hash collisions are resolved via linear probing.
  3. Aliases are cached after first generation -- repeated lookups are zero-allocation.
  4. Reverse lookups (TryGetId) parse the alias back into indices and reconstruct the internal key, which is then used to look up the original ID in the internal dictionary in O(1) time.

Thread safety

MnemonicDictionary<T> is fully thread-safe. All mutable state is managed through ConcurrentDictionary with lock-free atomic operations. Multiple threads may call GetOrAddAlias and TryGetId concurrently without external synchronization.

Performance

Both hot paths are zero-allocation on .NET 9+:

  • GetOrAddAlias (existing ID): returns a cached string reference, ~15ns per call.
  • TryGetId: parses the alias using ReadOnlySpan<char> slicing and FrozenDictionary.AlternateLookup -- no string splits, no intermediate allocations, ~40ns per call.

On netstandard2.0, GetOrAddAlias is still zero-allocation for cached lookups. TryGetId falls back to string.Split which allocates.

Important: aliases are ephemeral

Aliases are scoped to a single MnemonicDictionary<T> instance. The same identifier may produce a different alias:

  • Across processes -- .NET randomizes string.GetHashCode() by default, so hash codes differ between runs.
  • Within the same process -- if identifiers are inserted in a different order, linear probing for hash collisions may assign different slots.

Do not persist, serialize, or transmit aliases. They are designed for in-memory, single-session use (e.g. the lifetime of an LLM conversation).

Note: For int keys, aliases are fully deterministic — int.GetHashCode() is the identity function, so there are no collisions and no insertion-order dependence. Other types with deterministic hash codes (long, Guid, etc.) will also produce stable aliases across instances, provided there are no hash collisions. The randomization caveat is primarily about string on .NET Core+.

Custom word lists and hashing

The parameterless constructor uses built-in word lists embedded in the assembly and hashing with EqualityComparer<T>.Default. To supply your own:

string[] adjectives = ...; // exactly 2048 entries
string[] nouns = ...;      // exactly 1024 entries
IEqualityComparer<T> keyComparer = ...

var mapper = new MnemonicDictionary<T>(adjectives, nouns, keyComparer);

Word lookups are case-insensitive.

License

See LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net10.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 110 3/28/2026