人生で何度目かのダブル配列TRIEを書いた

# 概要

人は人生に何度かTRIEを書くという．そんなわけで，何度目かのTRIEでsudachiのdarts-cloneをクローンしてみました．TRIEの記事は沢山あるので，ここではGoに移植してみて気づいた事をいくつか共有していきたいと思います．

今回の成果物： https://github.com/ikawaha/dartsclone

# darts-clone

元ネタはこちら．Java版とPython版があります．

* https://github.com/WorksApplications/Sudachi/tree/develop/src/main/java/com/worksap/nlp/dartsclone
* https://github.com/WorksApplications/SudachiPy/tree/develop/sudachipy/dartsclone

本家は https://github.com/s-yata/darts-clone ．丁寧な解説もいっぱいあるのでググってみてください．

# とにかくやってみる

動作原理とか仕組みとか何も考えずにクローンしてみました．そのあとGOっぽくリファクタリングしてみました．訳も分からずJava版とPython版のコードをGoに落としてくのはなかなか面白かったです．

# リファクタリング

実は darts-clone のGo版がすでにありました．作ってから気づいたんですけど（あるある

つ https://github.com/euclidr/darts

こちらは本家のC++版から clone されてるみたいなので，これと比べてみました．自分が作ったやつが遅いw

ベンチとって調べてみたところ，ダブル配列をbyte配列で扱うときと，unit32配列で扱うときとで同じように処理するために，関数をまとめて両方から呼んでたんですが，その関数呼び出しの分だけ遅い原因になっていたようです．これをそれぞれのケースでべた書きした関数に直して呼び出し減らすと速度は大体同じになりました．

変更前：

```
func (a MmapedDoubleArray) ExactMatchSearch(key string) (id, size int, err error) {
	return exactMatchSearch(a, key) // ← 共通処理でまとめてた
}
```

変更後： べた書きに変更

```
func (a MmapedDoubleArray) ExactMatchSearch(key string) (id, size int, err error) {
	nodePos := uint32(0)
	unit, err := a.at(nodePos)
	if err != nil {
		return -1, -1, err
	}
	for i := 0; i < len(key); i++ {
		nodePos ^= unit.offset() ^ uint32(key[i])
		unit, err = a.at(nodePos)
		if err != nil {
			return -1, -1, err
		}
		if unit.label() != key[i] {
			return -1, 0, nil
		}
	}
	if !unit.hasLeaf() {
		return -1, 0, nil
	}
	unit, err = a.at(nodePos ^ unit.offset())
	if err != nil {
		return -1, -1, err
	}
	return int(unit.value()), len(key), nil
}
```

![image.png](https://qiita-image-store.s3.amazonaws.com/0/44487/e000f593-fe93-7fc3-14e7-628c703501be.png)

これで比較してるプログラムと同性能になりましたが，比較してるプログラムの方が配列のインデックスチェックなどのエラーのチェックを端折ってるのでその分ちょっと速いです．でもまぁ，誤差範囲なのでこれはエラーチェックを入れることにしました．panicで停まるのは微妙ですしね・・・．

# mmap 対応

sudachiはmmapで辞書を共有して省メモリで利用できるようになっています． そのためsudachiで使われているdarts-cloneはmmap対応されています．GOでもmmap対応していきます．linux系とwindowsで対応が変わってくるのでテストとかがちょっと面倒ですが，darts-cloneのダブル配列自体がbyte列になってるので素直に対応するだけでいけました．

ところがどうもmmapで読み込んだ場合の速度（1/10くらい）がでません．

mmap使わない場合はuint32の配列でダブル配列が表現されているんですが，mmapの時はこれがリトルエンディアンのbyte配列になっていて，ここからunit32の値を取り出していました．

最初書いてたコードはReaderつかって位置を指定してから，`Read()`で読み込んでたんですが，

```Go
	var ret uint32
	if err := binary.Read(r, binary.LittleEndian, &ret); err != nil {
		return 0, fmt.Errorf("read error, %v", err)
	}
```

この部分が遅かったみたいです．これを配列を直接指定して，

```Go
	if int(i+1)*unitSize > len(a.raw) {
		return 0, fmt.Errorf("index out of bounds")
	}
	ret := binary.LittleEndian.Uint32(a.raw[i*unitSize : (i+1)*unitSize])
```

で読み込んだら，mmap版も同等性能が出るようになりました．

ちなみに `binary.LittleEndian.Uint32()` の中身は，

```Go
func (littleEndian) Uint32(b []byte) uint32 {
	_ = b[3] // bounds check hint to compiler; see golang.org/issue/14808
	return uint32(b[0]) | uint32(b[1])<<8 | uint32(b[2])<<16 | uint32(b[3])<<24
}
```

なるほどシンプル．

あ，あと [`syscall` は deprecated になってて，`golang.org/x/sys` を使えとのこと](https://golang.org/pkg/syscall/)．しらんかった．


# まとめ

sudachiのdarts-clone相当の [github.com/ikawaha/darts-clone](https://github.com/ikawaha/dartsclone) をリリースしました．これで辞書引きの下準備ができたのでボチボチとsudachiの移植をやっていきたいなと思います．

ちなみに去年から開発を阻んでいるあれやこれはSまでは行ったのですが，そこからは進めないという壁にぶつかっているので，そろそろクリアにしようかなという気分．これがなくなればめっちゃ開発進む気もする (^^ゞ

去年から開発を阻むあれやこれ→ <a href="https://www.amazon.co.jp/Splatoon-%E3%82%B9%E3%83%97%E3%83%A9%E3%83%88%E3%82%A5%E3%83%BC%E3%83%B32-%E3%80%90%E3%82%AA%E3%83%AA%E3%82%B8%E3%83%8A%E3%83%AB%E3%83%9E%E3%83%AA%E3%82%AA%E3%82%B0%E3%83%83%E3%82%BA%E3%81%8C%E6%8A%BD%E9%81%B8%E3%81%A7%E5%BD%93%E3%81%9F%E3%82%8B%E3%82%B7%E3%83%AA%E3%82%A2%E3%83%AB%E3%82%B3%E3%83%BC%E3%83%89%E9%85%8D%E4%BF%A1-26-2018-8%E6%B3%A8%E6%96%87%E5%88%86%E3%81%BE%E3%81%A7/dp/B072J2J26T/ref=as_li_ss_il?ie=UTF8&qid=1513575323&sr=8-1&keywords=B072J2J26T%7CB0728B9YH6%7CB0719K2WPP%7CB0714CSKDC%7CB072FHKWGR&linkCode=li1&tag=foxii-22&linkId=0420dfa6a908d90a2d501827defb1a0a" target="_blank"><img border="0" src="//ws-fe.amazon-adsystem.com/widgets/q?_encoding=UTF8&ASIN=B072J2J26T&Format=_SL110_&ID=AsinImage&MarketPlace=JP&ServiceVersion=20070822&WS=1&tag=foxii-22" ></a><img src="https://ir-jp.amazon-adsystem.com/e/ir?t=foxii-22&l=li1&o=9&a=B072J2J26T" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />


Happy hacking!