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.
109 lines
2.8 KiB
Go
109 lines
2.8 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 linkedhashmap is a map that preserves insertion-order.
|
|
//
|
|
// It is backed by a hash table to store values and doubly-linked list to store ordering.
|
|
//
|
|
// Structure is not thread safe.
|
|
//
|
|
// Reference: http://en.wikipedia.org/wiki/Associative_array
|
|
package linkedhashmap
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/emirpasic/gods/v2/lists/doublylinkedlist"
|
|
"github.com/emirpasic/gods/v2/maps"
|
|
)
|
|
|
|
// Assert Map implementation
|
|
var _ maps.Map[string, int] = (*Map[string, int])(nil)
|
|
|
|
// Map holds the elements in a regular hash table, and uses doubly-linked list to store key ordering.
|
|
type Map[K comparable, V any] struct {
|
|
table map[K]V
|
|
ordering *doublylinkedlist.List[K]
|
|
}
|
|
|
|
// New instantiates a linked-hash-map.
|
|
func New[K comparable, V any]() *Map[K, V] {
|
|
return &Map[K, V]{
|
|
table: make(map[K]V),
|
|
ordering: doublylinkedlist.New[K](),
|
|
}
|
|
}
|
|
|
|
// Put inserts key-value pair into the map.
|
|
// Key should adhere to the comparator's type assertion, otherwise method panics.
|
|
func (m *Map[K, V]) Put(key K, value V) {
|
|
if _, contains := m.table[key]; !contains {
|
|
m.ordering.Append(key)
|
|
}
|
|
m.table[key] = value
|
|
}
|
|
|
|
// Get searches the element in the map by key and returns its value or nil if key is not found in tree.
|
|
// Second return parameter is true if key was found, otherwise false.
|
|
// Key should adhere to the comparator's type assertion, otherwise method panics.
|
|
func (m *Map[K, V]) Get(key K) (value V, found bool) {
|
|
value, found = m.table[key]
|
|
return value, found
|
|
}
|
|
|
|
// Remove removes the element from the map by key.
|
|
// Key should adhere to the comparator's type assertion, otherwise method panics.
|
|
func (m *Map[K, V]) Remove(key K) {
|
|
if _, contains := m.table[key]; contains {
|
|
delete(m.table, key)
|
|
index := m.ordering.IndexOf(key)
|
|
m.ordering.Remove(index)
|
|
}
|
|
}
|
|
|
|
// Empty returns true if map does not contain any elements
|
|
func (m *Map[K, V]) Empty() bool {
|
|
return m.Size() == 0
|
|
}
|
|
|
|
// Size returns number of elements in the map.
|
|
func (m *Map[K, V]) Size() int {
|
|
return m.ordering.Size()
|
|
}
|
|
|
|
// Keys returns all keys in-order
|
|
func (m *Map[K, V]) Keys() []K {
|
|
return m.ordering.Values()
|
|
}
|
|
|
|
// Values returns all values in-order based on the key.
|
|
func (m *Map[K, V]) Values() []V {
|
|
values := make([]V, m.Size())
|
|
count := 0
|
|
it := m.Iterator()
|
|
for it.Next() {
|
|
values[count] = it.Value()
|
|
count++
|
|
}
|
|
return values
|
|
}
|
|
|
|
// Clear removes all elements from the map.
|
|
func (m *Map[K, V]) Clear() {
|
|
clear(m.table)
|
|
m.ordering.Clear()
|
|
}
|
|
|
|
// String returns a string representation of container
|
|
func (m *Map[K, V]) String() string {
|
|
str := "LinkedHashMap\nmap["
|
|
it := m.Iterator()
|
|
for it.Next() {
|
|
str += fmt.Sprintf("%v:%v ", it.Key(), it.Value())
|
|
}
|
|
return strings.TrimRight(str, " ") + "]"
|
|
|
|
}
|