doc: update document for datetime package

README.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.7-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)

README_zh-CN.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.7-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)

datastructure/hashmap/hashmap.go

@@ -93,6 +93,46 @@ func (hm *HashMap) Contains(key any) bool {
 	return node != nil
 }
 
+// Iterate executes iteratee funcation for every key and value pair of hashmap (random order)
+func (hm *HashMap) Iterate(iteratee func(key, value any)) {
+	if hm.size > 0 {
+		for i := 0; i < len(hm.table); i++ {
+			item := hm.table[i]
+			if item != nil {
+				iteratee(item.key, item.value)
+			}
+		}
+	}
+}
+
+// Keys returns a slice of the hashmap's keys (random order)
+func (hm *HashMap) Keys() []any {
+	keys := make([]any, int(hm.size))
+	index := 0
+	if hm.size > 0 {
+		hm.Iterate(func(key, value any) {
+			keys[index] = key
+			index++
+		})
+	}
+
+	return keys
+}
+
+// Values returns a slice of the hashmap's keys (random order)
+func (hm *HashMap) Values() []any {
+	values := make([]any, int(hm.size))
+	index := 0
+	if hm.size > 0 {
+		hm.Iterate(func(key, value any) {
+			values[index] = value
+			index++
+		})
+	}
+
+	return values
+}
+
 func (hm *HashMap) resize() {
 	hm.capacity <<= 1
 

datastructure/hashmap/hashmap_test.go

@@ -52,3 +52,20 @@ func TestHashMap_Contains(t *testing.T) {
 	hm.Put("abc", 3)
 	assert.Equal(true, hm.Contains("abc"))
 }
+
+func TestHashMap_KeysValues(t *testing.T) {
+	assert := internal.NewAssert(t, "TestHashMap_KeysValues")
+
+	hm := NewHashMap()
+
+	hm.Put("a", 1)
+	hm.Put("b", 2)
+	hm.Put("c", 3)
+
+	keys := hm.Keys()
+	values := hm.Values()
+	t.Log(keys, values)
+
+	assert.Equal(3, len(values))
+	assert.Equal(3, len(keys))
+}

docs/datastructure/hashmap.md

@@ -29,6 +29,9 @@ import (
 - [Put](#Put)
 - [Delete](#Delete)
 - [Contains](#Contains)
+- [Iterate](#Iterate)
+- [Keys](#Keys)
+- [Values](#Values)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -207,3 +210,105 @@ func main() {
     fmt.Println(hm.Contains("b")) //false
 }
 ```
+
+
+
+### <span id="Iterate">Iterate</span>
+
+<p>Executes iteratee funcation for every key and value pair of hashmap.</p>
+
+<b>Signature:</b>
+
+```go
+func (hm *HashMap) Iterate(iteratee func(key, value any))
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    hm.Iterate(func(key, value any) {
+        fmt.Println(key)
+        fmt.Println(value)
+    })
+}
+```
+
+
+
+### <span id="Keys">Keys</span>
+
+<p>Return a slice of the hashmap's keys (random order).</p>
+
+<b>Signature:</b>
+
+```go
+func (hm *HashMap) Keys() []any
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    keys := hm.Keys()
+    fmt.Println(keys) //[]interface{"a", "b", "c"}
+}
+```
+
+
+### <span id="Values">Values</span>
+
+<p>Return a slice of the hashmap's values (random order).</p>
+
+<b>Signature:</b>
+
+```go
+func (hm *HashMap) Values() []any
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    values := hm.Values()
+    fmt.Println(values) //[]interface{2, 1, 3}
+}
+```
+
+

docs/datastructure/hashmap_zh-CN.md

@@ -24,11 +24,13 @@ import (
 
 - [NewHashMap](#NewHashMap)
 - [NewHashMapWithCapacity](#NewHashMapWithCapacity)
-
 - [Get](#Get)
 - [Put](#Put)
 - [Delete](#Delete)
 - [Contains](#Contains)
+- [Iterate](#Iterate)
+- [Keys](#Keys)
+- [Values](#Values)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -203,3 +205,104 @@ func main() {
     fmt.Println(hm.Contains("b")) //false
 }
 ```
+
+
+### <span id="Iterate">Iterate</span>
+
+<p>迭代hashmap，对每个key和value执行iteratee函数</p>
+
+<b>函数签名:</b>
+
+```go
+func (hm *HashMap) Iterate(iteratee func(key, value any))
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    hm.Iterate(func(key, value any) {
+        fmt.Println(key)
+        fmt.Println(value)
+    })
+}
+```
+
+
+
+### <span id="Keys">Keys</span>
+
+<p>返回hashmap所有key的切片 (随机顺序)</p>
+
+<b>函数签名:</b>
+
+```go
+func (hm *HashMap) Keys() []any
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    keys := hm.Keys()
+    fmt.Println(keys) //[]interface{"a", "b", "c"}
+}
+```
+
+
+### <span id="Values">Values</span>
+
+<p>返回hashmap所有值的切片 (随机顺序).</p>
+
+<b>函数签名:</b>
+
+```go
+func (hm *HashMap) Values() []any
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+
+    values := hm.Values()
+    fmt.Println(values) //[]interface{2, 1, 3}
+}
+```
+
+

docs/datetime.md

@@ -251,7 +251,7 @@ func main() {
 <b>Signature:</b>
 
 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>Example:</b>
 
@@ -414,7 +414,7 @@ func main() {
 <b>Signature:</b>
 
 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>Example:</b>
 

docs/datetime_zh-CN.md

@@ -243,12 +243,12 @@ func main() {
 
 
 ### <span id="BeginOfWeek">BeginOfWeek</span>
-<p>返回指定时间的星期开始时间</p>
+<p>返回指定时间的每周开始时间,默认开始时间星期日</p>
 
 <b>函数签名:</b>
 
 ```go
-func BeginOfWeek(t time.Time) time.Time
+func BeginOfWeek(t time.Time, beginFrom ...time.Weekday) time.Time
 ```
 <b>例子:</b>
 
@@ -406,12 +406,12 @@ func main() {
 
 
 ### <span id="EndOfWeek">EndOfWeek</span>
-<p>返回指定时间的星期结束时间</p>
+<p>返回指定时间的星期结束时间,默认结束时间星期六</p>
 
 <b>函数签名:</b>
 
 ```go
-func EndOfWeek(t time.Time) time.Time
+func EndOfWeek(t time.Time, endWith ...time.Weekday) time.Time
 ```
 <b>例子:</b>