refactor rename async package name to

docs/mathutil.md

@@ -36,6 +36,9 @@ import (
 -   [TruncRound](#TruncRound)
 -   [Range](#Range)
 -   [RangeWithStep](#RangeWithStep)
+-   [AngleToRadian](#AngleToRadian)
+-   [RadianToAngle](#RadianToAngle)
+-   [PointDistance](#PointDistance)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -501,20 +504,20 @@ import (
 
 func main() {
     result1 := mathutil.Range(1, 4)
-	result2 := mathutil.Range(1, -4)
-	result3 := mathutil.Range(-4, 4)
-	result4 := mathutil.Range(1.0, 4)
+    result2 := mathutil.Range(1, -4)
+    result3 := mathutil.Range(-4, 4)
+    result4 := mathutil.Range(1.0, 4)
 
-	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:
-	// [1 2 3 4]
-	// [1 2 3 4]
-	// [-4 -3 -2 -1]
-	// [1 2 3 4]
+    // Output:
+    // [1 2 3 4]
+    // [1 2 3 4]
+    // [-4 -3 -2 -1]
+    // [1 2 3 4]
 }
 ```
 
@@ -540,19 +543,122 @@ import (
 
 func main() {
     result1 := mathutil.RangeWithStep(1, 4, 1)
-	result2 := mathutil.RangeWithStep(1, -1, 0)
-	result3 := mathutil.RangeWithStep(-4, 1, 2)
-	result4 := mathutil.RangeWithStep(1.0, 4.0, 1.1)
+    result2 := mathutil.RangeWithStep(1, -1, 0)
+    result3 := mathutil.RangeWithStep(-4, 1, 2)
+    result4 := mathutil.RangeWithStep(1.0, 4.0, 1.1)
 
-	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:
-	// [1 2 3]
-	// []
-	// [-4 -2 0]
-	// [1 2.1 3.2]
+    // Output:
+    // [1 2 3]
+    // []
+    // [-4 -2 0]
+    // [1 2.1 3.2]
 }
 ```
+
+### <span id="AngleToRadian">AngleToRadian</span>
+
+<p>Converts angle value to radian value.</p>
+
+<b>Signature:</b>
+
+```go
+func AngleToRadian(angle float64) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.AngleToRadian(45)
+    result2 := mathutil.AngleToRadian(90)
+    result3 := mathutil.AngleToRadian(180)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 0.7853981633974483
+    // 1.5707963267948966
+    // 3.141592653589793
+}
+```
+
+
+### <span id="RadianToAngle">RadianToAngle</span>
+
+<p>Converts radian value to angle value.</p>
+
+<b>Signature:</b>
+
+```go
+func RadianToAngle(radian float64) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.RadianToAngle(math.Pi)
+    result2 := mathutil.RadianToAngle(math.Pi / 2)
+    result3 := mathutil.RadianToAngle(math.Pi / 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 180
+    // 90
+    // 45
+}
+```
+
+### <span id="PointDistance">PointDistance</span>
+
+<p>Caculates two points distance.</p>
+
+<b>Signature:</b>
+
+```go
+func PointDistance(x1, y1, x2, y2 float64) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.PointDistance(1, 1, 4, 5)
+
+    fmt.Println(result1)
+
+    // Output:
+    // 5
+}
+```

docs/mathutil_zh-CN.md

@@ -36,6 +36,9 @@ import (
 -   [TruncRound](#TruncRound)
 -   [Range](#Range)
 -   [RangeWithStep](#RangeWithStep)
+-   [AngleToRadian](#AngleToRadian)
+-   [RadianToAngle](#RadianToAngle)
+-   [PointDistance](#PointDistance)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -501,20 +504,20 @@ import (
 
 func main() {
     result1 := mathutil.Range(1, 4)
-	result2 := mathutil.Range(1, -4)
-	result3 := mathutil.Range(-4, 4)
-	result4 := mathutil.Range(1.0, 4)
+    result2 := mathutil.Range(1, -4)
+    result3 := mathutil.Range(-4, 4)
+    result4 := mathutil.Range(1.0, 4)
 
-	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:
-	// [1 2 3 4]
-	// [1 2 3 4]
-	// [-4 -3 -2 -1]
-	// [1 2 3 4]
+    // Output:
+    // [1 2 3 4]
+    // [1 2 3 4]
+    // [-4 -3 -2 -1]
+    // [1 2 3 4]
 }
 ```
 
@@ -540,19 +543,121 @@ import (
 
 func main() {
     result1 := mathutil.RangeWithStep(1, 4, 1)
-	result2 := mathutil.RangeWithStep(1, -1, 0)
-	result3 := mathutil.RangeWithStep(-4, 1, 2)
-	result4 := mathutil.RangeWithStep(1.0, 4.0, 1.1)
+    result2 := mathutil.RangeWithStep(1, -1, 0)
+    result3 := mathutil.RangeWithStep(-4, 1, 2)
+    result4 := mathutil.RangeWithStep(1.0, 4.0, 1.1)
 
-	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:
-	// [1 2 3]
-	// []
-	// [-4 -2 0]
-	// [1 2.1 3.2]
+    // Output:
+    // [1 2 3]
+    // []
+    // [-4 -2 0]
+    // [1 2.1 3.2]
+}
+```
+
+### <span id="AngleToRadian">AngleToRadian</span>
+
+<p>将角度值转为弧度值</p>
+
+<b>函数签名:</b>
+
+```go
+func AngleToRadian(angle float64) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.AngleToRadian(45)
+    result2 := mathutil.AngleToRadian(90)
+    result3 := mathutil.AngleToRadian(180)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 0.7853981633974483
+    // 1.5707963267948966
+    // 3.141592653589793
+}
+```
+
+### <span id="RadianToAngle">RadianToAngle</span>
+
+<p>将弧度值转为角度值</p>
+
+<b>函数签名:</b>
+
+```go
+func RadianToAngle(radian float64) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.RadianToAngle(math.Pi)
+    result2 := mathutil.RadianToAngle(math.Pi / 2)
+    result3 := mathutil.RadianToAngle(math.Pi / 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 180
+    // 90
+    // 45
+}
+```
+
+### <span id="PointDistance">PointDistance</span>
+
+<p>计算两个坐标点的距离</p>
+
+<b>函数签名:</b>
+
+```go
+func PointDistance(x1, y1, x2, y2 float64) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.PointDistance(1, 1, 4, 5)
+
+    fmt.Println(result1)
+
+    // Output:
+    // 5
 }
 ```

mathutil/mathutil.go

@@ -216,3 +216,27 @@ func RangeWithStep[T constraints.Integer | constraints.Float](start, end, step T
 
 	return result
 }
+
+// AngleToRadian converts angle value to radian value.
+// Play: todo
+func AngleToRadian(angle float64) float64 {
+	radian := angle * (math.Pi / 180)
+	return radian
+}
+
+// RadianToAngle converts radian value to angle value.
+// Play: todo
+func RadianToAngle(radian float64) float64 {
+	angle := radian * (180 / math.Pi)
+	return angle
+}
+
+// PointDistance get two points distance.
+// Play: todo
+func PointDistance(x1, y1, x2, y2 float64) float64 {
+	a := x1 - x2
+	b := y1 - y2
+	c := math.Pow(a, 2) + math.Pow(b, 2)
+
+	return math.Sqrt(c)
+}

mathutil/mathutil_exmaple_test.go

@@ -1,6 +1,9 @@
 package mathutil
 
-import "fmt"
+import (
+	"fmt"
+	"math"
+)
 
 func ExampleExponent() {
 	result1 := Exponent(10, 0)
@@ -221,3 +224,42 @@ func ExampleRangeWithStep() {
 	// [-4 -2 0]
 	// [1 2.1 3.2]
 }
+
+func ExampleAngleToRadian() {
+	result1 := AngleToRadian(45)
+	result2 := AngleToRadian(90)
+	result3 := AngleToRadian(180)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 0.7853981633974483
+	// 1.5707963267948966
+	// 3.141592653589793
+}
+
+func ExampleRadianToAngle() {
+	result1 := RadianToAngle(math.Pi)
+	result2 := RadianToAngle(math.Pi / 2)
+	result3 := RadianToAngle(math.Pi / 4)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 180
+	// 90
+	// 45
+}
+
+func ExamplePointDistance() {
+	result1 := PointDistance(1, 1, 4, 5)
+
+	fmt.Println(result1)
+
+	// Output:
+	// 5
+}

mathutil/mathutil_test.go

@@ -1,6 +1,7 @@
 package mathutil
 
 import (
+	"math"
 	"testing"
 
 	"github.com/duke-git/lancet/v2/internal"
@@ -139,7 +140,7 @@ func TestMinBy(t *testing.T) {
 }
 
 func TestRange(t *testing.T) {
-	assert := internal.NewAssert(t, "Range")
+	assert := internal.NewAssert(t, "TestRange")
 
 	result1 := Range(1, 4)
 	result2 := Range(1, -4)
@@ -155,7 +156,7 @@ func TestRange(t *testing.T) {
 }
 
 func TestRangeWithStep(t *testing.T) {
-	assert := internal.NewAssert(t, "Range")
+	assert := internal.NewAssert(t, "TestRangeWithStep")
 
 	result1 := RangeWithStep(1, 4, 1)
 	result2 := RangeWithStep(1, -1, 0)
@@ -167,3 +168,35 @@ func TestRangeWithStep(t *testing.T) {
 	assert.Equal([]int{-4, -2, 0}, result3)
 	assert.Equal([]float64{1.0, 2.1, 3.2}, result4)
 }
+
+func TestAngleToRadian(t *testing.T) {
+	assert := internal.NewAssert(t, "TestAngleToRadian")
+
+	result1 := AngleToRadian(45)
+	result2 := AngleToRadian(90)
+	result3 := AngleToRadian(180)
+
+	assert.Equal(0.7853981633974483, result1)
+	assert.Equal(1.5707963267948966, result2)
+	assert.Equal(3.141592653589793, result3)
+}
+
+func TestRadianToAngle(t *testing.T) {
+	assert := internal.NewAssert(t, "TestAngleToRadian")
+
+	result1 := RadianToAngle(math.Pi)
+	result2 := RadianToAngle(math.Pi / 2)
+	result3 := RadianToAngle(math.Pi / 4)
+
+	assert.Equal(float64(180), result1)
+	assert.Equal(float64(90), result2)
+	assert.Equal(float64(45), result3)
+}
+
+func TestPointDistance(t *testing.T) {
+	assert := internal.NewAssert(t, "TestPointDistance")
+
+	result1 := PointDistance(1, 1, 4, 5)
+
+	assert.Equal(float64(5), result1)
+}

promise/promise.go

@@ -1,8 +1,8 @@
 // Copyright 2023 dudaodong@gmail.com. All rights reserved.
 // Use of this source code is governed by MIT license
 
-// Package async contain some featurese to support async programming. eg, promise, asycn/await, eventbus.
-package async
+// Package promise contains some functions to support async programming.
+package promise
 
 import (
 	"errors"

promise/promise_example_test.go

@@ -1,4 +1,4 @@
-package async
+package promise
 
 import (
 	"errors"

promise/promise_test.go

@@ -1,4 +1,4 @@
-package async
+package promise
 
 import (
 	"errors"