Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 2 KB

README.md

File metadata and controls

101 lines (70 loc) · 2 KB
Raw

Table of contents

BiMap

  • A one-to-one relationship between "left" and "right" is maintained when updating, adding and deleting.
  • Quick modification and access to "left" and "right" are possible.
  • Duplication is not allowed for the same "left" and "right".

Term Explanation

There is basically no priority between "left" and "right". At the developer's discretion, they can be prioritized conceptually.

  • left: This value is used as the left key in the BiMap. Each left can only be mapped to a single right. You can use the left to look up or delete the corresponding right.

  • right: This value is used as the right key in the BiMap. Each right can only be mapped to a single left. You can use the right to look up or delete the corresponding left.

Usage

create instance

  • Set type of left and right with generic<L, R>.
  • Default type is any.
const myMap = new BiMap<string, number>();

set

  • Add or update the pair.
myMap.set("a", 10);

delete

  • Delete the pair.
myMap.set("a", 10);
myMap.set("b", 5);
myMap.deleteByLeft("a"); // delete "a" & 10
myMap.deleteByRight(5); // delete "b" & 5

get

  • Gets the value in the opposite direction.
myMap.set("a", 10);
myMap.getByLeft("a"); // 10
myMap.getByRight(10); // a

has

  • Check if a value exists.
const myMap = new BiMap<string, number>();
myMap.set("a", 10);
myMap.hasByLeft("a"); // true
myMap.hasByRight(20); // false

clear

  • Clear all data.
myMap.clear();

size

  • One pair size.
const myMap = new BiMap<string, number>();
myMap.set("a", 10);
myMap.set("b", 5);
myMap.size(); // 2

get member variables

  • Get "readonly" member variables.
  • Modification may result in unexpected behavior.
myMap.getLeftToRight();
myMap.getRightToLeft();