doc: add doc for OrderedMap

maputil/map_example_test.go

@@ -558,3 +558,277 @@ func ExampleSortByKey() {
 	// Output:
 	// map[1:a 2:b 3:c 4:d]
 }
+
+func ExampleOrderedMap_Set() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	val1, ok := om.Get("a")
+	fmt.Println(val1, ok)
+
+	val2, ok := om.Get("d")
+	fmt.Println(val2, ok)
+
+	// Output:
+	// 1 true
+	// 0 false
+}
+
+func ExampleOrderedMap_Get() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	val1, ok := om.Get("a")
+	fmt.Println(val1, ok)
+
+	val2, ok := om.Get("d")
+	fmt.Println(val2, ok)
+
+	// Output:
+	// 1 true
+	// 0 false
+}
+
+func ExampleOrderedMap_Front() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	frontElement, ok := om.Front()
+	fmt.Println(frontElement)
+	fmt.Println(ok)
+
+	// Output:
+	// {a 1}
+	// true
+}
+
+func ExampleOrderedMap_Back() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	backElement, ok := om.Back()
+	fmt.Println(backElement)
+	fmt.Println(ok)
+
+	// Output:
+	// {c 3}
+	// true
+}
+
+func ExampleOrderedMap_Delete() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	om.Delete("b")
+
+	fmt.Println(om.Keys())
+
+	// Output:
+	// [a c]
+}
+
+func ExampleOrderedMap_Clear() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	om.Clear()
+
+	fmt.Println(om.Keys())
+
+	// Output:
+	// []
+}
+
+func ExampleOrderedMap_Len() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	om.Len()
+
+	fmt.Println(om.Len())
+
+	// Output:
+	// 3
+}
+
+func ExampleOrderedMap_Keys() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	keys := om.Keys()
+
+	fmt.Println(keys)
+
+	// Output:
+	// [a b c]
+}
+
+func ExampleOrderedMap_Values() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	values := om.Values()
+
+	fmt.Println(values)
+
+	// Output:
+	// [1 2 3]
+}
+
+func ExampleOrderedMap_Contains() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	result1 := om.Contains("a")
+	result2 := om.Contains("d")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+
+	// Output:
+	// true
+	// false
+}
+
+func ExampleOrderedMap_Range() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	om.Range(func(key string, value int) bool {
+		fmt.Println(key, value)
+		return true
+	})
+
+	// Output:
+	// a 1
+	// b 2
+	// c 3
+}
+
+func ExampleOrderedMap_Elements() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	elements := om.Elements()
+
+	fmt.Println(elements)
+
+	// Output:
+	// [{a 1} {b 2} {c 3}]
+}
+
+func ExampleOrderedMap_Iter() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	for elem := range om.Iter() {
+		fmt.Println(elem)
+	}
+
+	// Output:
+	// {a 1}
+	// {b 2}
+	// {c 3}
+}
+
+func ExampleOrderedMap_ReverseIter() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	for elem := range om.ReverseIter() {
+		fmt.Println(elem)
+	}
+
+	// Output:
+	// {c 3}
+	// {b 2}
+	// {a 1}
+}
+
+func ExampleOrderedMap_SortByKey() {
+	om := NewOrderedMap[int, string]()
+
+	om.Set(3, "c")
+	om.Set(1, "a")
+	om.Set(4, "d")
+	om.Set(2, "b")
+
+	om.SortByKey(func(a, b int) bool {
+		return a < b
+	})
+
+	fmt.Println(om.Elements())
+
+	// Output:
+	// [{1 a} {2 b} {3 c} {4 d}]
+}
+
+func ExampleOrderedMap_MarshalJSON() {
+	om := NewOrderedMap[string, int]()
+
+	om.Set("a", 1)
+	om.Set("b", 2)
+	om.Set("c", 3)
+
+	b, _ := om.MarshalJSON()
+
+	fmt.Println(string(b))
+
+	// Output:
+	// {"a":1,"b":2,"c":3}
+}
+
+func ExampleOrderedMap_UnmarshalJSON() {
+	om := NewOrderedMap[string, int]()
+
+	data := []byte(`{"a":1,"b":2,"c":3}`)
+
+	om.UnmarshalJSON(data)
+
+	fmt.Println(om.Elements())
+
+	// Output:
+	// [{a 1} {b 2} {c 3}]
+}