From a6be1828b9b1c5f071eb2b6b5fff163f4b4c6ec2 Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Wed, 21 Feb 2024 11:13:47 +0800
Subject: [PATCH] doc: add doc and example for predicate logic of function
 package

---
 docs/api/packages/function.md      |  2 +-
 function/predicate_example_test.go | 96 ++++++++++++++++++++++++++++++
 2 files changed, 97 insertions(+), 1 deletion(-)
 create mode 100644 function/predicate_example_test.go

diff --git a/docs/api/packages/function.md b/docs/api/packages/function.md
index 5c0c64b..843d006 100644
--- a/docs/api/packages/function.md
+++ b/docs/api/packages/function.md
@@ -524,7 +524,7 @@ func main() {
 
 ### <span id="Nor">Nor</span>
 
-<p>Returns a composed predicate that represents the logical NOR of a list of predicates. It evaluates to true only if all predicates evaluate to false for the given value.</p>
+<p>返回一个组合谓词函数，表示给定值上所有谓词逻辑非或 (nor) 的结果。只有当所有谓词函数对给定值都返回false时，该组合谓词函数才返回true。</p>
 
 <b>函数签名:</b>
 
diff --git a/function/predicate_example_test.go b/function/predicate_example_test.go
new file mode 100644
index 0000000..ec812e2
--- /dev/null
+++ b/function/predicate_example_test.go
@@ -0,0 +1,96 @@
+package function
+
+import (
+	"fmt"
+	"strings"
+)
+
+func ExampleNegate() {
+	// Define some simple predicates for demonstration
+	isUpperCase := func(s string) bool {
+		return strings.ToUpper(s) == s
+	}
+	isLowerCase := func(s string) bool {
+		return strings.ToLower(s) == s
+	}
+	isMixedCase := Negate(Or(isUpperCase, isLowerCase))
+
+	fmt.Println(isMixedCase("ABC"))
+	fmt.Println(isMixedCase("AbC"))
+
+	// Output:
+	// false
+	// true
+}
+
+func ExampleOr() {
+	containsDigitOrSpecialChar := Or(
+		func(s string) bool { return strings.ContainsAny(s, "0123456789") },
+		func(s string) bool { return strings.ContainsAny(s, "!@#$%") },
+	)
+
+	fmt.Println(containsDigitOrSpecialChar("hello!"))
+	fmt.Println(containsDigitOrSpecialChar("hello"))
+
+	// Output:
+	// true
+	// false
+}
+
+func ExampleAnd() {
+	isNumericAndLength5 := And(
+		func(s string) bool { return strings.ContainsAny(s, "0123456789") },
+		func(s string) bool { return len(s) == 5 },
+	)
+
+	fmt.Println(isNumericAndLength5("12345"))
+	fmt.Println(isNumericAndLength5("1234"))
+	fmt.Println(isNumericAndLength5("abcde"))
+
+	// Output:
+	// true
+	// false
+	// false
+}
+
+func ExampleNor() {
+	match := Nor(
+		func(s string) bool { return strings.ContainsAny(s, "0123456789") },
+		func(s string) bool { return len(s) == 5 },
+	)
+
+	fmt.Println(match("dbcdckkeee"))
+
+	match = Nor(
+		func(s string) bool { return strings.ContainsAny(s, "0123456789") },
+		func(s string) bool { return len(s) == 5 },
+	)
+
+	fmt.Println(match("0123456789"))
+
+	// Output:
+	// true
+	// false
+}
+
+func ExamplePredicatesMix() {
+	a := Or(
+		func(s string) bool { return strings.ContainsAny(s, "0123456789") },
+		func(s string) bool { return strings.ContainsAny(s, "!") },
+	)
+
+	b := And(
+		func(s string) bool { return strings.ContainsAny(s, "hello") },
+		func(s string) bool { return strings.ContainsAny(s, "!") },
+	)
+
+	c := Negate(And(a, b))
+	fmt.Println(c("hello!"))
+
+	c = Nor(a, b)
+	fmt.Println(c("hello!"))
+
+	// Output:
+	// false
+	// false
+}