BidirectionalMap 1.0.0

A two-way one-to-one lookup for .NET Standard. Like a dictionary, but indexed both ways.

Install-Package BidirectionalMap -Version 1.0.0
dotnet add package BidirectionalMap --version 1.0.0
<PackageReference Include="BidirectionalMap" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BidirectionalMap --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Bidirectional Map

.NET Core

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

It isn't limited to value types

BiMap<int, Action> map = new BiMap<int, string>(){
	{1, () => /* do something*/},
};

var action = map.Forward[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 the 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

Will be available as a nuget package... pending upload

Feedback/Bugs/Contribution

Feel free to open an issue to start the conversation.

Bidirectional Map

.NET Core

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

It isn't limited to value types

BiMap<int, Action> map = new BiMap<int, string>(){
	{1, () => /* do something*/},
};

var action = map.Forward[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 the 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

Will be available as a nuget package... pending upload

Feedback/Bugs/Contribution

Feel free to open an issue to start the conversation.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.0 723 4/24/2020