doc: add go playground demo

2026-02-04 12:52:28 +08:00 · 2024-03-06 15:28:55 +08:00
parent 1b31014f81
commit a6eaaef563
11 changed files with 127 additions and 26 deletions
--- a/docs/api/packages/datastructure/hashmap.md
+++ b/docs/api/packages/datastructure/hashmap.md
@@ -31,6 +31,7 @@ import (
 - [Iterate](#Iterate)
 - [Keys](#Keys)
 - [Values](#Values)
+- [FilterByValue](#FilterByValue)

 <div STYLE="page-break-after: always;"></div>

@@ -276,7 +277,7 @@ func main() {

 ### <span id="Values">Values</span>

-<p>返回hashmap所有值的切片 (随机顺序).</p>
+<p>返回hashmap所有值的切片 (随机顺序)。</p>

 <b>函数签名:</b>

@@ -306,3 +307,40 @@ func main() {
 ```


+### <span id="FilterByValue">FilterByValue</span>
+
+<p>返回一个过滤后的HashMap。 如果任何值与 perdicate 函数不匹配，则返回 nil，否则返回包含选定值的 HashMap。</p>
+
+<b>函数签名:</b>
+
+```go
+func (hm *HashMap) FilterByValue(perdicate func(value any) bool) *HashMap
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := hashmap.NewHashMap()
+
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+    hm.Put("d", 4)
+    hm.Put("e", 5)
+    hm.Put("f", 6)
+
+    filteredHM := hm.FilterByValue(func(value any) bool {
+        return value.(int) == 1 || value.(int) == 3
+    })
+
+    fmt.Println(filteredHM.Size()) //2
+}
+```
--- a/docs/api/packages/function.md
+++ b/docs/api/packages/function.md
@@ -424,7 +424,7 @@ func longRunningTask() {
 func And[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/dTBHJMQ0zD2)</span></b>

 ```go
 package main
@@ -461,7 +461,7 @@ func main() {
 func Or[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/LitCIsDFNDA)</span></b>

 ```go
 package main
@@ -496,7 +496,7 @@ func main() {
 func Negate[T any](predicate func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/jbI8BtgFnVE)</span></b>

 ```go
 package main
@@ -536,7 +536,7 @@ func main() {
 func Nor[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/2KdCoBEOq84)</span></b>

 ```go
 package main
@@ -578,7 +578,7 @@ func main() {
 func Nand[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/Rb-FdNGpgSO)</span></b>

 ```go
 package main
@@ -615,7 +615,7 @@ func main() {
 func Xnor[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/FJxko8SFbqc)</span></b>

 ```go
 package main
@@ -652,7 +652,7 @@ func main() {
 func AcceptIf[T any](predicate func(T) bool, apply func(T) T) func(T) (T, bool)
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/XlXHHtzCf7d)</span></b>

 ```go
 package main
@@ -663,9 +663,8 @@ import (
 )

 func main() {
-
-    adder := AcceptIf(
-        And(
+    adder := function.AcceptIf(
+        function.And(
            func(x int) bool {
                return x > 10
            }, func(x int) bool {
--- a/docs/api/packages/slice.md
+++ b/docs/api/packages/slice.md
@@ -2581,7 +2581,7 @@ func main() {
 func SetToDefaultIf[T any](slice []T, predicate func(T) bool) ([]T, int)
 ```

-<b>示例:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/9AXGlPRC0-A)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/datastructure/hashmap.md
+++ b/docs/en/api/packages/datastructure/hashmap.md
@@ -32,6 +32,7 @@ import (
 - [Iterate](#Iterate)
 - [Keys](#Keys)
 - [Values](#Values)
+- [FilterByValue](#FilterByValue)

 <div STYLE="page-break-after: always;"></div>

@@ -311,4 +312,42 @@ func main() {
 }
 ```

+### <span id="FilterByValue">FilterByValue</span>
+
+<p>Returns a filtered HashMap.</p>
+
+<b>Signature:</b>
+
+```go
+func (hm *HashMap) FilterByValue(perdicate func(value any) bool) *HashMap
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
+)
+
+func main() {
+    hm := hashmap.NewHashMap()
+
+    hm.Put("a", 1)
+    hm.Put("b", 2)
+    hm.Put("c", 3)
+    hm.Put("d", 4)
+    hm.Put("e", 5)
+    hm.Put("f", 6)
+
+    filteredHM := hm.FilterByValue(func(value any) bool {
+        return value.(int) == 1 || value.(int) == 3
+    })
+
+    fmt.Println(filteredHM.Size()) //2
+}
+```
+

--- a/docs/en/api/packages/function.md
+++ b/docs/en/api/packages/function.md
@@ -423,7 +423,7 @@ func longRunningTask() {
 func And[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/dTBHJMQ0zD2)</span></b>

 ```go
 package main
@@ -460,7 +460,7 @@ func main() {
 func Or[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/LitCIsDFNDA)</span></b>

 ```go
 package main
@@ -495,7 +495,7 @@ func main() {
 func Negate[T any](predicate func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/jbI8BtgFnVE)</span></b>

 ```go
 package main
@@ -535,7 +535,7 @@ func main() {
 func Nor[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/2KdCoBEOq84)</span></b>

 ```go
 package main
@@ -577,7 +577,7 @@ func main() {
 func Nand[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Rb-FdNGpgSO)</span></b>

 ```go
 package main
@@ -614,7 +614,7 @@ func main() {
 func Xnor[T any](predicates ...func(T) bool) func(T) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/FJxko8SFbqc)</span></b>

 ```go
 package main
@@ -643,9 +643,7 @@ func main() {

 ### <span id="AcceptIf">AcceptIf</span>

-<p>AcceptIf returns another function of the same signature as the apply function but also includes a bool value to indicate success or failure. 
-A predicate function that takes an argument of type T and returns a bool.
-An apply function that also takes an argument of type T and returns a modified value of the same type.</p>
+<p>AcceptIf returns another function of the same signature as the apply function but also includes a bool value to indicate success or failure. A predicate function that takes an argument of type T and returns a bool. An apply function that also takes an argument of type T and returns a modified value of the same type.</p>

 <b>Signature:</b>

@@ -653,7 +651,7 @@ An apply function that also takes an argument of type T and returns a modified v
 func AcceptIf[T any](predicate func(T) bool, apply func(T) T) func(T) (T, bool)
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/XlXHHtzCf7d)</span></b>

 ```go
 package main
@@ -665,8 +663,8 @@ import (

 func main() {

-    adder := AcceptIf(
-        And(
+    adder := function.AcceptIf(
+        function.And(
            func(x int) bool {
                return x > 10
            }, func(x int) bool {
--- a/docs/en/api/packages/slice.md
+++ b/docs/en/api/packages/slice.md
@@ -2577,7 +2577,7 @@ func main() {
 func SetToDefaultIf[T any](slice []T, predicate func(T) bool) ([]T, int)
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/9AXGlPRC0-A)</span></b>

 ```go
 import (