feat: add ContainAny (#338)

Co-authored-by: Jiawen <im@linjiawen.com>
2025-12-19 17:02:23 +08:00 · 2025-10-30 19:24:45 +08:00
parent fc624195c7
commit 350450bb67
7 changed files with 161 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1461,6 +1461,9 @@ import "github.com/duke-git/lancet/v2/slice"
 -   **<big>ContainSubSlice</big>** : check if the slice contain a given subslice or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#ContainSubSlice)]
    [[play](https://go.dev/play/p/bcuQ3UT6Sev)]
+-   **<big>ContainAny</big>** : check if the slice contains any element from the targets slice.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#ContainAny)]
+    [[play](https://go.dev/play/p/4xoxhc9XSSw)]
 -   **<big>Chunk</big>** : creates a slice of elements split into groups the length of size.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#Chunk)]
    [[play](https://go.dev/play/p/b4Pou5j2L_C)]
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -1468,6 +1468,9 @@ import "github.com/duke-git/lancet/v2/slice"
 -   **<big>ContainSubSlice</big>** : 判断 slice 是否包含 subslice。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#ContainSubSlice)]
    [[play](https://go.dev/play/p/bcuQ3UT6Sev)]
+-   **<big>ContainAny</big>** : 判断 slice 是否包含 targets 切片中的任意一个元素。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#ContainAny)]
+    [[play](https://go.dev/play/p/4xoxhc9XSSw)]
 -   **<big>Chunk</big>** : 按照 size 参数均分 slice。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#Chunk)]
    [[play](https://go.dev/play/p/b4Pou5j2L_C)]
--- a/docs/api/packages/slice.md
+++ b/docs/api/packages/slice.md
@@ -27,6 +27,7 @@ import (
 -   [Contain](#Contain)
 -   [ContainBy](#ContainBy)
 -   [ContainSubSlice](#ContainSubSlice)
+-   [ContainAny](#ContainAny)
 -   [Chunk](#Chunk)
 -   [Compact](#Compact)
 -   [Concat](#Concat)
@@ -256,6 +257,43 @@ func main() {
 }
 ```

+### <span id="ContainAny">ContainAny</span>
+
+<p>判断slice是否包含targets切片中的任意一个元素</p>
+
+<b>函数签名:</b>
+
+```go
+func ContainAny[T comparable](slice []T, targets []T) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/4xoxhc9XSSw)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+    result1 := slice.ContainAny([]string{"a", "b", "c"}, []string{"a"})
+    result2 := slice.ContainAny([]string{"a", "b", "c"}, []string{"d", "e"})
+    result3 := slice.ContainAny([]string{"a", "b", "c"}, []string{"d", "a"})
+    result4 := slice.ContainAny([]string{"a", "b", "c"}, []string{})
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+
+    // Output:
+    // true
+    // false
+    // true
+    // false
+}
+```
+
 ### <span id="Chunk">Chunk</span>

 <p>按照size参数均分slice</p>
--- a/docs/en/api/packages/slice.md
+++ b/docs/en/api/packages/slice.md
@@ -27,6 +27,7 @@ import (
 -   [Contain](#Contain)
 -   [ContainBy](#ContainBy)
 -   [ContainSubSlice](#ContainSubSlice)
+-   [ContainAny](#ContainAny)
 -   [Chunk](#Chunk)
 -   [Compact](#Compact)
 -   [Concat](#Concat)
@@ -256,6 +257,43 @@ func main() {
 }
 ```

+### <span id="ContainAny">ContainAny</span>
+
+<p>Check if the slice contains any element from the targets slice.</p>
+
+<b>Signature:</b>
+
+```go
+func ContainAny[T comparable](slice []T, targets []T) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/4xoxhc9XSSw)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+    result1 := slice.ContainAny([]string{"a", "b", "c"}, []string{"a"})
+    result2 := slice.ContainAny([]string{"a", "b", "c"}, []string{"d", "e"})
+    result3 := slice.ContainAny([]string{"a", "b", "c"}, []string{"d", "a"})
+    result4 := slice.ContainAny([]string{"a", "b", "c"}, []string{})
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+
+    // Output:
+    // true
+    // false
+    // true
+    // false
+}
+```
+
 ### <span id="Chunk">Chunk</span>

 <p>Creates an slice of elements split into groups the length of `size`.</p>
--- a/slice/slice.go
+++ b/slice/slice.go
@@ -74,6 +74,27 @@ func ContainSubSlice[T comparable](slice, subSlice []T) bool {
 	return true
 }

+// ContainAny check if the slice contains any element from the targets slice.
+// Play: https://go.dev/play/p/4xoxhc9XSSw
+func ContainAny[T comparable](slice []T, targets []T) bool {
+	if len(targets) == 0 {
+		return false
+	}
+
+	sliceMap := make(map[T]struct{}, len(slice))
+	for _, item := range slice {
+		sliceMap[item] = struct{}{}
+	}
+
+	for _, target := range targets {
+		if _, exists := sliceMap[target]; exists {
+			return true
+		}
+	}
+
+	return false
+}
+
 // Chunk creates a slice of elements split into groups the length of size.
 // Play: https://go.dev/play/p/b4Pou5j2L_C
 func Chunk[T any](slice []T, size int) [][]T {
--- a/slice/slice_example_test.go
+++ b/slice/slice_example_test.go
@@ -58,6 +58,24 @@ func ExampleContainSubSlice() {
 	// false
 }

+func ExampleContainAny() {
+	result1 := ContainAny([]string{"a", "b", "c"}, []string{"a"})
+	result2 := ContainAny([]string{"a", "b", "c"}, []string{"d", "e"})
+	result3 := ContainAny([]string{"a", "b", "c"}, []string{"d", "a"})
+	result4 := ContainAny([]string{"a", "b", "c"}, []string{})
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// true
+	// false
+	// true
+	// false
+}
+
 func ExampleChunk() {
 	arr := []string{"a", "b", "c", "d", "e"}

--- a/slice/slice_test.go
+++ b/slice/slice_test.go
@@ -89,6 +89,46 @@ func TestContainSubSlice(t *testing.T) {
 	}
 }

+func TestContainAny(t *testing.T) {
+	t.Parallel()
+
+	assert := internal.NewAssert(t, "TestContainAny")
+
+	tests := []struct {
+		slice   []string
+		targets []string
+		want    bool
+	}{
+		{[]string{"a", "b", "c"}, []string{"a"}, true},
+		{[]string{"a", "b", "c"}, []string{"a", "b"}, true},
+		{[]string{"a", "b", "c"}, []string{"d", "e"}, false},
+		{[]string{"a", "b", "c"}, []string{"d", "a"}, true},
+		{[]string{"a", "b", "c"}, []string{}, false},
+		{[]string{}, []string{"a"}, false},
+		{[]string{}, []string{}, false},
+		{[]string{"a", "b", "c"}, []string{"c", "d", "e"}, true},
+	}
+
+	for _, tt := range tests {
+		assert.Equal(tt.want, ContainAny(tt.slice, tt.targets))
+	}
+
+	intTests := []struct {
+		slice   []int
+		targets []int
+		want    bool
+	}{
+		{[]int{1, 2, 3, 4, 5}, []int{3}, true},
+		{[]int{1, 2, 3, 4, 5}, []int{6, 7}, false},
+		{[]int{1, 2, 3, 4, 5}, []int{5, 6, 7}, true},
+		{[]int{1, 2, 3, 4, 5}, []int{}, false},
+	}
+
+	for _, tt := range intTests {
+		assert.Equal(tt.want, ContainAny(tt.slice, tt.targets))
+	}
+}
+
 func TestChunk(t *testing.T) {
 	t.Parallel()