Update readme

Author: willzhen

README.md

@@ -6,7 +6,7 @@
   - [任务调度模块](#任务调度模块)
 
 # go common library
-本仓库整理了 golang 中最常用的代码、函数、和模块。
+本库整理了 golang 中最常用的代码、函数、和模块，避免新项目总是重复造基础代码的轮子。
 
 ## httpcall 模块
 常用的简单 http 调用的封装。
@@ -25,10 +25,11 @@
 详见[stl_extension 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/stl_extension/readme.md)。
 
 ## text 模块
-常用文本处理相关方法。
+常用文本处理算法。
 - AcTrie：ac 自动机，多模式串快速匹配。在一个文本中快速找出来出现过哪些字符串子串以及其定位。可以理解对同一文本 s 多次调用 strings.Contains(s, xxx) 的加速。
 - Levenshtein：计算文本编辑距离。
 - TextSim：计算两个文本的相似度。
+- SliceSame：判断两个字符串数组是否相同。
 
 
 详见[text 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/text/readme.md)。

misc/readme.md

@@ -13,7 +13,7 @@
 - TimeTick —— 计时器，通过 TimeTick.Tick() 打点计时间，返回距离上一次 Tick 过去的时间，单位 ms。
 - Timed —— 函数调用计时。
 
-example:
+example: [TestTimeRelated](https://github.com/memory-overflow/go-common-library/blob/main/misc/time_related/time_test.go#L15)
 ```go
 import (
 	"testing"
@@ -51,7 +51,7 @@ func TestTimeRelated(t *testing.T) {
 - DownloadFile 下载网络文件
 - DownloadFileWithLimit 下载网络文件（带文件大小限制）
 
-example: 
+example: [TestDownload](https://github.com/memory-overflow/go-common-library/blob/main/misc/misc_test.go#L13)
 ```go
 import (
 	"context"
@@ -88,8 +88,7 @@ func TestDownload(t *testing.T) {
     - GoroutineHelp.Recoverd：协程 recover 处理函数。
     - GoroutineHelp.SafeGo：安全的启用携程。
 
-example:
-
+example: [TestGoroutineHelp](https://github.com/memory-overflow/go-common-library/blob/main/misc/misc_test.go#L35)
 ```go
 import (
 	"context"
@@ -137,7 +136,7 @@ IDGenerator 对象封装了很多生成 id 的函数。
 ## log
 - FoldLog: 折叠日志中数据过长的字段，输入仅支持 json 字符串。
 
-example:
+example: [TestFlodLog](https://github.com/memory-overflow/go-common-library/blob/main/misc/misc_test.go#L52)
 ```go
 import (
 	"context"

stl_extension/readme.md

@@ -38,14 +38,18 @@ group.Wait()
 ```
 
 ## OrderedMap
-golang stl 原生的 map 是基于 hash 的无需 map，OrderedMap 是对 hash map 的补充。支持按照 key 顺序遍历。
+golang stl 原生的 map 是基于 hash 的无序 map，OrderedMap 是对 hash map 的补充。支持按照 key 顺序遍历。
+
 OrderedMap 使用 avl 树实现，是线程安全的。
+
 和 c++ map 对比测试，1000 万的随机的增删查操作：
 OrderedMap: 21806 ms, c++ map: 11592ms，效率比 c++ map 慢两倍。
 next 遍历整个 map, OrderedMap: 676ms, c++ map: 171ms；
 prev 遍历整个 map, OrderedMap: 663ms, c++ map: 198ms；
 遍历的效率大概比 c++ map 的慢三倍。
 
+c++ map 用红黑树实现，在随机数据上表现会比 avl 树要好。avl 树深度会比红黑树低一点，查询效率比较高。但是插入的效率没有红黑树高。
+
 用法：
 - 构建
 ```go

text/readme.md

@@ -1,2 +1,88 @@
+- [text 模块](#text-模块)
+  - [SliceSame](#slicesame)
+  - [Aho-Corasick automaton](#aho-corasick-automaton)
+  - [计算文本编辑距离](#计算文本编辑距离)
+  - [计算文本相似度](#计算文本相似度)
+
 # text 模块
+golang 里面的 strings 库已经有了很多丰富的字符串处理功能，但是都是偏向于基础处理。
+
+text模块提供了一些字符串处理相关的算法能力。
+
+## SliceSame
+- SliceSame——判断两个字符串数字是否相同。
+
+example: [TestTextSim](https://github.com/memory-overflow/go-common-library/blob/main/text/text_test.go#L29)
+```go
+import (
+  "testing"
+
+  "github.com/memory-overflow/go-common-library/text"
+)
+
+func TestTextSim(t *testing.T) {
+	sim := text.TextSim("编辑距离测试", "测试一下距离")
+  t.Logf("sim: %f", sim)
+}
+```
+
+## Aho-Corasick automaton
+ac 自动机是一种多模式串的匹配算法。
+
+一个常见的例子就是给出 n 个单词，再给出一段包含 m 个字符的文章，让你找出有多少个单词在文章里出现过。
+
+比较容易想到的做法是，调用 n 次 `strings.Contains(s, xxx)`。假设 n 个单词平局长度为 k, 这样处理的算法时间复杂度为 O(n * k * m)。而使用 ac 自动机可以加速上述过程，整体算法时间复杂度只需要 O(n*k + m)。
+
+example: [TestActrie](https://github.com/memory-overflow/go-common-library/blob/main/text/text_test.go#L9)
+```go
+import (
+  "testing"
+
+  "github.com/memory-overflow/go-common-library/text"
+)
+
+func TestActrie(t *testing.T) {
+  // 在字符串 "哈哈哈哈23434dfgdd" 中找出所有 "哈哈哈", "234"，"dfg" 出现的位置。
+  // 使用模式串构建一个 ac 自动机
+  ac := text.BuildAcTrie([]string{"哈哈哈", "234", "dfg"})
+  // 匹配母串
+  list, index := ac.Search("哈哈哈哈23434dfgdd")
+  for i, l := range list {
+    t.Log(l, index[i])
+  }
+}
+```
+
+## 计算文本编辑距离
+编辑距离(Edit Distance)：是一个度量两个字符序列之间差异的字符串度量标准，两个单词之间的编辑距离是将一个单词转换为另一个单词所需的单字符编辑（插入、删除或替换）的最小数量。一般来说，编辑距离越小，两个串的相似度越大。
+
+example: [TestActrie](https://github.com/memory-overflow/go-common-library/blob/main/text/text_test.go#L24)
+```go
+import (
+  "testing"
+
+  "github.com/memory-overflow/go-common-library/text"
+)
+
+func TestLevenshtein(t *testing.T) {
+	dist := text.Levenshtein([]rune("编辑距离测试"), []rune("测试一下距离"))
+	t.Logf("dist: %d", dist)
+}
+```
+
+## 计算文本相似度
+通过编辑距离，计算两个文本的相似度。
+
+example: [TestTextSim](https://github.com/memory-overflow/go-common-library/blob/main/text/text_test.go#L17)
+```go
+import (
+  "testing"
+
+  "github.com/memory-overflow/go-common-library/text"
+)
 
+func TestTextSim(t *testing.T) {
+	sim := text.TextSim("编辑距离测试", "测试一下距离")
+  t.Logf("sim: %f", sim)
+}
+```

text/slice_same.go

@@ -7,10 +7,13 @@ func SliceSame(a, b []string) bool {
 	if len(a) != len(b) {
 		return false
 	}
-	sort.Strings(a)
-	sort.Strings(b)
-	for i := 0; i < len(a); i++ {
-		if a[i] != b[i] {
+	tmpa, tempb := []string{}, []string{}
+	copy(tmpa, a)
+	copy(tempb, b)
+	sort.Strings(tmpa)
+	sort.Strings(tempb)
+	for i := 0; i < len(tmpa); i++ {
+		if tmpa[i] != tempb[i] {
 			return false
 		}
 	}

text/text_test.go

@@ -15,8 +15,20 @@ func TestActrie(t *testing.T) {
 }
 
 func TestTextSim(t *testing.T) {
-	sim := text.TextSim("坚持干部一线值守常态化防控不放松让市民群众度过一个健康放心的假期", "这个口现在要开始封死")
+	sim := text.TextSim("编辑距离测试", "测试一下距离")
 	if sim != 0 {
 		t.Error("Failed")
 	}
 }
+
+func TestLevenshtein(t *testing.T) {
+	dist := text.Levenshtein([]rune("编辑距离测试"), []rune("测试一下距离"))
+	t.Logf("dist: %d", dist)
+}
+
+func TestSliceSmae(t *testing.T) {
+	a := []string{"3", "2", "1"}
+	same := text.SliceSame(a, a)
+	t.Logf("is same: %v", same)
+	t.Log(a)
+}