mirror of
https://github.com/duke-git/lancet.git
synced 2026-03-01 00:35:28 +08:00
doc: add doc for Log function
This commit is contained in:
@@ -44,6 +44,7 @@ import (
|
|||||||
- [LCM](#LCM)
|
- [LCM](#LCM)
|
||||||
- [Cos](#Cos)
|
- [Cos](#Cos)
|
||||||
- [Sin](#Sin)
|
- [Sin](#Sin)
|
||||||
|
- [Log](#Log)
|
||||||
|
|
||||||
<div STYLE="page-break-after: always;"></div>
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
@@ -871,4 +872,40 @@ func main() {
|
|||||||
// 0
|
// 0
|
||||||
// 1
|
// 1
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="Log">Log</span>
|
||||||
|
|
||||||
|
<p>Returns the logarithm of base n.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Log(n, base float64) float64
|
||||||
|
```
|
||||||
|
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```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
|
||||||
|
}
|
||||||
```
|
```
|
||||||
@@ -44,6 +44,7 @@ import (
|
|||||||
- [LCM](#LCM)
|
- [LCM](#LCM)
|
||||||
- [Cos](#Cos)
|
- [Cos](#Cos)
|
||||||
- [Sin](#Sin)
|
- [Sin](#Sin)
|
||||||
|
- [Log](#Log)
|
||||||
|
|
||||||
<div STYLE="page-break-after: always;"></div>
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
@@ -871,4 +872,39 @@ func main() {
|
|||||||
// 0
|
// 0
|
||||||
// 1
|
// 1
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### <span id="Log">Log</span>
|
||||||
|
|
||||||
|
<p>计算以base为底n的对数。</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Log(n, base float64) float64
|
||||||
|
```
|
||||||
|
|
||||||
|
<b>示例:</b>
|
||||||
|
|
||||||
|
```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
|
||||||
|
}
|
||||||
@@ -324,7 +324,7 @@ func Sin(radian float64, precision ...int) float64 {
|
|||||||
return Cos((math.Pi / 2) - radian)
|
return Cos((math.Pi / 2) - radian)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Log retur the logarithm of base n.
|
// Log returns the logarithm of base n.
|
||||||
// Play: todo
|
// Play: todo
|
||||||
func Log(n, base float64) float64 {
|
func Log(n, base float64) float64 {
|
||||||
return math.Log(n) / math.Log(base)
|
return math.Log(n) / math.Log(base)
|
||||||
|
|||||||
Reference in New Issue
Block a user