mirror of https://github.com/emirpasic/gods
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
1.3 KiB
Go
41 lines
1.3 KiB
Go
// Copyright (c) 2015, Emir Pasic. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Package maps provides an abstract Map interface.
|
|
//
|
|
// In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears just once in the collection.
|
|
//
|
|
// Operations associated with this data type allow:
|
|
// - the addition of a pair to the collection
|
|
// - the removal of a pair from the collection
|
|
// - the modification of an existing pair
|
|
// - the lookup of a value associated with a particular key
|
|
//
|
|
// Reference: https://en.wikipedia.org/wiki/Associative_array
|
|
package maps
|
|
|
|
import "github.com/emirpasic/gods/v2/containers"
|
|
|
|
// Map interface that all maps implement
|
|
type Map[K comparable, V any] interface {
|
|
Put(key K, value V)
|
|
Get(key K) (value V, found bool)
|
|
Remove(key K)
|
|
Keys() []K
|
|
|
|
containers.Container[V]
|
|
// Empty() bool
|
|
// Size() int
|
|
// Clear()
|
|
// Values() []interface{}
|
|
// String() string
|
|
}
|
|
|
|
// BidiMap interface that all bidirectional maps implement (extends the Map interface)
|
|
type BidiMap[K comparable, V comparable] interface {
|
|
GetKey(value V) (key K, found bool)
|
|
|
|
Map[K, V]
|
|
}
|