From 6453f755a69878e2761120e1fd7c8ebdf96f1718 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Thu, 30 Mar 2023 14:09:05 +0800 Subject: [PATCH] doc: add doc for IsPrime --- docs/mathutil.md | 41 +++++++++++++++++++++++++++++++++++++++++ docs/mathutil_zh-CN.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) diff --git a/docs/mathutil.md b/docs/mathutil.md index a780a5d..8ee1489 100644 --- a/docs/mathutil.md +++ b/docs/mathutil.md @@ -39,6 +39,7 @@ import ( - [AngleToRadian](#AngleToRadian) - [RadianToAngle](#RadianToAngle) - [PointDistance](#PointDistance) +- [IsPrime](#IsPrime)
@@ -661,4 +662,44 @@ func main() { // Output: // 5 } +``` + + +### IsPrime + +

Checks if number is prime number.

+ +Signature: + +```go +func IsPrime(n int) bool +``` + +Example: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/mathutil" +) + +func main() { + result1 := mathutil.IsPrime(-1) + result2 := mathutil.IsPrime(0) + result3 := mathutil.IsPrime(1) + result4 := mathutil.IsPrime(2) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // false + // false + // false + // true +} ``` \ No newline at end of file diff --git a/docs/mathutil_zh-CN.md b/docs/mathutil_zh-CN.md index 85505b7..ce258e7 100644 --- a/docs/mathutil_zh-CN.md +++ b/docs/mathutil_zh-CN.md @@ -661,3 +661,43 @@ func main() { // 5 } ``` + + + +### IsPrime + +

判断质数。

+ +函数签名: + +```go +func IsPrime(n int) bool +``` + +示例: + +```go +package main + +import ( + "fmt" + "github.com/duke-git/lancet/v2/mathutil" +) + +func main() { + result1 := mathutil.IsPrime(-1) + result2 := mathutil.IsPrime(0) + result3 := mathutil.IsPrime(1) + result4 := mathutil.IsPrime(2) + + fmt.Println(result1) + fmt.Println(result2) + fmt.Println(result3) + fmt.Println(result4) + + // Output: + // false + // false + // false + // true +} \ No newline at end of file