refactor: lzssv2 -> lzss

Consensys · Nov 13, 2023 · 36e35a2 · 36e35a2
1 parent cb95d21
commit 36e35a2
Show file tree

Hide file tree

Showing 17 changed files with 24 additions and 15 deletions.
diff --git a/std/compress/lzss_v2/average_block.hex → std/compress/lzss/average_block.hex b/std/compress/lzss_v2/average_block.hex → std/compress/lzss/average_block.hex
diff --git a/std/compress/lzss_v2/backref.go → std/compress/lzss/backref.go b/std/compress/lzss_v2/backref.go → std/compress/lzss/backref.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"math"

diff --git a/std/compress/lzss_v2/compile_large/main.go → std/compress/lzss/compile_large/main.go b/std/compress/lzss_v2/compile_large/main.go → std/compress/lzss/compile_large/main.go
@@ -3,7 +3,7 @@ package main
 import (
 	"fmt"
 	"github.com/consensys/gnark/std/compress"
-	"github.com/consensys/gnark/std/compress/lzss_v2"
+	"github.com/consensys/gnark/std/compress/lzss"
 )
 
 // executable to generate the constraints for the circuit and store it
@@ -14,7 +14,7 @@ func check(e error) {
 }
 
 func main() {
-	cs, err := lzss_v2.BenchCompressionE2ECompilation(nil, "../../test_cases/large")
+	cs, err := lzss.BenchCompressionE2ECompilation(nil, "../../test_cases/large")
 	check(err)
 
 	fmt.Println(cs.GetNbConstraints(), "constraints")

diff --git a/std/compress/lzss_v2/compress.go → std/compress/lzss/compress.go b/std/compress/lzss_v2/compress.go → std/compress/lzss/compress.go
@@ -1,11 +1,11 @@
-package lzss_v2
+package lzss
 
 import (
 	"bytes"
 	"fmt"
 	"math/bits"
 
-	"github.com/consensys/gnark/std/compress/lzss_v2/suffixarray"
+	"github.com/consensys/gnark/std/compress/lzss/suffixarray"
 	"github.com/icza/bitio"
 )
 
@@ -22,8 +22,17 @@ type Compressor struct {
 	dictSa    [maxDictSize]int32 // suffix array space.
 }
 
+type CompressionMode uint8
+
+const (
+	BestCompression        CompressionMode = 1
+	GoodCompression        CompressionMode = 2
+	GoodSnarkDecompression CompressionMode = 4
+	BestSnarkDecompression CompressionMode = 8
+)
+
 // NewCompressor returns a new compressor with the given dictionary
-func NewCompressor(dict []byte) (*Compressor, error) {
+func NewCompressor(dict []byte, compressionMode CompressionMode) (*Compressor, error) {
 	dict = augmentDict(dict)
 	if len(dict) > maxDictSize {
 		return nil, fmt.Errorf("dict size must be <= %d", maxDictSize)
@@ -40,8 +49,8 @@ func augmentDict(dict []byte) []byte {
 	return append(dict, symbolDict, symbolShort, symbolLong)
 }
 
-func initDictBackref(dict []byte) backrefType {
-	addrNbBits := uint8(bits.Len(uint(len(dict))))
+func (compressor *Compressor) initDictBackref() backrefType {
+	addrNbBits := uint8(bits.Len(uint(len(compressor.dictData))))
 	return newBackRefType(symbolDict, (addrNbBits+forceDivisibleBy-1)/forceDivisibleBy*forceDivisibleBy, 8, true)
 }
 
@@ -59,7 +68,7 @@ func (compressor *Compressor) Compress(d []byte) (c []byte, err error) {
 	// build the index
 	compressor.inputIndex = suffixarray.New(d, compressor.inputSa[:len(d)])
 
-	dictBackRefType := initDictBackref(compressor.dictData)
+	dictBackRefType := compressor.initDictBackref()
 
 	bDict := backref{bType: dictBackRefType, length: -1, offset: -1}
 	bShort := backref{bType: shortBackRefType, length: -1, offset: -1}

diff --git a/std/compress/lzss_v2/compress_test.go → std/compress/lzss/compress_test.go b/std/compress/lzss_v2/compress_test.go → std/compress/lzss/compress_test.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"bytes"

diff --git a/std/compress/lzss_v2/decompress.go → std/compress/lzss/decompress.go b/std/compress/lzss_v2/decompress.go → std/compress/lzss/decompress.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"bytes"

diff --git a/std/compress/lzss_v2/dict_fun → std/compress/lzss/dict_fun b/std/compress/lzss_v2/dict_fun → std/compress/lzss/dict_fun
diff --git a/std/compress/lzss_v2/dict_naive → std/compress/lzss/dict_naive b/std/compress/lzss_v2/dict_naive → std/compress/lzss/dict_naive
diff --git a/std/compress/lzss_v2/e2e_test.go → std/compress/lzss/e2e_test.go b/std/compress/lzss_v2/e2e_test.go → std/compress/lzss/e2e_test.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"github.com/consensys/gnark-crypto/ecc"

diff --git a/std/compress/lzss_v2/snark.go → std/compress/lzss/snark.go b/std/compress/lzss_v2/snark.go → std/compress/lzss/snark.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"fmt"

diff --git a/std/compress/lzss_v2/snark_test.go → std/compress/lzss/snark_test.go b/std/compress/lzss_v2/snark_test.go → std/compress/lzss/snark_test.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"bytes"

diff --git a/std/compress/lzss_v2/snark_testing.go → std/compress/lzss/snark_testing.go b/std/compress/lzss_v2/snark_testing.go → std/compress/lzss/snark_testing.go
@@ -1,4 +1,4 @@
-package lzss_v2
+package lzss
 
 import (
 	"fmt"

diff --git a/std/compress/lzss_v2/suffixarray/sais.go → std/compress/lzss/suffixarray/sais.go b/std/compress/lzss_v2/suffixarray/sais.go → std/compress/lzss/suffixarray/sais.go
diff --git a/std/compress/lzss_v2/suffixarray/sais2.go → std/compress/lzss/suffixarray/sais2.go b/std/compress/lzss_v2/suffixarray/sais2.go → std/compress/lzss/suffixarray/sais2.go
diff --git a/...mpress/lzss_v2/suffixarray/suffixarray.go → std/compress/lzss/suffixarray/suffixarray.go b/...mpress/lzss_v2/suffixarray/suffixarray.go → std/compress/lzss/suffixarray/suffixarray.go
diff --git a/...stdata/fuzz/FuzzCompress/6ed62c91940dd97f → ...stdata/fuzz/FuzzCompress/6ed62c91940dd97f b/...stdata/fuzz/FuzzCompress/6ed62c91940dd97f → ...stdata/fuzz/FuzzCompress/6ed62c91940dd97f
diff --git a/...stdata/fuzz/FuzzCompress/e3443030b91d09bb → ...stdata/fuzz/FuzzCompress/e3443030b91d09bb b/...stdata/fuzz/FuzzCompress/e3443030b91d09bb → ...stdata/fuzz/FuzzCompress/e3443030b91d09bb