From a41d461910593944ca0427989e9bf1842959b9a5 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Fri, 24 Mar 2023 11:23:45 +0800 Subject: [PATCH] doc: update mathutil package doc --- docs/mathutil.md | 154 ++++++++++++++++++++++++++++++++++------- docs/mathutil_zh-CN.md | 153 +++++++++++++++++++++++++++++++++------- 2 files changed, 259 insertions(+), 48 deletions(-) diff --git a/docs/mathutil.md b/docs/mathutil.md index 2262269..a780a5d 100644 --- a/docs/mathutil.md +++ b/docs/mathutil.md @@ -36,6 +36,9 @@ import ( - [TruncRound](#TruncRound) - [Range](#Range) - [RangeWithStep](#RangeWithStep) +- [AngleToRadian](#AngleToRadian) +- [RadianToAngle](#RadianToAngle) +- [PointDistance](#PointDistance)
@@ -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] } ``` + +### AngleToRadian + +

Converts angle value to radian value.

+ +Signature: + +```go +func AngleToRadian(angle float64) float64 +``` + +Example: + +```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 +} +``` + + +### RadianToAngle + +

Converts radian value to angle value.

+ +Signature: + +```go +func RadianToAngle(radian float64) float64 +``` + +Example: + +```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 +} +``` + +### PointDistance + +

Caculates two points distance.

+ +Signature: + +```go +func PointDistance(x1, y1, x2, y2 float64) float64 +``` + +Example: + +```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 +} +``` \ No newline at end of file diff --git a/docs/mathutil_zh-CN.md b/docs/mathutil_zh-CN.md index 3247b26..85505b7 100644 --- a/docs/mathutil_zh-CN.md +++ b/docs/mathutil_zh-CN.md @@ -36,6 +36,9 @@ import ( - [TruncRound](#TruncRound) - [Range](#Range) - [RangeWithStep](#RangeWithStep) +- [AngleToRadian](#AngleToRadian) +- [RadianToAngle](#RadianToAngle) +- [PointDistance](#PointDistance)
@@ -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] +} +``` + +### AngleToRadian + +

将角度值转为弧度值

+ +函数签名: + +```go +func AngleToRadian(angle float64) float64 +``` + +示例: + +```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 +} +``` + +### RadianToAngle + +

将弧度值转为角度值

+ +函数签名: + +```go +func RadianToAngle(radian float64) float64 +``` + +示例: + +```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 +} +``` + +### PointDistance + +

计算两个坐标点的距离

+ +函数签名: + +```go +func PointDistance(x1, y1, x2, y2 float64) float64 +``` + +示例: + +```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 } ```