From af106a4a8e3889fff8c6400ab5fcc083b566055b Mon Sep 17 00:00:00 2001
From: dudaodong <dudaodong@gmail.com>
Date: Sun, 28 May 2023 20:12:40 +0800
Subject: [PATCH] doc: add doc for Cos and Sin

---
 docs/mathutil.md                  | 181 ++++++++++++++++++++++--------
 docs/mathutil_zh-CN.md            | 181 ++++++++++++++++++++++--------
 mathutil/mathutil_exmaple_test.go |  42 +++++++
 3 files changed, 308 insertions(+), 96 deletions(-)

diff --git a/docs/mathutil.md b/docs/mathutil.md
index 0520eb6..55ccf10 100644
--- a/docs/mathutil.md
+++ b/docs/mathutil.md
@@ -42,6 +42,8 @@ import (
 -   [IsPrime](#IsPrime)
 -   [GCD](#GCD)
 -   [LCM](#LCM)
+-   [Cos](#Cos)
+-   [Sin](#Sin)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -366,17 +368,17 @@ import (
 
 func main() {
     result1 := mathutil.Percent(1, 2, 2)
-	result2 := mathutil.Percent(0.1, 0.3, 2)
-	result3 := mathutil.Percent(-30305, 408420, 2)
+    result2 := mathutil.Percent(0.1, 0.3, 2)
+    result3 := mathutil.Percent(-30305, 408420, 2)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
 
-	// Output:
-	// 50
-	// 33.33
-	// -7.42
+    // Output:
+    // 50
+    // 33.33
+    // -7.42
 }
 ```
 
@@ -602,7 +604,6 @@ func main() {
 }
 ```
 
-
 ### <span id="RadianToAngle">RadianToAngle</span>
 
 <p>Converts radian value to angle value.</p>
@@ -669,7 +670,6 @@ func main() {
 }
 ```
 
-
 ### <span id="IsPrime">IsPrime</span>
 
 <p>Checks if number is prime number.</p>
@@ -692,20 +692,20 @@ import (
 
 func main() {
     result1 := mathutil.IsPrime(-1)
-	result2 := mathutil.IsPrime(0)
-	result3 := mathutil.IsPrime(1)
-	result4 := mathutil.IsPrime(2)
+    result2 := mathutil.IsPrime(0)
+    result3 := mathutil.IsPrime(1)
+    result4 := mathutil.IsPrime(2)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
-	fmt.Println(result4)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
 
-	// Output:
-	// false
-	// false
-	// false
-	// true
+    // Output:
+    // false
+    // false
+    // false
+    // true
 }
 ```
 
@@ -731,27 +731,26 @@ import (
 
 func main() {
     result1 := mathutil.GCD(1, 1)
-	result2 := mathutil.GCD(1, -1)
-	result3 := mathutil.GCD(-1, 1)
-	result4 := mathutil.GCD(-1, -1)
-	result5 := mathutil.GCD(3, 6, 9)
+    result2 := mathutil.GCD(1, -1)
+    result3 := mathutil.GCD(-1, 1)
+    result4 := mathutil.GCD(-1, -1)
+    result5 := mathutil.GCD(3, 6, 9)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
-	fmt.Println(result4)
-	fmt.Println(result5)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
 
-	// Output:
-	// 1
-	// 1
-	// -1
-	// -1
-	// 3
+    // Output:
+    // 1
+    // 1
+    // -1
+    // -1
+    // 3
 }
 ```
 
-
 ### <span id="LCM">LCM</span>
 
 <p>Return Least Common Multiple (LCM) of integers.</p>
@@ -774,16 +773,102 @@ import (
 
 func main() {
     result1 := mathutil.LCM(1, 1)
-	result2 := mathutil.LCM(1, 2)
-	result3 := mathutil.LCM(3, 6, 9)
+    result2 := mathutil.LCM(1, 2)
+    result3 := mathutil.LCM(3, 6, 9)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
 
-	// Output:
-	// 1
-	// 2
-	// 18
+    // Output:
+    // 1
+    // 2
+    // 18
+}
+```
+
+
+### <span id="Cos">Cos</span>
+
+<p>Returns the cosine of the radian argument.</p>
+
+<b>Signature:</b>
+
+```go
+func Cos(radian float64, precision ...int) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.Cos(0)
+    result2 := mathutil.Cos(90)
+    result3 := mathutil.Cos(180)
+    result4 := mathutil.Cos(math.Pi)
+    result5 := mathutil.Cos(math.Pi / 2)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // 1
+    // -0.447
+    // -0.598
+    // -1
+    // 0
+}
+```
+
+
+### <span id="Sin">Sin</span>
+
+<p>Returns the sine of the radian argument.</p>
+
+<b>Signature:</b>
+
+```go
+func Sin(radian float64, precision ...int) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.Sin(0)
+    result2 := mathutil.Sin(90)
+    result3 := mathutil.Sin(180)
+    result4 := mathutil.Sin(math.Pi)
+    result5 := mathutil.Sin(math.Pi / 2)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // 0
+    // 0.894
+    // -0.801
+    // 0
+    // 1
 }
 ```
\ No newline at end of file
diff --git a/docs/mathutil_zh-CN.md b/docs/mathutil_zh-CN.md
index 972e178..3e23e83 100644
--- a/docs/mathutil_zh-CN.md
+++ b/docs/mathutil_zh-CN.md
@@ -42,6 +42,8 @@ import (
 -   [IsPrime](#IsPrime)
 -   [GCD](#GCD)
 -   [LCM](#LCM)
+-   [Cos](#Cos)
+-   [Sin](#Sin)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -366,17 +368,17 @@ import (
 
 func main() {
     result1 := mathutil.Percent(1, 2, 2)
-	result2 := mathutil.Percent(0.1, 0.3, 2)
-	result3 := mathutil.Percent(-30305, 408420, 2)
+    result2 := mathutil.Percent(0.1, 0.3, 2)
+    result3 := mathutil.Percent(-30305, 408420, 2)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
 
-	// Output:
-	// 50
-	// 33.33
-	// -7.42
+    // Output:
+    // 50
+    // 33.33
+    // -7.42
 }
 ```
 
@@ -668,8 +670,6 @@ func main() {
 }
 ```
 
-
-
 ### <span id="IsPrime">IsPrime</span>
 
 <p>判断质数。</p>
@@ -692,20 +692,20 @@ import (
 
 func main() {
     result1 := mathutil.IsPrime(-1)
-	result2 := mathutil.IsPrime(0)
-	result3 := mathutil.IsPrime(1)
-	result4 := mathutil.IsPrime(2)
+    result2 := mathutil.IsPrime(0)
+    result3 := mathutil.IsPrime(1)
+    result4 := mathutil.IsPrime(2)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
-	fmt.Println(result4)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
 
-	// Output:
-	// false
-	// false
-	// false
-	// true
+    // Output:
+    // false
+    // false
+    // false
+    // true
 }
 ```
 
@@ -731,27 +731,26 @@ import (
 
 func main() {
     result1 := mathutil.GCD(1, 1)
-	result2 := mathutil.GCD(1, -1)
-	result3 := mathutil.GCD(-1, 1)
-	result4 := mathutil.GCD(-1, -1)
-	result5 := mathutil.GCD(3, 6, 9)
+    result2 := mathutil.GCD(1, -1)
+    result3 := mathutil.GCD(-1, 1)
+    result4 := mathutil.GCD(-1, -1)
+    result5 := mathutil.GCD(3, 6, 9)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
-	fmt.Println(result4)
-	fmt.Println(result5)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
 
-	// Output:
-	// 1
-	// 1
-	// -1
-	// -1
-	// 3
+    // Output:
+    // 1
+    // 1
+    // -1
+    // -1
+    // 3
 }
 ```
 
-
 ### <span id="LCM">LCM</span>
 
 <p>计算最小公倍数。</p>
@@ -774,16 +773,102 @@ import (
 
 func main() {
     result1 := mathutil.LCM(1, 1)
-	result2 := mathutil.LCM(1, 2)
-	result3 := mathutil.LCM(3, 6, 9)
+    result2 := mathutil.LCM(1, 2)
+    result3 := mathutil.LCM(3, 6, 9)
 
-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
 
-	// Output:
-	// 1
-	// 2
-	// 18
+    // Output:
+    // 1
+    // 2
+    // 18
+}
+```
+
+
+### <span id="Cos">Cos</span>
+
+<p>计算弧度的余弦值</p>
+
+<b>函数签名:</b>
+
+```go
+func Cos(radian float64, precision ...int) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.Cos(0)
+    result2 := mathutil.Cos(90)
+    result3 := mathutil.Cos(180)
+    result4 := mathutil.Cos(math.Pi)
+    result5 := mathutil.Cos(math.Pi / 2)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // 1
+    // -0.447
+    // -0.598
+    // -1
+    // 0
+}
+```
+
+
+### <span id="Sin">Sin</span>
+
+<p>计算弧度的正弦值</p>
+
+<b>函数签名:</b>
+
+```go
+func Sin(radian float64, precision ...int) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.Sin(0)
+    result2 := mathutil.Sin(90)
+    result3 := mathutil.Sin(180)
+    result4 := mathutil.Sin(math.Pi)
+    result5 := mathutil.Sin(math.Pi / 2)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // 0
+    // 0.894
+    // -0.801
+    // 0
+    // 1
 }
 ```
\ No newline at end of file
diff --git a/mathutil/mathutil_exmaple_test.go b/mathutil/mathutil_exmaple_test.go
index babc37f..d782ae1 100644
--- a/mathutil/mathutil_exmaple_test.go
+++ b/mathutil/mathutil_exmaple_test.go
@@ -320,3 +320,45 @@ func ExampleLCM() {
 	// 2
 	// 18
 }
+
+func ExampleCos() {
+	result1 := Cos(0)
+	result2 := Cos(90)
+	result3 := Cos(180)
+	result4 := Cos(math.Pi)
+	result5 := Cos(math.Pi / 2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// 1
+	// -0.447
+	// -0.598
+	// -1
+	// 0
+}
+
+func ExampleSin() {
+	result1 := Sin(0)
+	result2 := Sin(90)
+	result3 := Sin(180)
+	result4 := Sin(math.Pi)
+	result5 := Sin(math.Pi / 2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// 0
+	// 0.894
+	// -0.801
+	// 0
+	// 1
+}