docs: add doc for Min, Max, and Average

docs/mathutil.md

@@ -20,9 +20,13 @@ import (
 <div STYLE="page-break-after: always;"></div>
 
 ## Index
+- [Average](#Average)
 - [Exponent](#Exponent)
 - [Fibonacci](#Fibonacci)
 - [Factorial](#Factorial)
+- [Max](#Max)
+- [Min](#Min)
+
 - [Percent](#Percent)
 - [RoundToFloat](#RoundToFloat)
 - [RoundToString](#RoundToString)
@@ -33,6 +37,35 @@ import (
 ## Documentation
 
 
+
+### <span id="Average">Average</span>
+<p>Return average value of numbers. Maybe call RoundToFloat to round result.</p>
+
+<b>Signature:</b>
+
+```go
+func Average[T lancetconstraints.Number](numbers ...T) T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Average(0, 0)) //0
+	fmt.Println(mathutil.Average(1, 1)) //1
+	avg := mathutil.Average(1.2, 1.4) //1.2999999998
+	roundAvg := mmathutil.RoundToFloat(avg, 1) // 1.3
+}
+```
+
+
+
 ### <span id="Exponent">Exponent</span>
 <p>Calculate x to the nth power.</p>
 
@@ -117,6 +150,60 @@ func main() {
 
 
 
+### <span id="Max">Max</span>
+<p>Return max value of numbers.</p>
+
+<b>Signature:</b>
+
+```go
+func Max[T lancetconstraints.Number](numbers ...T) T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Max(0, 0)) //0
+	fmt.Println(mathutil.Max(1, 2, 3)) //3
+	fmt.Println(mathutil.Max(1.2, 1.4, 1.1, 1.4)) //1.4
+}
+```
+
+
+
+### <span id="Min">Min</span>
+<p>Return min value of numbers.</p>
+
+<b>Signature:</b>
+
+```go
+func Min[T lancetconstraints.Number](numbers ...T) T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Min(0, 0)) //0
+	fmt.Println(mathutil.Min(1, 2, 3)) //1
+	fmt.Println(mathutil.Min(1.2, 1.4, 1.1, 1.4)) //1.1
+}
+```
+
+
+
 ### <span id="Percent">Percent</span>
 <p>calculate the percentage of val to total, retain n decimal places.</p>
 

docs/mathutil_zh-CN.md

@@ -20,10 +20,13 @@ import (
 <div STYLE="page-break-after: always;"></div>
 
 ## 目录
+- [Average](#Average)
 - [Exponent](#Exponent)
 - [Fibonacci](#Fibonacci)
 - [Factorial](#Factorial)
-
+- [Max](#Max)
+- [Min](#Min)
+  
 - [Percent](#Percent)
 - [RoundToFloat](#RoundToFloat)
 - [RoundToString](#RoundToString)
@@ -34,6 +37,33 @@ import (
 ## Documentation
 
 
+### <span id="Average">Average</span>
+<p>计算平均数. 可能需要对结果调用RoundToFloat方法四舍五入</p>
+
+<b>函数签名:</b>
+
+```go
+func Average[T lancetconstraints.Number](numbers ...T) T
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Average(0, 0)) //0
+	fmt.Println(mathutil.Average(1, 1)) //1
+	avg := mathutil.Average(1.2, 1.4) //1.2999999998
+	roundAvg := mmathutil.RoundToFloat(avg, 1) // 1.3
+}
+```
+
+
 ### <span id="Exponent">Exponent</span>
 <p>指数计算（x的n次方）</p>
 
@@ -117,6 +147,59 @@ func main() {
 ```
 
 
+### <span id="Max">Max</span>
+<p>返回参数中的最大数</p>
+
+<b>函数签名:</b>
+
+```go
+func Max[T lancetconstraints.Number](numbers ...T) T
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Max(0, 0)) //0
+	fmt.Println(mathutil.Max(1, 2, 3)) //3
+	fmt.Println(mathutil.Max(1.2, 1.4, 1.1, 1.4)) //1.4
+}
+```
+
+
+
+### <span id="Min">Min</span>
+<p>返回参数中的最小数</p>
+
+<b>函数签名:</b>
+
+```go
+func Min[T lancetconstraints.Number](numbers ...T) T
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+	fmt.Println(mathutil.Min(0, 0)) //0
+	fmt.Println(mathutil.Min(1, 2, 3)) //1
+	fmt.Println(mathutil.Min(1.2, 1.4, 1.1, 1.4)) //1.1
+}
+```
+
+
 
 ### <span id="Percent">Percent</span>
 <p>计算百分比，保留n位小数</p>

mathutil/mathutil_test.go

@@ -80,3 +80,19 @@ func TestAverage(t *testing.T) {
 	t.Log(avg)
 	assert.Equal(1.3, RoundToFloat(avg, 1))
 }
+
+func TestMax(t *testing.T) {
+	assert := internal.NewAssert(t, "TestMax")
+
+	assert.Equal(Max(0, 0), 0)
+	assert.Equal(Max(1, 2, 3), 3)
+	assert.Equal(Max(1.2, 1.4, 1.1, 1.4), 1.4)
+}
+
+func TestMin(t *testing.T) {
+	assert := internal.NewAssert(t, "TestMin")
+
+	assert.Equal(Min(0, 0), 0)
+	assert.Equal(Min(1, 2, 3), 1)
+	assert.Equal(Min(1.2, 1.4, 1.1, 1.4), 1.1)
+}