multimap

KO | EN

gitlite — search

#llm #go #machine-learning #rust #deep-learning #docker #windows #cli #vue #pytorch #security #openai #ios #open-source

(★ 43)

A map in which more than one value may be stored under each key.

multimap Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MultiMap

The [multimap][1] data structure is a map in which more than one value may be stored under each key.

[1]: https://en.wikipedia.org/wiki/Multimap

## Installation

```
$ npm install @github/multimap
```

## Usage

```js
import MultiMap from '@github/multimap'
```

```ts
const map = new MultiMap<string, number>()
map.set('a', 1)
map.set('a', 2)
map.get('a') // => Set([1, 2])
map.has('a') // => true
map.size // => 1
```

### Constructors

- `MultiMap()` - Create an empty map.
- `MultiMap(iterable)` - Create a map with values from an iterable yielding key value pairs: `new MultiMap([['k', 1], ['k', 2]])`

### Methods

- `get(key)` - Retrieve the Set of values stored under a key or the empty Set if the key does not exist.
- `set(key, value)` - Add a value to the key's set without removing previous values. Returns the map so `set` can be chained.
- `has(key)` - Returns true if a value is stored under the key.
- `delete(key)` - Remove key and all of key's values. Returns true if the key existed.
- `delete(key, value)` - Remove a value from the key's set. Returns true if the key and value existed.
- `drain(value)` - Remove a value from all keys that reference it. Returns an array of keys removed.
- `clear()` - Remove all keys and values to empty the map.
- `keys()` - An iterator of map keys.
- `values()` - An iterator of Sets of values for all keys.
- `entries()` - An iterator of [key, Set<value>] pairs.

### Properties

- `size` - The number of keys in the map.

## Development

```
npm install
npm test
```

## License

Distributed under the MIT license. See LICENSE for details.

multimap

multimap Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

multimap

multimap Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README