feat: add new functions to mathutil package

2026-02-04 12:52:28 +08:00 · 2024-03-05 10:41:07 +08:00
parent 928e3a390d
commit 5fc21330da
6 changed files with 376 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -296,6 +296,10 @@ import "github.com/duke-git/lancet/mathutil"
 -   [RoundToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#RoundToFloat)
 -   [RoundToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#RoundToString)
 -   [TruncRound](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#TruncRound)
+-   [CeilToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#CeilToFloat)
+-   [CeilToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#CeilToString)
+-   [FloorToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#FloorToFloat)
+-   [FloorToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#FloorToString)
 -   [AngleToRadian](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#AngleToRadian)
 -   [RadianToAngle](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#RadianToAngle)
 -   [PointDistance](https://github.com/duke-git/lancet/blob/v1/docs/mathutil.md#PointDistance)
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -299,6 +299,10 @@ import "github.com/duke-git/lancet/mathutil"
 -   [RoundToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#RoundToFloat)
 -   [RoundToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#RoundToString)
 -   [TruncRound](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#TruncRound)
+-   [CeilToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#CeilToFloat)
+-   [CeilToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#CeilToString)
+-   [FloorToFloat](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#FloorToFloat)
+-   [FloorToString](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#FloorToString)
 -   [AngleToRadian](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#AngleToRadian)
 -   [RadianToAngle](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#RadianToAngle)
 -   [PointDistance](https://github.com/duke-git/lancet/blob/v1/docs/mathutil_zh-CN.md#PointDistance)
--- a/docs/mathutil.md
+++ b/docs/mathutil.md
@@ -29,6 +29,10 @@ import (
 -   [RoundToFloat](#RoundToFloat)
 -   [RoundToString](#RoundToString)
 -   [TruncRound](#TruncRound)
+-   [CeilToFloat](#CeilToFloat)
+-   [CeilToString](#CeilToString)
+-   [FloorToFloat](#FloorToFloat)
+-   [FloorToString](#FloorToString)
 -   [AngleToRadian](#AngleToRadian)
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
@@ -240,6 +244,150 @@ func main() {
 }
 ```

+### <span id="CeilToFloat">CeilToFloat</span>
+
+<p>Round float up n decimal places.</p>
+
+<b>Signature:</b>
+
+```go
+func CeilToFloat(x float64, n int) float64
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+	result1 := mathutil.CeilToFloat(3.14159, 1)
+	result2 := mathutil.CeilToFloat(3.14159, 2)
+	result3 := mathutil.CeilToFloat(5, 4)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 3.2
+	// 3.15
+	// 5
+}
+```
+
+### <span id="CeilToString">CeilToString</span>
+
+<p>Round float up n decimal places.</p>
+
+<b>Signature:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+	result1 := mathutil.CeilToString(3.14159, 1)
+	result2 := mathutil.CeilToString(3.14159, 2)
+	result3 := mathutil.CeilToString(5, 4)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 3.2
+	// 3.15
+	// 5.0000
+}
+```
+
+### <span id="FloorToFloat">FloorToFloat</span>
+
+<p>Round float down n decimal places.</p>
+
+<b>Signature:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+	result1 := mathutil.FloorToFloat(3.14159, 1)
+	result2 := mathutil.FloorToFloat(3.14159, 2)
+	result3 := mathutil.FloorToFloat(5, 4)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 3.1
+	// 3.14
+	// 5
+}
+```
+
+### <span id="FloorToString">FloorToString</span>
+
+<p>Round float down n decimal places.</p>
+
+<b>Signature:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+	result1 := mathutil.FloorToString(3.14159, 1)
+	result2 := mathutil.FloorToString(3.14159, 2)
+	result3 := mathutil.FloorToString(5, 4)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// 3.1
+	// 3.14
+	// 5.0000
+}
+```
+
 ### <span id="AngleToRadian">AngleToRadian</span>

 <p>Converts angle value to radian value.</p>
--- a/docs/mathutil_zh-CN.md
+++ b/docs/mathutil_zh-CN.md
@@ -29,6 +29,10 @@ import (
 -   [RoundToFloat](#RoundToFloat)
 -   [RoundToString](#RoundToString)
 -   [TruncRound](#TruncRound)
+-   [CeilToFloat](#CeilToFloat)
+-   [CeilToString](#CeilToString)
+-   [FloorToFloat](#FloorToFloat)
+-   [FloorToString](#FloorToString)
 -   [AngleToRadian](#AngleToRadian)
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
@@ -240,6 +244,151 @@ func main() {
 }
 ```

+### <span id="CeilToFloat">CeilToFloat</span>
+
+<p>向上舍入（进一法），保留n位小数。</p>
+
+<b>函数签名:</b>
+
+```go
+func CeilToFloat(x float64, n int) float64
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+    result1 := mathutil.CeilToFloat(3.14159, 1)
+    result2 := mathutil.CeilToFloat(3.14159, 2)
+    result3 := mathutil.CeilToFloat(5, 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 3.2
+    // 3.15
+    // 5
+}
+```
+
+### <span id="CeilToString">CeilToString</span>
+
+<p>向上舍入（进一法），保留n位小数，返回字符串。</p>
+
+<b>函数签名:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+    result1 := mathutil.CeilToString(3.14159, 1)
+    result2 := mathutil.CeilToString(3.14159, 2)
+    result3 := mathutil.CeilToString(5, 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 3.2
+    // 3.15
+    // 5.0000
+}
+```
+
+### <span id="FloorToFloat">FloorToFloat</span>
+
+<p>向下舍入（去尾法），保留n位小数。</p>
+
+<b>函数签名:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+    result1 := mathutil.FloorToFloat(3.14159, 1)
+    result2 := mathutil.FloorToFloat(3.14159, 2)
+    result3 := mathutil.FloorToFloat(5, 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 3.1
+    // 3.14
+    // 5
+}
+```
+
+### <span id="FloorToString">FloorToString</span>
+
+<p>向下舍入（去尾法），保留n位小数，返回字符串。</p>
+
+<b>函数签名:</b>
+
+```go
+func CeilToString(x float64, n int) string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/mathutil"
+)
+
+func main() {
+    result1 := mathutil.FloorToString(3.14159, 1)
+    result2 := mathutil.FloorToString(3.14159, 2)
+    result3 := mathutil.FloorToString(5, 4)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+
+    // Output:
+    // 3.1
+    // 3.14
+    // 5.0000
+}
+```
+
+
 ### <span id="AngleToRadian">AngleToRadian</span>

 <p>将角度值转为弧度值</p>
--- a/mathutil/mathutil.go
+++ b/mathutil/mathutil.go
@@ -91,6 +91,34 @@ func TruncRound(x float64, n int) float64 {
 	return res
 }

+// FloorToFloat round down to n decimal places.
+func FloorToFloat(x float64, n int) float64 {
+	return math.Floor(x*math.Pow(10, float64(n))) / math.Pow(10.0, float64(n))
+}
+
+// FloorToString round down to n decimal places.
+func FloorToString(x float64, n int) string {
+	tmp := math.Pow(10.0, float64(n))
+	x *= tmp
+	x = math.Floor(x)
+	res := strconv.FormatFloat(x/tmp, 'f', n, 64)
+	return res
+}
+
+// CeilToFloat round up to n decimal places.
+func CeilToFloat(x float64, n int) float64 {
+	pow10n := math.Pow10(n)
+	return math.Ceil(x*pow10n) / pow10n
+}
+
+// CeilToString round up to n decimal places.
+func CeilToString(x float64, n int) string {
+	multiplier := math.Pow(10, float64(n))
+	rounded := math.Ceil(x*multiplier) / multiplier
+
+	return fmt.Sprintf("%.*f", n, rounded)
+}
+
 // AngleToRadian converts angle value to radian value.
 func AngleToRadian(angle float64) float64 {
 	radian := angle * (math.Pi / 180)
--- a/mathutil/mathutil_test.go
+++ b/mathutil/mathutil_test.go
@@ -180,3 +180,46 @@ func TestLog(t *testing.T) {
 	assert.EqualValues(3, TruncRound(Log(27, 3), 0))
 	assert.EqualValues(2.32, TruncRound(Log(5, 2), 2))
 }
+
+func TestFloorToFloat(t *testing.T) {
+	t.Parallel()
+
+	assert := internal.NewAssert(t, "TestFloorToFloat")
+
+	assert.Equal(3.14, FloorToFloat(3.14159, 2))
+	assert.Equal(3.141, FloorToFloat(3.14159, 3))
+	assert.Equal(5.0, FloorToFloat(5, 4))
+	assert.Equal(2.0, FloorToFloat(9/4, 2))
+}
+
+func TestFloorToString(t *testing.T) {
+	t.Parallel()
+
+	assert := internal.NewAssert(t, "TestFloorToString")
+
+	assert.Equal("3.14", FloorToString(3.14159, 2))
+	assert.Equal("3.141", FloorToString(3.14159, 3))
+	assert.Equal("5.0000", FloorToString(5, 4))
+}
+
+func TestCeilToFloat(t *testing.T) {
+	t.Parallel()
+
+	assert := internal.NewAssert(t, "TestCeilToFloat")
+
+	assert.Equal(3.15, CeilToFloat(3.14159, 2))
+	assert.Equal(3.142, CeilToFloat(3.14159, 3))
+	assert.Equal(5.0, CeilToFloat(5, 4))
+	assert.Equal(0.15, CeilToFloat(float64(1)/float64(7), 2))
+}
+
+func TestCeilToString(t *testing.T) {
+	t.Parallel()
+
+	assert := internal.NewAssert(t, "TestCeilToFloat")
+
+	assert.Equal("3.15", CeilToString(3.14159, 2))
+	assert.Equal("3.142", CeilToString(3.14159, 3))
+	assert.Equal("5.0000", CeilToString(5, 4))
+	assert.Equal("0.15", CeilToString(float64(1)/float64(7), 2))
+}