docs

spiraldb · Aug 16, 2024 · ac874f5 · ac874f5
1 parent fd0d817
commit ac874f5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/encodings/fsst/README.md b/encodings/fsst/README.md
@@ -0,0 +1,4 @@
+# Vortex FSST
+
+A Vortex Encoding for Binary and Utf8 data that utilizes the [Fast Static Symbol Table](https://github.com/spiraldb/fsst)
+compression algorithm.
diff --git a/encodings/fsst/src/array.rs b/encodings/fsst/src/array.rs
@@ -27,15 +27,15 @@ impl FSSTArray {
     // a code.
     //
     // The `codes` array is a Binary array where each binary datum is a sequence of 8-bit codes.
-    // Each code corresponds either to an offset in the `symbols` table, or to the "escape code",
+    // Each code corresponds either to a symbol, or to the "escape code",
     // which tells the decoder to emit the following byte without doing a table lookup.
     pub fn try_new(dtype: DType, symbols: Array, codes: Array) -> VortexResult<Self> {
         // Check: symbols must be a u64 array
         if symbols.dtype() != &DType::Primitive(PType::U64, Nullability::NonNullable) {
             vortex_bail!(InvalidArgument: "symbols array must be of type u64")
         }
 
-        // Check: symbols must not have length > 255
+        // Check: symbols must not have length > MAX_CODE
         if symbols.len() > MAX_CODE as usize {
             vortex_bail!(InvalidArgument: "symbols array must have length <= 255")
         }