A two-way one-to-one lookup for .NET Standard. Like a dictionary, but indexed both ways.
Get Started
$ dotnet add package BidirectionalMapReadme
Bidirectional Map
Exactly what it sounds like. This library offers a single class BiMap that let's you define a two-way one-to-one map between values
the same way you would define a one-way map with a dictionary.
Example:
using BidirectionalMap;
BiMap<int, string> map = new BiMap<int, string>(){
{1, "Circle"},
{2, "Triangle"},
{3, "Square"},
};
var mappedString = map.Forward[1]; //"Circle"
var mappedInt = map.Reverse["Circle"]; // 1
Why?
Well, table-driven value mapping is a very powerfull technique that makes conversions more readable, easier to update, and easier to load from non-code sources.
Some common scenarios for this kind of technique include
- Mapping to some kind of storage (say, converting between enum and string)
- Mapping display values to and from requests
- Wrapping other code (adapter-style) to consume their api on your own terms
- Choosing an action or configuration based on some kind of type value (this is usually just one-way though)
Install
Available via nuget at https://www.nuget.org/packages/BidirectionalMap/
Feedback/Bugs/Contribution
Feel free to open an issue to start the conversation.