diff --git a/docs/mathutil.md b/docs/mathutil.md index 55ccf10..4ce5791 100644 --- a/docs/mathutil.md +++ b/docs/mathutil.md @@ -44,6 +44,7 @@ import ( - [LCM](#LCM) - [Cos](#Cos) - [Sin](#Sin) +- [Log](#Log)
@@ -871,4 +872,40 @@ func main() { // 0 // 1 } +``` + +### Log + +Returns the logarithm of base n.
+ +Signature: + +```go +func Log(n, base float64) float64 +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/mathutil" +) + +func main() { + result1 := mathutil.Log(8, 2) + result2 := mathutil.TruncRound(mathutil.Log(5, 2), 2) + result3 := mathutil.TruncRound(mathutil.Log(27, 3), 0) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + + // Output: + // 3 + // 2.32 + // 3 +} ``` \ No newline at end of file diff --git a/docs/mathutil_zh-CN.md b/docs/mathutil_zh-CN.md index 3e23e83..8f01255 100644 --- a/docs/mathutil_zh-CN.md +++ b/docs/mathutil_zh-CN.md @@ -44,6 +44,7 @@ import ( - [LCM](#LCM) - [Cos](#Cos) - [Sin](#Sin) +- [Log](#Log) @@ -871,4 +872,39 @@ func main() { // 0 // 1 } -``` \ No newline at end of file +``` + +### Log + +计算以base为底n的对数。
+ +函数签名: + +```go +func Log(n, base float64) float64 +``` + +示例: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/mathutil" +) + +func main() { + result1 := mathutil.Log(8, 2) + result2 := mathutil.TruncRound(mathutil.Log(5, 2), 2) + result3 := mathutil.TruncRound(mathutil.Log(27, 3), 0) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + + // Output: + // 3 + // 2.32 + // 3 +} \ No newline at end of file diff --git a/mathutil/mathutil.go b/mathutil/mathutil.go index 02137d0..458ce19 100644 --- a/mathutil/mathutil.go +++ b/mathutil/mathutil.go @@ -324,7 +324,7 @@ func Sin(radian float64, precision ...int) float64 { return Cos((math.Pi / 2) - radian) } -// Log retur the logarithm of base n. +// Log returns the logarithm of base n. // Play: todo func Log(n, base float64) float64 { return math.Log(n) / math.Log(base)