Update CHANGELOG with date range queries

Closing #933

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: fulmicoton
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/actions.md

@@ -0,0 +1,13 @@
+---
+name: Actions
+about: Actions not directly related to producing code.
+
+---
+
+# Actions title
+
+Action description. 
+e.g. 
+- benchmark
+- investigate and report
+- etc.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,19 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+- What did you do?
+- What happened?
+- What was expected?
+
+**Which version of tantivy are you using?**
+If "master",  ideally give the specific sha1 revision.
+
+**To Reproduce**
+
+If your bug is deterministic, can you give a minimal reproducing code?
+Some bugs are not deterministic. Can you describe with precision in which context it happened?
+If this is possible, can you share your code?

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**[Optional] describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,7 @@
+---
+name: Question
+about: Ask any question about tantivy's usage...
+
+---
+
+Try to be specific about your use case...

.gitignore

@@ -1,3 +1,6 @@
+tantivy.iml
+proptest-regressions
+*.swp
 target
 target/debug
 .vscode
@@ -8,4 +11,5 @@ benchmark
 cpp/simdcomp/bitpackingbenchmark
 *.bk
 .idea
-trace.dat
+trace.dat
+cargo-timing*

.travis.yml

@@ -1,16 +1,22 @@
+# Based on the "trust" template v0.1.2
+# https://github.com/japaric/trust/tree/v0.1.2
+
+dist: trusty
 language: rust
-rust:
-  - nightly
+services: docker
+sudo: required
+
 env:
   global:
-    - CC=gcc-4.8
-    - CXX=g++-4.8
+    - CRATE_NAME=tantivy
     - TRAVIS_CARGO_NIGHTLY_FEATURE=""
-    - secure: eC8HjTi1wgRVCsMAeXEXt8Ckr0YBSGOEnQkkW4/Nde/OZ9jJjz2nmP1ELQlDE7+czHub2QvYtDMG0parcHZDx/Kus0yvyn08y3g2rhGIiE7y8OCvQm1Mybu2D/p7enm6shXquQ6Z5KRfRq+18mHy80wy9ABMA/ukEZdvnfQ76/Een8/Lb0eHaDoXDXn3PqLVtByvSfQQ7OhS60dEScu8PWZ6/l1057P5NpdWbMExBE7Ro4zYXNhkJeGZx0nP/Bd4Jjdt1XfPzMEybV6NZ5xsTILUBFTmOOt603IsqKGov089NExqxYu5bD3K+S4MzF1Nd6VhomNPJqLDCfhlymJCUj5n5Ku4yidlhQbM4Ej9nGrBalJnhcjBjPua5tmMF2WCxP9muKn/2tIOu1/+wc0vMf9Yd3wKIkf5+FtUxCgs2O+NslWvmOMAMI/yD25m7hb4t1IwE/4Bk+GVcWJRWXbo0/m6ZUHzRzdjUY2a1qvw7C9udzdhg7gcnXwsKrSWi2NjMiIVw86l+Zim0nLpKIN41sxZHLaFRG63Ki8zQ/481LGn32awJ6i3sizKS0WD+N1DfR2qYMrwYHaMN0uR0OFXYTJkFvTFttAeUY3EKmRKAuMhmO2YRdSr4/j/G5E9HMc1gSGJj6PxgpQU7EpvxRsmoVAEJr0mszmOj9icGHep/FM=
+    # - secure: eC8HjTi1wgRVCsMAeXEXt8Ckr0YBSGOEnQkkW4/Nde/OZ9jJjz2nmP1ELQlDE7+czHub2QvYtDMG0parcHZDx/Kus0yvyn08y3g2rhGIiE7y8OCvQm1Mybu2D/p7enm6shXquQ6Z5KRfRq+18mHy80wy9ABMA/ukEZdvnfQ76/Een8/Lb0eHaDoXDXn3PqLVtByvSfQQ7OhS60dEScu8PWZ6/l1057P5NpdWbMExBE7Ro4zYXNhkJeGZx0nP/Bd4Jjdt1XfPzMEybV6NZ5xsTILUBFTmOOt603IsqKGov089NExqxYu5bD3K+S4MzF1Nd6VhomNPJqLDCfhlymJCUj5n5Ku4yidlhQbM4Ej9nGrBalJnhcjBjPua5tmMF2WCxP9muKn/2tIOu1/+wc0vMf9Yd3wKIkf5+FtUxCgs2O+NslWvmOMAMI/yD25m7hb4t1IwE/4Bk+GVcWJRWXbo0/m6ZUHzRzdjUY2a1qvw7C9udzdhg7gcnXwsKrSWi2NjMiIVw86l+Zim0nLpKIN41sxZHLaFRG63Ki8zQ/481LGn32awJ6i3sizKS0WD+N1DfR2qYMrwYHaMN0uR0OFXYTJkFvTFttAeUY3EKmRKAuMhmO2YRdSr4/j/G5E9HMc1gSGJj6PxgpQU7EpvxRsmoVAEJr0mszmOj9icGHep/FM=
+
 addons:
   apt:
     sources:
       - ubuntu-toolchain-r-test
+      - kalakris-cmake
     packages:
       - gcc-4.8
       - g++-4.8
@@ -18,18 +24,69 @@ addons:
       - libelf-dev
       - libdw-dev
       - binutils-dev
+      - cmake
+
+matrix:
+  include:
+    # Android
+    - env: TARGET=aarch64-linux-android DISABLE_TESTS=1
+    #- env: TARGET=arm-linux-androideabi DISABLE_TESTS=1
+    #- env: TARGET=armv7-linux-androideabi DISABLE_TESTS=1
+    #- env: TARGET=i686-linux-android DISABLE_TESTS=1
+    #- env: TARGET=x86_64-linux-android DISABLE_TESTS=1
+
+    # Linux
+    #- env: TARGET=aarch64-unknown-linux-gnu
+    #- env: TARGET=i686-unknown-linux-gnu
+    - env: TARGET=x86_64-unknown-linux-gnu CODECOV=1 #UPLOAD_DOCS=1
+    # - env: TARGET=x86_64-unknown-linux-musl CODECOV=1
+    # OSX
+    #- env: TARGET=x86_64-apple-darwin
+    #  os: osx
+
+before_install:
+  - set -e
+  - rustup self update
+  - rustup component add rustfmt
+
+install:
+  - sh ci/install.sh
+  - source ~/.cargo/env || true
+  - env | grep "TRAVIS"
+
 before_script:
-  - |
-    pip install 'travis-cargo<0.2' --user &&
-    export PATH=$HOME/.local/bin:$PATH
+  - export PATH=$HOME/.cargo/bin:$PATH
+  - cargo install cargo-update || echo "cargo-update already installed"
+  - cargo install cargo-travis || echo "cargo-travis already installed"
+
 script:
-  - |
-    travis-cargo build &&
-    travis-cargo test &&
-    travis-cargo bench
-  - cargo run --example simple_search
+  - bash ci/script.sh
+  - cargo fmt --all -- --check
+
+before_deploy:
+  - sh ci/before_deploy.sh
+
 after_success:
-  - bash ./script/build-doc.sh
-  - travis-cargo doc-upload
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then travis-cargo coveralls --no-sudo --verify; fi
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then ./kcov/build/src/kcov --verify --coveralls-id=$TRAVIS_JOB_ID --include-path=`pwd`/src --exclude-path=`pwd`/cpp --exclude-pattern=/.cargo target/kcov target/debug/tantivy-*; fi
+  # Needs GH_TOKEN env var to be set in travis settings
+  - if [[ -v GH_TOKEN ]]; then echo "GH TOKEN IS SET"; else echo "GH TOKEN NOT SET"; fi
+  - if [[ -v UPLOAD_DOCS ]]; then cargo doc; cargo doc-upload; else echo "doc upload disabled."; fi
+
+#cache: cargo
+#before_cache:
+#  # Travis can't cache files that are not readable by "others"
+#  - chmod -R a+r $HOME/.cargo
+#  - find ./target/debug -type f -maxdepth 1 -delete
+#  - rm -f  ./target/.rustc_info.json
+#  - rm -fr ./target/debug/{deps,.fingerprint}/tantivy*
+#  - rm -r target/debug/examples/
+#  - ls -1 examples/ | sed -e 's/\.rs$//' | xargs -I "{}" find target/* -name "*{}*" -type f -delete
+
+#branches:
+#  only:
+#    # release tags
+#    - /^v\d+\.\d+\.\d+.*$/
+#    - master
+
+notifications:
+  email:
+    on_success: never

ARCHITECTURE.md

@@ -0,0 +1,297 @@
+# Tantivy
+
+## What is tantivy?
+
+Tantivy is a library that is meant to build search engines. Although it is by no mean a port of Lucene, its architecture is strongly inspired by it. If you are familiar with Lucene, you may be struck by the overlapping vocabulary.
+This is not fortuitous.
+
+Tantivy's bread and butter is to address the problem of full-text search :
+
+Given a large set of textual documents, and a text query, return the K-most relevant documents in a very efficient way. In order to execute these queries rapidly, the tantivy need to build an index beforehand. The relevance score implemented in the tantivy is not configurable. Tantivy uses the same score as the default similarity used in Lucene / Elasticsearch, called [BM25](https://en.wikipedia.org/wiki/Okapi_BM25).
+
+But tantivy's scope does not stop there. Numerous features are required to power rich search applications. For instance, one may want to:
+- compute the count of documents matching a query in the different section of an e-commerce website,
+- display an average price per meter square for a real estate search engine,
+- take in account historical user data to rank documents in a specific way,
+- or even use tantivy to power an OLAP database.
+
+A more abstract description of the problem space tantivy is trying to address is the following.
+
+Ingest a large set of documents, create an index that makes it possible to
+rapidly select all documents matching a given predicate (also known as a query) and
+collect some information about them (See collector).
+
+Roughly speaking the design is following these guiding principles:
+- Search should be O(1) in memory.
+- Indexing should be O(1) in memory. (In practise it is just sublinear)
+- Search should be as fast as possible
+
+This comes at the cost of the dynamicity of the index : while it is possible to add, and delete documents from our corpus, the tantivy is designed to handle these updates in large batches.
+
+## [core/](src/core): Index, segments, searchers.
+
+Core contains all of the high level code to make it possible for to create an index, add documents, delete documents and commit.
+
+This is both the most high-level part of tantivy, the least performance sensitive one, the seemingly most mundane code... And paradoxically the most complicated part.
+
+### Index and Segments...
+
+A tantivy index is in fact a collection of smaller independent immutable segments.
+Each segment contains its own independent set of datastructures.
+
+A segment is identified by a segment id that is in fact a UUID.
+The file of a segment has the format
+
+ ```segment-id . ext ```
+
+The extension signals which datastructure (or [`SegmentComponent`](src/core/segment_component.rs)) is stored in the file.
+
+A small `meta.json` file is in charge keeping track of the list of segments, as well as the schema.
+
+On commit, one segment per indexing thread is written to disk, and the `meta.json` is then updated atomically.
+
+For a better idea of how indexing works, you may read the [following blog post](https://fulmicoton.com/posts/behold-tantivy-part2/).
+
+
+### Deletes
+
+Deletes happen by deleting a "term". Tantivy does not offer any notion of primary id, so it is up to the user to use a field in their schema as if it was a primary id, and delete the associated term if they want to delete only one specific document.
+
+On commit, tantivy will find all of the segments with documents matching this existing term and create a [tombstone file](src/fastfield/delete.rs) that represents the bitset of the document that are deleted.
+Like all segment files, this file is immutable. Because it is possible to have more than one tombstone file at a given instant, the tombstone filename has the format ``` segment_id . commit_opstamp . del```.
+
+An opstamp is simply an incremental id that identifies any operation applied to the index. For instance, performing a commit or adding a document.
+
+
+### DocId
+
+Within a segment, all documents are identified by a DocId that ranges within `[0, max_doc)`.
+where max doc is the number of documents in the segment, (deleted or not). Having such a compact `DocId` space is key to the compression of our datastructures.
+
+The DocIds are simply allocated in the order documents are added to the index.
+
+### Merges
+
+In separate threads, tantivy's index writer search for opportunities to merge segments.
+The point of segment merges is to:
+- eventually get rid of tombstoned documents
+- reduce the otherwise evergrowing number of segments.
+
+Indeed, while having several segments instead of one does not hurt search too much, having hundreds can have a measurable impact on the search performance.
+
+### Searcher
+
+The user of the library usually does not need to know about the existence of Segments.
+Searching is done through an object called a [`Searcher`](src/core/searcher.rs), that captures a
+snapshot of the index at one point of time, by holding a list of [SegmentReader](src/core/segment_reader.rs).
+
+In other words, regardless of commits, file garbage collection, or segment merge that might happen, as long as the user holds and reuse the same [Searcher](src/core/searcher.rs), search will happen on an immutable snapshot of the index.
+
+## [directory/](src/directory): Where should the data be stored?
+
+Tantivy, like Lucene, abstracts the place where the data should be stored in a key-trait
+called [`Directory`](src/directory/directory.rs).
+Contrary to Lucene however, "files" are quite different from some kind of `io::Read` object.
+Check out [`src/directory/directory.rs`](src/directory/directory.rs) trait for more details.
+
+Tantivy ships two main directory implementation: the `MMapDirectory` and the `RAMDirectory`,
+but users can extend tantivy with their own implementation.
+
+## [schema/](src/schema): What are documents?
+
+Tantivy's document follow a very strict schema , decided before building any index.
+
+The schema defines all of the fields that the indexes [`Document`](src/schema/document.rs) may and should contain, their types (`text`, `i64`, `u64`, `Date`, ...) as well as how it should be indexed / represented in tantivy.
+
+Depending on the type of the field, you can decide to
+- put it in the docstore
+- store it as a fast field
+- index it
+
+Practically, tantivy will push values associated to this type to up to 3 respective
+datastructures.
+
+*Limitations*
+
+As of today, tantivy's schema impose a 1:1 relationship between a field that is being ingested and a field represented in the search index. In sophisticated search application, it is fairly common to want to index a field twice using different tokenizers, or to index the concatenation of several fields together into one field.
+
+This is not something tantivy supports, and it is up to the user to duplicate field / concatenate fields before feeding them to tantivy.
+
+## General information about these datastructures.
+
+All datastructures in tantivy, have:
+- a writer
+- a serializer
+- a reader
+
+The writer builds a in-memory representation of a batch of documents. This representation is not searchable. It is just meant as intermediary mutable representation, to which we can sequentially add
+the document of a batch. At the end of the batch (or if a memory limit is reached), this representation
+is then converted in an on-disk immutable representation, that is extremely compact.
+This conversion is done by the serializer.
+
+Finally, the reader is in charge of offering an API to read on this on-disk read-only representation.
+In tantivy, readers are designed to require very little anonymous memory. The data is read straight from an mmapped file, and loading an index is as fast as mmapping its files.
+
+## [store/](src/store): Here is my DocId, Gimme my document!
+
+The docstore is a row-oriented storage that, for each documents, stores a subset of the fields
+that are marked as stored in the schema. The docstore is compressed using a general purpose algorithm
+like LZ4.
+
+**Useful for**
+
+In search engines, it is often used to display search results.
+Once the top 10 documents have been identified, we fetch them from the store, and display them or their snippet on the search result page (aka SERP).
+
+**Not useful for**
+
+Fetching a document from the store is typically a "slow" operation. It usually consists in
+- searching into a compact tree-like datastructure to find the position of the right block.
+- decompressing a small block
+- returning the document from this block.
+
+It is NOT meant to be called for every document matching a query.
+
+As a rule of thumb, if you hit the docstore more than 100 times per search query, you are probably misusing tantivy.
+
+
+## [fastfield/](src/fastfield): Here is my DocId, Gimme my value!
+
+Fast fields are stored in a column-oriented storage that allows for random access.
+The only compression applied is bitpacking. The column comes with two meta data.
+The minimum value in the column and the number of bits per doc.
+
+Fetching a value for a `DocId` is then as simple as computing
+
+```
+min_value + fetch_bits(num_bits * doc_id..num_bits * (doc_id+1))
+```
+
+This operation just requires one memory fetch.
+Because, DocSets are scanned through in order (DocId are iterated in a sorted manner) which
+also help locality.
+
+In Lucene's jargon, fast fields are called DocValues.
+
+**Useful for**
+
+They are typically integer values that are useful to either rank or compute aggregate over
+all of the documents matching a query (aka [DocSet](src/docset.rs)).
+
+For instance, one could define a function to combine upvotes with tantivy's internal relevancy score.
+This can be done by fetching a fast field during scoring.
+Once could also compute the mean price of the items matching a query in an e-commerce website.
+This can be done by fetching a fast field in a collector.
+Finally one could decide to post filter a docset to remove docset with a price within a specific range.
+If the ratio of filtered out documents is not too low, an efficient way to do this is to fetch the price, and apply the filter on the collector side.
+
+Aside from integer values, it is also possible to store an actual byte payload.
+For advanced search engine, it is possible to store all of the features required for learning-to-rank in a byte payload, access it during search, and apply the learning-to-rank model.
+
+Finally facets are a specific kind of fast field, and the associated source code is in [`fastfield/facet_reader.rs`](src/fastfield/facet_reader.rs).
+
+# The inverted search index.
+
+The inverted index is the core part of full-text search.
+When presented a new document with the text field "Hello, happy tax payer!", tantivy breaks it into a list of so-called token. In addition to just splitting this strings into tokens, it might also do different kind of operations like dropping the punctuation, converting the character to lowercase, apply stemming etc. Tantivy makes it possible to configure the operations to be applied in the schema
+(tokenizer/ is the place where these operations are implemented).
+
+For instance, the default tokenizer of tantivy would break our text into: `[hello, happy, tax, payer]`.
+The document will therefore be registered in the inverted index as containing the terms
+`[text:hello, text:happy, text:tax, text:payer]`.
+
+The role of the inverted index is, when given a term, supply us with a very fast iterator over
+the sorted doc ids that match the term.
+
+Such an iterator is called a posting list. In addition to giving us `DocId`, they can also give us optionally to the number of occurrence of the term for each document, also called term frequency or TF.
+
+These iterators being sorted by DocId, one can create an iterator over the document containing `text:tax AND text:payer`, `(text:tax AND text:payer) OR (text:contribuable)` or any boolean expression.
+
+In order to represent the function
+```Term ⟶ Posting```
+
+The inverted index actually consists of two datastructures chained together.
+
+- [Term](src/schema/term.rs) ⟶ [TermInfo](src/postings/term_info.rs) is addressed by the term dictionary.
+- [TermInfo](src/postings/term_info.rs) ⟶ [Posting](src/postings/postings.rs) is addressed by the posting lists.
+
+Where [TermInfo](src/postings/term_info.rs) is an object containing some meta data about a term.
+
+
+## [termdict/](src/termdict): Here is a term, give me the [TermInfo](src/postings/term_info.rs)!
+
+Tantivy's term dictionary is mainly in charge of supplying the function
+
+[Term](src/schema/term.rs) ⟶ [TermInfo](src/postings/term_info.rs)
+
+It is itself is broken into two parts.
+- [Term](src/schema/term.rs) ⟶ [TermOrdinal](src/termdict/mod.rs) is addressed by a finite state transducer, implemented by the fst crate.
+- [TermOrdinal](src/termdict/mod.rs) ⟶ [TermInfo](src/postings/term_info.rs) is addressed by the term info store.
+
+
+## [postings/](src/postings): Iterate over documents... very fast!
+
+A posting list makes it possible to store a sorted list of doc ids and for each doc store
+a term frequency as well.
+
+The posting list are stored in a separate file. The [TermInfo](src/postings/term_info.rs) contains an offset into that file and a number of documents for the given posting list. Both are required and sufficient to read the posting list.
+
+The posting list is organized in block of 128 documents.
+One block of doc ids is followed by one block of term frequencies.
+
+The doc ids are delta encoded and bitpacked.
+The term frequencies are bitpacked.
+
+Because the number of docs is rarely a multiple of 128, the last block my contain an arbitrary number of docs between 1 and 127 documents. We then use variable int encoding instead of bitpacking.
+
+## [positions/](src/positions): Where are my terms within the documents?
+
+Phrase queries make it possible to search for documents containing a specific sequence of document.
+For instance, when the phrase query "the art of war" does not match "the war of art".
+To make it possible, it is possible to specify in the schema that a field should store positions in addition to being indexed.
+
+The token positions of all of the terms are then stored in a separate file with the extension `.pos`.
+The [TermInfo](src/postings/term_info.rs) gives an offset (expressed in position this time) in this file. As we iterate throught the docset,
+we advance the position reader by the number of term frequencies of the current document.
+
+## [fieldnorms/](src/fieldnorms): Here is my doc, how many tokens in this field?
+
+The [BM25](https://en.wikipedia.org/wiki/Okapi_BM25) formula also requires to know the number of tokens stored in a specific field for a given document. We store this information on one byte per document in the fieldnorm.
+The fieldnorm is therefore compressed. Values up to 40 are encoded unchanged. There is then a logarithmic mapping that
+
+
+## [tokenizer/](src/tokenizer): How should we process text?
+
+Text processing is key to a good search experience.
+Splits or normalize your text too much, and the search results will have a less precision and a higher recall.
+Do not normalize, or under split your text, you will end up with a higher precision and a lesser recall.
+
+Text processing can be configured by selecting an off-the-shelf [`Tokenizer`](./src/tokenizer/tokenizer.rs) or implementing your own to first split the text into tokens, and then chain different [`TokenFilter`](src/tokenizer/tokenizer.rs)'s to it.
+
+Tantivy's comes with few tokenizers, but external crates are offering advanced tokenizers, such as [Lindera](https://crates.io/crates/lindera) for Japanese.
+
+
+## [query/](src/query): Define and compose queries
+
+The [Query](src/query/query.rs) trait defines what a query is.
+Due to the necessity for some query to compute some statistics over the entire index, and because the
+index is composed of several `SegmentReader`, the path from transforming a `Query` to a iterator over document is slightly convoluted, but fundamentally, this is what a Query is.
+
+The iterator over a document comes with some scoring function. The resulting trait is called a
+[Scorer](src/query/scorer.rs) and is specific to a segment.
+
+Different queries can be combined using the [BooleanQuery](src/query/boolean_query/).
+Tantivy comes with different types of queries, and can be extended by implementing
+the Query`, `Weight` and `Scorer` traits.
+
+## [collector](src/collector): Define what to do with matched documents
+
+Collectors define how to aggregate the documents matching a query, in the broadest sense possible.
+The search will push matched document one by one, calling their
+`fn collect(doc: DocId, score: Score);` method.
+
+Users may implement their own collectors by implementing the [Collector](src/collector/mod.rs) trait.
+
+## [query-grammar](query-grammar): Defines the grammar of the query parser
+
+While the [QueryParser](src/query/query_parser/query_parser.rs) struct is located in the `query/` directory, the actual parser combinator used to convert user queries into an AST is in an external crate called `query-grammar`. This part was externalize to lighten the work of the compiler.

AUTHORS

@@ -0,0 +1,11 @@
+# This is the list of authors of tantivy for copyright purposes.
+Paul Masurel
+Laurentiu Nicola
+Dru Sellers
+Ashley Mannix
+Michael J. Curry
+Jason Wolfe
+# As an employee of Google I am required to add Google LLC
+# in the list of authors, but this project is not affiliated to Google
+# in any other way.
+Google LLC 

CHANGELOG.md

@@ -1,3 +1,322 @@
+Tantivy 0.15.0
+=========================
+- API Changes. Using Range instead of (start, end) in the API and internals (`FileSlice`, `OwnedBytes`, `Snippets`, ...)
+  This change is breaking but migration is trivial.
+- Added an Histogram collector. (@fulmicoton) #994
+- Added support for Option<TCollector>.  (@fulmicoton)
+- DocAddress is now a struct (@scampi) #987
+- Bugfix consistent tie break handling in facet's topk (@hardikpnsp) #357
+- Date field support for range queries (@rihardsk) #516
+
+Tantivy 0.14.0
+=========================
+- Remove dependency to atomicwrites #833 .Implemented by @fulmicoton upon suggestion and research from @asafigan).
+- Migrated tantivy error from the now deprecated `failure` crate to `thiserror` #760. (@hirevo)
+- API Change. Accessing the typed value off a `Schema::Value` now returns an Option instead of panicking if the type does not match.
+- Large API Change in the Directory API. Tantivy used to assume that all files could be somehow memory mapped. After this change, Directory return a `FileSlice` that can be reduced and eventually read into an `OwnedBytes` object. Long and blocking io operation are still required by they do not span over the entire file.
+- Added support for Brotli compression in the DocStore. (@ppodolsky)
+- Added helper for building intersections and unions in BooleanQuery (@guilload)
+- Bugfix in `Query::explain`
+- Removed dependency on `notify` #924. Replaced with `FileWatcher` struct that polls meta file every 500ms in background thread. (@halvorboe @guilload)
+- Added `FilterCollector`, which wraps another collector and filters docs using a predicate over a fast field (@barrotsteindev)
+- Simplified the encoding of the skip reader struct. BlockWAND max tf is now encoded over a single byte. (@fulmicoton)
+- `FilterCollector` now supports all Fast Field value types (@barrotsteindev)
+- FastField are not all loaded when opening the segment reader. (@fulmicoton)
+
+This version breaks compatibility and requires users to reindex everything.
+
+Tantivy 0.13.2
+===================
+Bugfix. Acquiring a facet reader on a segment that does not contain any
+doc with this facet returns `None`. (#896)
+
+Tantivy 0.13.1
+===================
+Made `Query` and `Collector` `Send + Sync`.
+Updated misc dependency versions.
+
+Tantivy 0.13.0
+======================
+Tantivy 0.13 introduce a change in the index format that will require
+you to reindex your index (BlockWAND information are added in the skiplist).
+The index size increase is minor as this information is only added for
+full blocks.
+If you have a massive index for which reindexing is not an option, please contact me
+so that we can discuss possible solutions.
+
+- Bugfix in `FuzzyTermQuery` not matching terms by prefix when it should (@Peachball)
+- Relaxed constraints on the custom/tweak score functions. At the segment level, they can be mut, and they are not required to be Sync + Send.
+- `MMapDirectory::open` does not return a `Result` anymore.
+- Change in the DocSet and Scorer API. (@fulmicoton).
+A freshly created DocSet point directly to their first doc. A sentinel value called TERMINATED marks the end of a DocSet.
+`.advance()` returns the new DocId. `Scorer::skip(target)` has been replaced by `Scorer::seek(target)` and returns the resulting DocId.
+As a result, iterating through DocSet now looks as follows
+```rust
+let mut doc = docset.doc();
+while doc != TERMINATED {
+   // ...
+   doc = docset.advance();
+}
+```
+The change made it possible to greatly simplify a lot of the docset's code.
+- Misc internal optimization and introduction of the `Scorer::for_each_pruning` function. (@fulmicoton)
+- Added an offset option to the Top(.*)Collectors. (@robyoung)
+- Added Block WAND. Performance on TOP-K on term-unions should be greatly increased. (@fulmicoton, and special thanks
+to the PISA team for answering all my questions!)
+
+Tantivy 0.12.0
+======================
+- Removing static dispatch in tokenizers for simplicity. (#762)
+- Added backward iteration for `TermDictionary` stream. (@halvorboe)
+- Fixed a performance issue when searching for the posting lists of a missing term (@audunhalland)
+- Added a configurable maximum number of docs (10M by default) for a segment to be considered for merge (@hntd187, landed by @halvorboe #713)
+- Important Bugfix #777, causing tantivy to retain memory mapping. (diagnosed by @poljar)
+- Added support for field boosting. (#547, @fulmicoton)
+
+## How to update?
+
+Crates relying on custom tokenizer, or registering tokenizer in the manager will require some
+minor changes. Check https://github.com/tantivy-search/tantivy/blob/main/examples/custom_tokenizer.rs
+to check for some code sample.
+
+Tantivy 0.11.3
+=======================
+- Fixed DateTime as a fast field (#735)
+
+Tantivy 0.11.2
+=======================
+- The future returned by `IndexWriter::merge` does not borrow `self` mutably anymore (#732)
+- Exposing a constructor for `WatchHandle` (#731)
+
+Tantivy 0.11.1
+=====================
+- Bug fix #729
+
+
+Tantivy 0.11.0
+=====================
+
+- Added f64 field. Internally reuse u64 code the same way i64 does (@fdb-hiroshima)
+- Various bugfixes in the query parser.
+    - Better handling of hyphens in query parser. (#609)
+    - Better handling of whitespaces.
+- Closes #498 - add support for Elastic-style unbounded range queries for alphanumeric types eg. "title:>hello", "weight:>=70.5", "height:<200" (@petr-tik)
+- API change around `Box<BoxableTokenizer>`. See detail in #629
+- Avoid rebuilding Regex automaton whenever a regex query is reused. #639 (@brainlock)
+- Add footer with some metadata to index files. #605 (@fdb-hiroshima)
+- Add a method to check the compatibility of the footer in the index with the running version of tantivy (@petr-tik)
+- TopDocs collector: ensure stable sorting on equal score. #671 (@brainlock)
+- Added handling of pre-tokenized text fields (#642), which will enable users to
+  load tokens created outside tantivy. See usage in examples/pre_tokenized_text. (@kkoziara)
+- Fix crash when committing multiple times with deleted documents. #681 (@brainlock)
+
+## How to update?
+
+- The index format is changed. You are required to reindex your data to use tantivy 0.11.
+- `Box<dyn BoxableTokenizer>` has been replaced by a `BoxedTokenizer` struct.
+- Regex are now compiled when the `RegexQuery` instance is built. As a result, it can now return
+an error and handling the `Result` is required.
+- `tantivy::version()` now returns a `Version` object. This object implements `ToString()`
+
+Tantivy 0.10.2
+=====================
+
+- Closes #656. Solving memory leak.
+
+Tantivy 0.10.1
+=====================
+
+- Closes #544.  A few users experienced problems with the directory watching system.
+Avoid watching the mmap directory until someone effectively creates a reader that uses
+this functionality.
+
+
+Tantivy 0.10.0
+=====================
+
+*Tantivy 0.10.0 index format is compatible with the index format in 0.9.0.*
+
+- Added an API to easily tweak or entirely replace the
+ default score. See `TopDocs::tweak_score`and `TopScore::custom_score` (@fulmicoton)
+- Added an ASCII folding filter (@drusellers)
+- Bugfix in `query.count` in presence of deletes (@fulmicoton)
+- Added `.explain(...)` in `Query` and `Weight` to (@fulmicoton)
+- Added an efficient way to `delete_all_documents` in `IndexWriter` (@petr-tik).
+  All segments are simply removed.
+
+Minor
+---------
+- Switched to Rust 2018 (@uvd)
+- Small simplification of the code.
+Calling .freq() or .doc() when .advance() has never been called
+on segment postings should panic from now on.
+- Tokens exceeding `u16::max_value() - 4` chars are discarded silently instead of panicking.
+- Fast fields are now preloaded when the `SegmentReader` is created.
+- `IndexMeta` is now public.  (@hntd187)
+- `IndexWriter` `add_document`, `delete_term`. `IndexWriter` is `Sync`, making it possible to use it with a `
+Arc<RwLock<IndexWriter>>`. `add_document` and `delete_term` can
+only require a read lock. (@fulmicoton)
+- Introducing `Opstamp` as an expressive type alias for `u64`. (@petr-tik)
+- Stamper now relies on `AtomicU64` on all platforms (@petr-tik)
+- Bugfix - Files get deleted slightly earlier
+- Compilation resources improved (@fdb-hiroshima)
+
+## How to update?
+
+Your program should be usable as is.
+
+### Fast fields
+
+Fast fields used to be accessed directly from the `SegmentReader`.
+The API changed, you are now required to acquire your fast field reader via the
+`segment_reader.fast_fields()`, and use one of the typed method:
+- `.u64()`, `.i64()` if your field is single-valued ;
+- `.u64s()`, `.i64s()` if your field is multi-valued ;
+- `.bytes()` if your field is bytes fast field.
+
+
+
+Tantivy 0.9.0
+=====================
+*0.9.0 index format is not compatible with the
+previous index format.*
+- MAJOR BUGFIX :
+  Some `Mmap` objects were being leaked, and would never get released. (@fulmicoton)
+- Removed most unsafe (@fulmicoton)
+- Indexer memory footprint improved. (VInt comp, inlining the first block. (@fulmicoton)
+- Stemming in other language possible (@pentlander)
+- Segments with no docs are deleted earlier (@barrotsteindev)
+- Added grouped add and delete operations.
+  They are guaranteed to happen together (i.e. they cannot be split by a commit).
+  In addition, adds are guaranteed to happen on the same segment. (@elbow-jason)
+- Removed `INT_STORED` and `INT_INDEXED`. It is now possible to use `STORED` and `INDEXED`
+  for int fields. (@fulmicoton)
+- Added DateTime field (@barrotsteindev)
+- Added IndexReader. By default, index is reloaded automatically upon new commits (@fulmicoton)
+- SIMD linear search within blocks (@fulmicoton)
+
+## How to update ?
+
+tantivy 0.9 brought some API breaking change.
+To update from tantivy 0.8, you will need to go through the following steps.
+
+- `schema::INT_INDEXED` and `schema::INT_STORED`  should be replaced by `schema::INDEXED` and `schema::INT_STORED`.
+- The index now does not hold the pool of searcher anymore. You are required to create an intermediary object called
+`IndexReader` for this.
+
+    ```rust
+    // create the reader. You typically need to create 1 reader for the entire
+    // lifetime of you program.
+    let reader = index.reader()?;
+
+    // Acquire a searcher (previously `index.searcher()`) is now written:
+    let searcher = reader.searcher();
+
+    // With the default setting of the reader, you are not required to
+    // call `index.load_searchers()` anymore.
+    //
+    // The IndexReader will pick up that change automatically, regardless
+    // of whether the update was done in a different process or not.
+    // If this behavior is not wanted, you can create your reader with
+    // the `ReloadPolicy::Manual`, and manually decide when to reload the index
+    // by calling `reader.reload()?`.
+
+    ```
+
+
+Tantivy 0.8.2
+=====================
+Fixing build for x86_64 platforms. (#496)
+No need to update from 0.8.1 if tantivy
+is building on your platform.
+
+
+Tantivy 0.8.1
+=====================
+Hotfix of #476.
+
+Merge was reflecting deletes before commit was passed.
+Thanks @barrotsteindev  for reporting the bug.
+
+
+Tantivy 0.8.0
+=====================
+*No change in the index format*
+- API Breaking change in the collector API. (@jwolfe, @fulmicoton)
+- Multithreaded search (@jwolfe, @fulmicoton)
+
+
+Tantivy 0.7.1
+=====================
+*No change in the index format*
+- Bugfix: NGramTokenizer panics on non ascii chars
+- Added a space usage API
+
+Tantivy 0.7
+=====================
+- Skip data for doc ids and positions (@fulmicoton),
+  greatly improving performance
+- Tantivy error now rely on the failure crate (@drusellers)
+- Added support for `AND`, `OR`, `NOT` syntax in addition to the `+`,`-` syntax
+- Added a snippet generator with highlight (@vigneshsarma, @fulmicoton)
+- Added a `TopFieldCollector` (@pentlander)
+
+Tantivy 0.6.1
+=========================
+- Bugfix #324. GC removing was removing file that were still in useful
+- Added support for parsing AllQuery and RangeQuery via QueryParser
+    - AllQuery: `*`
+    - RangeQuery:
+        - Inclusive `field:[startIncl to endIncl]`
+        - Exclusive `field:{startExcl to endExcl}`
+        - Mixed `field:[startIncl to endExcl}` and vice versa
+        - Unbounded `field:[start to *]`, `field:[* to end]`
+
+
+Tantivy 0.6
+==========================
+
+Special thanks to @drusellers and @jason-wolfe for their contributions
+to this release!
+
+- Removed C code. Tantivy is now pure Rust. (@fulmicoton)
+- BM25 (@fulmicoton)
+- Approximate field norms encoded over 1 byte. (@fulmicoton)
+- Compiles on stable rust (@fulmicoton)
+- Add &[u8] fastfield for associating arbitrary bytes to each document (@jason-wolfe) (#270)
+    - Completely uncompressed
+    - Internally: One u64 fast field for indexes, one fast field for the bytes themselves.
+- Add NGram token support (@drusellers)
+- Add Stopword Filter support (@drusellers)
+- Add a FuzzyTermQuery (@drusellers)
+- Add a RegexQuery (@drusellers)
+- Various performance improvements (@fulmicoton)_
+
+
+Tantivy 0.5.2
+===========================
+- bugfix #274
+- bugfix #280
+- bugfix #289
+
+
+Tantivy 0.5.1
+==========================
+- bugfix #254 : tantivy failed if no documents in a segment contained a specific field.
+
+
+Tantivy 0.5
+==========================
+- Faceting
+- RangeQuery
+- Configurable tokenization pipeline
+- Bugfix in PhraseQuery
+- Various query optimisation
+- Allowing very large indexes
+    - 64 bits file address
+    - Smarter encoding of the `TermInfo` objects
+
+
 
 Tantivy 0.4.3
 ==========================
@@ -57,7 +376,7 @@ Tantivy 0.3
 Special thanks to @Kodraus @lnicola @Ameobea @manuel-woelker @celaus
 for their contribution to this release.
 
-Thanks also to everyone in tantivy gitter chat 
+Thanks also to everyone in tantivy gitter chat
 for their advise and company :)
 
 https://gitter.im/tantivy-search/tantivy
@@ -65,9 +384,9 @@ https://gitter.im/tantivy-search/tantivy
 
 Warning:
 
-Tantivy 0.3 is NOT backward compatible with tantivy 0.2 
+Tantivy 0.3 is NOT backward compatible with tantivy 0.2
 code and index format.
-You should not expect backward compatibility before 
+You should not expect backward compatibility before
 tantivy 1.0.
 
 
@@ -93,7 +412,7 @@ Thanks to @KodrAus ! (#108)
   the natural ordering.
 - Building binary targets for tantivy-cli (Thanks to @KodrAus)
 - Misc invisible bug fixes, and code cleanup.
-- Use 
+- Use
 
 
 

Cargo.toml

@@ -1,72 +1,105 @@
 [package]
 name = "tantivy"
-version = "0.5.0-dev"
+version = "0.14.0"
 authors = ["Paul Masurel <paul.masurel@gmail.com>"]
-build = "build.rs"
 license = "MIT"
 categories = ["database-implementations", "data-structures"]
-description = """Tantivy is a search engine library."""
-documentation = "https://tantivy-search.github.io/tantivy/tantivy/index.html"
+description = """Search engine library"""
+documentation = "https://docs.rs/tantivy/"
 homepage = "https://github.com/tantivy-search/tantivy"
 repository = "https://github.com/tantivy-search/tantivy"
 readme = "README.md"
 keywords = ["search", "information", "retrieval"]
+edition = "2018"
 
 [dependencies]
-byteorder = "1.0"
-memmap = "0.4"
-lazy_static = "0.2.1"
-tinysegmenter = "0.1.0"
-regex = "0.2"
-fst = "0.1.37"
-atomicwrites = "0.1.3"
-tempfile = "2.1"
-log = "0.3.6"
-combine = "2.2"
-tempdir = "0.3"
-serde = "1.0"
-serde_derive = "1.0"
-serde_json = "1.0"
-bincode = "0.8"
-libc = {version = "0.2.20", optional=true}
-num_cpus = "1.2"
-itertools = "0.5.9"
-lz4 = "1.20"
-bit-set = "0.4.0"
-time = "0.1"
-uuid = { version = "0.5", features = ["v4", "serde"] }
-chan = "0.1"
-version = "2"
-crossbeam = "0.3"
-futures = "0.1"
-futures-cpupool = "0.1"
-error-chain = "0.8"
-owning_ref = "0.3"
-stable_deref_trait = "1.0.0"
-rust-stemmers = "0.1.0"
+base64 = "0.13"
+byteorder = "1"
+crc32fast = "1"
+once_cell = "1"
+regex ={version = "1", default-features = false, features = ["std"]}
+tantivy-fst = "0.3"
+memmap = {version = "0.7", optional=true}
+lz4 = {version="1", optional=true}
+brotli = {version="3.3.0", optional=true}
+snap = "1"
+tempfile = {version="3", optional=true}
+log = "0.4"
+serde = {version="1", features=["derive"]}
+serde_json = "1"
+num_cpus = "1"
+fs2={version="0.4", optional=true}
+levenshtein_automata = "0.2"
+uuid = { version = "0.8", features = ["v4", "serde"] }
+crossbeam = "0.8"
+futures = {version = "0.3",  features=["thread-pool"] }
+tantivy-query-grammar = { version="0.14.0", path="./query-grammar" }
+stable_deref_trait = "1"
+rust-stemmers = "1"
+downcast-rs = "1"
+bitpacking = {version="0.8", default-features = false, features=["bitpacker4x"]}
+census = "0.4"
+fnv = "1"
+thiserror = "1.0"
+htmlescape = "0.3"
+fail = "0.4"
+murmurhash32 = "0.2"
+chrono = "0.4"
+smallvec = "1"
+rayon = "1"
+lru = "0.6"
+fastdivide = "0.3"
 
 [target.'cfg(windows)'.dependencies]
-winapi = "0.2"
+winapi = "0.3"
 
 [dev-dependencies]
-rand = "0.3"
-env_logger = "0.4"
+rand = "0.8"
+maplit = "1"
+matches = "0.1.8"
+proptest = "1.0"
+criterion = "0.3"
 
-[build-dependencies]
-cc = {version = "1.0.0", optional=true}
+[dev-dependencies.fail]
+version = "0.4"
+features = ["failpoints"]
 
 [profile.release]
 opt-level = 3
 debug = false
-lto = true
 debug-assertions = false
 
+[profile.test]
+debug-assertions = true
+overflow-checks = true
 
 [features]
-default = ["simdcompression"]
-simdcompression = ["libc", "cc"]
-streamdict = []
+default = ["mmap"]
+mmap = ["fs2", "tempfile", "memmap"]
+brotli-compression = ["brotli"]
+lz4-compression = ["lz4"]
+failpoints = ["fail/failpoints"]
+unstable = [] # useful for benches.
+wasm-bindgen = ["uuid/wasm-bindgen"]
 
+[workspace]
+members = ["query-grammar"]
 
 [badges]
 travis-ci = { repository = "tantivy-search/tantivy" }
+
+# Following the "fail" crate best practises, we isolate
+# tests that define specific behavior in fail check points
+# in a different binary.
+#
+# We do that because, fail rely on a global definition of
+# failpoints behavior and hence, it is incompatible with
+# multithreading.
+[[test]]
+name = "failpoints"
+path = "tests/failpoints/mod.rs"
+required-features = ["fail/failpoints"]
+
+[[bench]]
+name = "analyzer"
+harness = false

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Paul Masurel
+Copyright (c) 2018 by the project authors, as listed in the AUTHORS file. 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Makefile

@@ -0,0 +1,3 @@
+test:
+	echo "Run test only... No examples."
+	cargo test --tests --lib

README.md

@@ -1,60 +1,134 @@
-![Tantivy](https://tantivy-search.github.io/logo/tantivy-logo.png)
 
-[![Build Status](https://travis-ci.org/tantivy-search/tantivy.svg?branch=master)](https://travis-ci.org/tantivy-search/tantivy)
-[![Coverage Status](https://coveralls.io/repos/github/tantivy-search/tantivy/badge.svg?branch=master&refresh1)](https://coveralls.io/github/tantivy-search/tantivy?branch=master)
+[![Build Status](https://travis-ci.org/tantivy-search/tantivy.svg?branch=main)](https://travis-ci.org/tantivy-search/tantivy)
+[![codecov](https://codecov.io/gh/tantivy-search/tantivy/branch/main/graph/badge.svg)](https://codecov.io/gh/tantivy-search/tantivy)
 [![Join the chat at https://gitter.im/tantivy-search/tantivy](https://badges.gitter.im/tantivy-search/tantivy.svg)](https://gitter.im/tantivy-search/tantivy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Build status](https://ci.appveyor.com/api/projects/status/r7nb13kj23u8m9pj?svg=true)](https://ci.appveyor.com/project/fulmicoton/tantivy)
-![beacon for google analytics](https://ga-beacon.appspot.com/UA-88834340-1/tantivy/README)
+[![Build status](https://ci.appveyor.com/api/projects/status/r7nb13kj23u8m9pj/branch/main?svg=true)](https://ci.appveyor.com/project/fulmicoton/tantivy/branch/main)
+[![Crates.io](https://img.shields.io/crates/v/tantivy.svg)](https://crates.io/crates/tantivy)
 
-**Tantivy** is a **full text search engine library** written in rust.
+![Tantivy](https://tantivy-search.github.io/logo/tantivy-logo.png)
 
-It is strongly inspired by Lucene's design.
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/0)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/0)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/1)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/1)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/2)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/2)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/3)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/3)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/4)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/4)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/5)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/5)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/6)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/6)
+[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/7)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/7)
 
+[![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/fulmicoton)
+
+
+**Tantivy** is a **full text search engine library** written in Rust.
+
+It is closer to [Apache Lucene](https://lucene.apache.org/) than to [Elasticsearch](https://www.elastic.co/products/elasticsearch) or [Apache Solr](https://lucene.apache.org/solr/) in the sense it is not
+an off-the-shelf search engine server, but rather a crate that can be used
+to build such a search engine.
+
+Tantivy is, in fact, strongly inspired by Lucene's design.
+
+# Benchmark
+
+The following [benchmark](https://tantivy-search.github.io/bench/) break downs 
+performance for different type of queries / collection.
+
+Your mileage WILL vary depending on the nature of queries and their load.
 
 # Features
 
-- configurable indexing (optional term frequency and position indexing)
-- tf-idf scoring
-- Basic query language
-- Phrase queries
+- Full-text search
+- Configurable tokenizer (stemming available for 17 Latin languages with third party support for Chinese ([tantivy-jieba](https://crates.io/crates/tantivy-jieba) and [cang-jie](https://crates.io/crates/cang-jie)), Japanese ([lindera](https://github.com/lindera-morphology/lindera-tantivy) and [tantivy-tokenizer-tiny-segmente](https://crates.io/crates/tantivy-tokenizer-tiny-segmenter)) and Korean ([lindera](https://github.com/lindera-morphology/lindera-tantivy) + [lindera-ko-dic-builder](https://github.com/lindera-morphology/lindera-ko-dic-builder))
+- Fast (check out the :racehorse: :sparkles: [benchmark](https://tantivy-search.github.io/bench/) :sparkles: :racehorse:)
+- Tiny startup time (<10ms), perfect for command line tools
+- BM25 scoring (the same as Lucene)
+- Natural query language (e.g. `(michael AND jackson) OR "king of pop"`)
+- Phrase queries search (e.g. `"michael jackson"`)
 - Incremental indexing
 - Multithreaded indexing (indexing English Wikipedia takes < 3 minutes on my desktop)
-- mmap based
-- optional SIMD integer compression
-- u64 and i64 fast fields (equivalent of doc values in Lucene)
+- Mmap directory
+- SIMD integer compression when the platform/CPU includes the SSE2 instruction set
+- Single valued and multivalued u64, i64, and f64 fast fields (equivalent of doc values in Lucene)
+- `&[u8]` fast fields
+- Text, i64, u64, f64, dates, and hierarchical facet fields
 - LZ4 compressed document store
+- Range queries
+- Faceted search
+- Configurable indexing (optional term frequency and position indexing)
 - Cheesy logo with a horse
 
-Tantivy supports Linux, MacOS and Windows.
+## Non-features
+
+- Distributed search is out of the scope of Tantivy. That being said, Tantivy is a
+library upon which one could build a distributed search. Serializable/mergeable collector state for instance, 
+are within the scope of Tantivy.
 
 
 # Getting started
 
-- [tantivy's usage example](http://fulmicoton.com/tantivy-examples/simple_search.html)
-- [tantivy-cli and its tutorial](https://github.com/tantivy-search/tantivy-cli).
-It will walk you through getting a wikipedia search engine up and running in a few minutes.
-- [reference doc]
-    - [For the last released version](https://docs.rs/tantivy/)
-    - [For the last master branch](https://tantivy-search.github.io/tantivy/tantivy/index.html)
+Tantivy works on stable Rust (>= 1.27) and supports Linux, MacOS, and Windows.
 
-# Compiling
+- [Tantivy's simple search example](https://tantivy-search.github.io/examples/basic_search.html)
+- [tantivy-cli and its tutorial](https://github.com/tantivy-search/tantivy-cli) - `tantivy-cli` is an actual command line interface that makes it easy for you to create a search engine,
+index documents, and search via the CLI or a small server with a REST API.
+It walks you through getting a wikipedia search engine up and running in a few minutes.
+- [Reference doc for the last released version](https://docs.rs/tantivy/)
 
-Tantivy requires Rust Nightly because it uses requires the features [`box_syntax`](https://doc.rust-lang.org/stable/book/box-syntax-and-patterns.html), [`optin_builtin_traits`](https://github.com/rust-lang/rfcs/blob/master/text/0019-opt-in-builtin-traits.md), and [`conservative_impl_trait`](https://github.com/rust-lang/rfcs/blob/master/text/1522-conservative-impl-trait.md).
-The project can then be built using `cargo`.
+# How can I support this project?
 
-    git clone git@github.com:tantivy-search/tantivy.git
+There are many ways to support this project. 
+
+- Use Tantivy and tell us about your experience on [Gitter](https://gitter.im/tantivy-search/tantivy) or by email (paul.masurel@gmail.com)
+- Report bugs
+- Write a blog post
+- Help with documentation by asking questions or submitting PRs
+- Contribute code (you can join [our Gitter](https://gitter.im/tantivy-search/tantivy))
+- Talk about Tantivy around you
+- [![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/fulmicoton)
+
+# Contributing code
+
+We use the GitHub Pull Request workflow: reference a GitHub ticket and/or include a comprehensive commit message when opening a PR.
+
+## Clone and build locally
+
+Tantivy compiles on stable Rust but requires `Rust >= 1.27`.
+To check out and run tests, you can simply run:
+
+```bash
+    git clone https://github.com/tantivy-search/tantivy.git
     cd tantivy
     cargo build
+```
 
+## Run tests
 
-Alternatively, if you are trying to compile `tantivy` without simd compression,
-you can disable this functionality. In this case, this submodule is not required
-and you can compile tantivy by using the `--no-default-features` flag.
+Some tests will not run with just `cargo test` because of `fail-rs`.
+To run the tests exhaustively, run `./run-tests.sh`.
 
-    cargo build --no-default-features
+## Debug
 
+You might find it useful to step through the programme with a debugger.
 
-# Contribute
+### A failing test
 
-Send me an email (paul.masurel at gmail.com) if you want to contribute to tantivy.
+Make sure you haven't run `cargo clean` after the most recent `cargo test` or `cargo build` to guarantee that the `target/` directory exists. Use this bash script to find the name of the most recent debug build of Tantivy and run it under `rust-gdb`:
+
+```bash
+find target/debug/ -maxdepth 1 -executable -type f -name "tantivy*" -printf '%TY-%Tm-%Td %TT %p\n' | sort -r | cut -d " " -f 3 | xargs -I RECENT_DBG_TANTIVY rust-gdb RECENT_DBG_TANTIVY
+```
+
+Now that you are in `rust-gdb`, you can set breakpoints on lines and methods that match your source code and run the debug executable with flags that you normally pass to `cargo test` like this:
+
+```bash
+$gdb run --test-threads 1 --test $NAME_OF_TEST
+```
+
+### An example
+
+By default, `rustc` compiles everything in the `examples/` directory in debug mode. This makes it easy for you to make examples to reproduce bugs:
+
+```bash
+rust-gdb target/debug/examples/$EXAMPLE_NAME
+$ gdb run
+```

appveyor.yml

@@ -4,11 +4,8 @@
 os: Visual Studio 2015
 environment:
   matrix:
-    - channel: nightly
+    - channel: stable
       target: x86_64-pc-windows-msvc
-    - channel: nightly
-      target: x86_64-pc-windows-gnu
-      msys_bits: 64
 
 install:
   - appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
@@ -21,5 +18,5 @@ install:
 build: false
 
 test_script:
-  - REM SET RUST_LOG=tantivy,test & cargo test --verbose
-  - REM SET RUST_BACKTRACE=1 & cargo run --example simple_search
+  - REM SET RUST_LOG=tantivy,test & cargo test --all --verbose --no-default-features --features mmap
+  - REM SET RUST_BACKTRACE=1 & cargo build --examples

benches/analyzer.rs

@@ -0,0 +1,22 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tantivy::tokenizer::TokenizerManager;
+
+const ALICE_TXT: &'static str = include_str!("alice.txt");
+
+pub fn criterion_benchmark(c: &mut Criterion) {
+    let tokenizer_manager = TokenizerManager::default();
+    let tokenizer = tokenizer_manager.get("default").unwrap();
+    c.bench_function("default-tokenize-alice", |b| {
+        b.iter(|| {
+            let mut word_count = 0;
+            let mut token_stream = tokenizer.token_stream(ALICE_TXT);
+            while token_stream.advance() {
+                word_count += 1;
+            }
+            assert_eq!(word_count, 30_731);
+        })
+    });
+}
+
+criterion_group!(benches, criterion_benchmark);
+criterion_main!(benches);

build.rs

@@ -1,61 +0,0 @@
-#[cfg(feature = "simdcompression")]
-mod build {
-    extern crate cc;
-
-    pub fn build() {
-        let mut config = cc::Build::new();
-        config
-            .include("./cpp/simdcomp/include")
-            .file("cpp/simdcomp/src/avxbitpacking.c")
-            .file("cpp/simdcomp/src/simdintegratedbitpacking.c")
-            .file("cpp/simdcomp/src/simdbitpacking.c")
-            .file("cpp/simdcomp/src/simdpackedsearch.c")
-            .file("cpp/simdcomp/src/simdcomputil.c")
-            .file("cpp/simdcomp/src/simdpackedselect.c")
-            .file("cpp/simdcomp/src/simdfor.c")
-            .file("cpp/simdcomp_wrapper.c");
-
-        if !cfg!(debug_assertions) {
-            config.opt_level(3);
-
-            if cfg!(target_env = "msvc") {
-                config
-                    .define("NDEBUG", None)
-                    .flag("/Gm-")
-                    .flag("/GS-")
-                    .flag("/Gy")
-                    .flag("/Oi")
-                    .flag("/GL");
-            }
-        }
-
-        if !cfg!(target_env = "msvc") {
-            config
-                .include("./cpp/streamvbyte/include")
-                .file("cpp/streamvbyte/src/streamvbyte.c")
-                .file("cpp/streamvbyte/src/streamvbytedelta.c")
-                .flag("-msse4.1")
-                .flag("-march=native")
-                .flag("-std=c99");
-        }
-
-        config.compile("libsimdcomp.a");
-
-        // Workaround for linking static libraries built with /GL
-        // https://github.com/rust-lang/rust/issues/26003
-        if !cfg!(debug_assertions) && cfg!(target_env = "msvc") {
-            println!("cargo:rustc-link-lib=dylib=simdcomp");
-        }
-
-        println!("cargo:rerun-if-changed=cpp");
-    }
-}
-
-#[cfg(not(feature = "simdcompression"))]
-mod build {
-    pub fn build() {}
-}
-
-fn main() {
-    build::build();
-}

ci/before_deploy.ps1

@@ -0,0 +1,23 @@
+# This script takes care of packaging the build artifacts that will go in the
+# release zipfile
+
+$SRC_DIR = $PWD.Path
+$STAGE = [System.Guid]::NewGuid().ToString()
+
+Set-Location $ENV:Temp
+New-Item -Type Directory -Name $STAGE
+Set-Location $STAGE
+
+$ZIP = "$SRC_DIR\$($Env:CRATE_NAME)-$($Env:APPVEYOR_REPO_TAG_NAME)-$($Env:TARGET).zip"
+
+# TODO Update this to package the right artifacts
+Copy-Item "$SRC_DIR\target\$($Env:TARGET)\release\hello.exe" '.\'
+
+7z a "$ZIP" *
+
+Push-AppveyorArtifact "$ZIP"
+
+Remove-Item *.* -Force
+Set-Location ..
+Remove-Item $STAGE
+Set-Location $SRC_DIR

ci/before_deploy.sh

@@ -0,0 +1,33 @@
+# This script takes care of building your crate and packaging it for release
+
+set -ex
+
+main() {
+    local src=$(pwd) \
+          stage=
+
+    case $TRAVIS_OS_NAME in
+        linux)
+            stage=$(mktemp -d)
+            ;;
+        osx)
+            stage=$(mktemp -d -t tmp)
+            ;;
+    esac
+
+    test -f Cargo.lock || cargo generate-lockfile
+
+    # TODO Update this to build the artifacts that matter to you
+    cross rustc --bin hello --target $TARGET --release -- -C lto
+
+    # TODO Update this to package the right artifacts
+    cp target/$TARGET/release/hello $stage/
+
+    cd $stage
+    tar czf $src/$CRATE_NAME-$TRAVIS_TAG-$TARGET.tar.gz *
+    cd $src
+
+    rm -rf $stage
+}
+
+main

ci/install.sh

@@ -0,0 +1,47 @@
+set -ex
+
+main() {
+    local target=
+    if [ $TRAVIS_OS_NAME = linux ]; then
+        target=x86_64-unknown-linux-musl
+        sort=sort
+    else
+        target=x86_64-apple-darwin
+        sort=gsort  # for `sort --sort-version`, from brew's coreutils.
+    fi
+
+    # Builds for iOS are done on OSX, but require the specific target to be
+    # installed.
+    case $TARGET in
+        aarch64-apple-ios)
+            rustup target install aarch64-apple-ios
+            ;;
+        armv7-apple-ios)
+            rustup target install armv7-apple-ios
+            ;;
+        armv7s-apple-ios)
+            rustup target install armv7s-apple-ios
+            ;;
+        i386-apple-ios)
+            rustup target install i386-apple-ios
+            ;;
+        x86_64-apple-ios)
+            rustup target install x86_64-apple-ios
+            ;;
+    esac
+
+    # This fetches latest stable release
+    local tag=$(git ls-remote --tags --refs --exit-code https://github.com/japaric/cross \
+                       | cut -d/ -f3 \
+                       | grep -E '^v[0.1.0-9.]+$' \
+                       | $sort --version-sort \
+                       | tail -n1)
+    curl -LSfs https://japaric.github.io/trust/install.sh | \
+        sh -s -- \
+           --force \
+           --git japaric/cross \
+           --tag $tag \
+           --target $target
+}
+
+main

ci/script.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# This script takes care of testing your crate
+
+set -ex
+
+main() {
+    if [ ! -z $CODECOV ]; then
+        echo "Codecov"
+        cargo build --verbose && cargo coverage --verbose --all && bash <(curl -s https://codecov.io/bash) -s target/kcov
+    else
+        echo "Build"
+        cross build --target $TARGET
+        if [ ! -z $DISABLE_TESTS ]; then
+            return
+        fi
+        echo "Test"
+        cross test --target $TARGET --no-default-features --features mmap
+        cross test --target $TARGET --no-default-features --features mmap query-grammar
+    fi
+    for example in $(ls examples/*.rs)
+    do
+        cargo run --example  $(basename $example .rs)
+    done
+}
+
+# we don't run the "test phase" when doing deploys
+if [ -z $TRAVIS_TAG ]; then
+    main
+fi

cpp/simdcomp/.gitignore

@@ -1,9 +0,0 @@
-Makefile.in
-lib*
-unit*
-*.o
-src/*.lo
-src/*.o
-src/.deps
-src/.dirstamp
-src/.libs

cpp/simdcomp/.travis.yml

@@ -1,11 +0,0 @@
-language: c
-sudo: false
-compiler:
-  - gcc
-  - clang
-
-branches:
-  only:
-    - master
-
-script: make && ./unit

cpp/simdcomp/CHANGELOG

@@ -1,9 +0,0 @@
-Upcoming
-  - added missing include
-  - improved portability (MSVC)
-  - implemented C89 compatibility
-Version 0.0.3 (19 May 2014)
-  - improved documentation
-Version 0.0.2 (6 February 2014)
-  - added go demo
-Version 0.0.1  (5 February 2014)

cpp/simdcomp/LICENSE

@@ -1,27 +0,0 @@
-Copyright (c) 2014--, The authors
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
-
-* Neither the name of the {organization} nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cpp/simdcomp/README.md

@@ -1,137 +0,0 @@
-The SIMDComp library
-====================
-[![Build Status](https://travis-ci.org/lemire/simdcomp.png)](https://travis-ci.org/lemire/simdcomp)
-
-A simple C library for compressing lists of integers using binary packing and SIMD instructions.
-The assumption is either that you have a list of 32-bit integers where most of them are small, or a list of 32-bit integers where differences between successive integers are small. No software is able to reliably compress an array of 32-bit random numbers.
-
-This library can decode at least 4 billions of compressed integers per second on most
-desktop or laptop processors. That is, it can decompress data at a rate of 15 GB/s.
-This is significantly faster than generic codecs like gzip, LZO, Snappy or LZ4.
-
-On a Skylake Intel processor, it can decode integers at a rate 0.3 cycles per integer,
-which can easily translate into more than 8 decoded billions integers per second.
-
-Contributors: Daniel Lemire, Nathan Kurz, Christoph Rupp, Anatol Belski, Nick White and others
-
-What is it for?
--------------
-
-This is a low-level library for fast integer compression. By design it does not define a compressed
-format. It is up to the (sophisticated) user to create a compressed format.
-
-Requirements
--------------
-
-- Your processor should support SSE4.1 (It is supported by most Intel and AMD processors released since 2008.)
-- It is possible to build the core part of the code if your processor support SSE2 (Pentium4 or better)
-- C99 compliant compiler (GCC is assumed)
-- A Linux-like distribution is assumed by the makefile
-
-For a plain C version that does not use SIMD instructions, see https://github.com/lemire/LittleIntPacker
-
-Usage
--------
-
-Compression works over blocks of 128 integers.
-
-For a complete working example, see example.c (you can build it and
-run it with "make example; ./example").
-
-
-
-1) Lists of integers in random order.
-
-```C            
-const uint32_t b = maxbits(datain);// computes bit width
-simdpackwithoutmask(datain, buffer, b);//compressed to buffer, compressing 128 32-bit integers down to b*32 bytes
-simdunpack(buffer, backbuffer, b);//uncompressed to backbuffer
-```
-
-While 128 32-bit integers are read, only b 128-bit words are written. Thus, the compression ratio is 32/b.
-
-2) Sorted lists of integers.
-
-We used differential coding: we store the difference between successive integers. For this purpose, we need an initial value (called offset).
-
-```C            
-uint32_t offset = 0;
-uint32_t b1 = simdmaxbitsd1(offset,datain); // bit width
-simdpackwithoutmaskd1(offset, datain, buffer, b1);//compressing 128 32-bit integers down to b1*32 bytes
-simdunpackd1(offset, buffer, backbuffer, b1);//uncompressed
-```
-
-General example for arrays of arbitrary length:
-```C
-int compress_decompress_demo() {
-  size_t k, N = 9999;
-  __m128i * endofbuf;
-  uint32_t * datain = malloc(N * sizeof(uint32_t));
-  uint8_t * buffer;
-  uint32_t * backbuffer = malloc(N * sizeof(uint32_t));
-  uint32_t b;
-
-  for (k = 0; k < N; ++k){        /* start with k=0, not k=1! */
-    datain[k] = k;
-  }
-
-  b = maxbits_length(datain, N);
-  buffer = malloc(simdpack_compressedbytes(N,b)); // allocate just enough memory
-  endofbuf = simdpack_length(datain, N, (__m128i *)buffer, b);
-  /* compressed data is stored between buffer and endofbuf using (endofbuf-buffer)*sizeof(__m128i) bytes */
-  /* would be safe to do : buffer = realloc(buffer,(endofbuf-(__m128i *)buffer)*sizeof(__m128i)); */
-  simdunpack_length((const __m128i *)buffer, N, backbuffer, b);
-
-  for (k = 0; k < N; ++k){
-    if(datain[k] != backbuffer[k]) {
-      printf("bug\n");
-      return -1;
-    }
-  }
-  return 0;
-}
-```
-
-
-3) Frame-of-Reference 
-
-We also have frame-of-reference (FOR) functions (see simdfor.h header). They work like the bit packing
-routines, but do not use differential coding so they allow faster search in some cases, at the expense
-of compression.
-
-Setup
----------
-
-
-make
-make test
-
-and if you are daring:
-
-make install
-
-Go
---------
-
-If you are a go user, there is a "go" folder where you will find a simple demo.
-
-Other libraries
-----------------
-
-* Fast decoder for VByte-compressed integers https://github.com/lemire/MaskedVByte
-* Fast integer compression in C using StreamVByte https://github.com/lemire/streamvbyte
-* FastPFOR is a C++ research library well suited to compress unsorted arrays: https://github.com/lemire/FastPFor
-* SIMDCompressionAndIntersection is a C++ research library well suited for sorted arrays (differential coding)
-and computing intersections: https://github.com/lemire/SIMDCompressionAndIntersection
-* TurboPFor is a C library that offers lots of interesting optimizations. Well worth checking! (GPL license) https://github.com/powturbo/TurboPFor
-* Oroch is a C++ library that offers a usable API (MIT license) https://github.com/ademakov/Oroch
-
-
-References
-------------
-
-* Daniel Lemire, Leonid Boytsov, Nathan Kurz, SIMD Compression and the Intersection of Sorted Integers, Software Practice & Experience 46 (6) 2016. http://arxiv.org/abs/1401.6399
-* Daniel Lemire and Leonid Boytsov, Decoding billions of integers per second through vectorization, Software Practice & Experience 45 (1), 2015.  http://arxiv.org/abs/1209.2137 http://onlinelibrary.wiley.com/doi/10.1002/spe.2203/abstract
-* Jeff Plaisance, Nathan Kurz, Daniel Lemire, Vectorized VByte Decoding, International Symposium on Web Algorithms 2015, 2015. http://arxiv.org/abs/1503.07387
-* Wayne Xin Zhao, Xudong Zhang, Daniel Lemire, Dongdong Shan, Jian-Yun Nie, Hongfei Yan, Ji-Rong Wen, A General SIMD-based Approach to Accelerating Compression Algorithms, ACM Transactions on Information Systems 33 (3), 2015. http://arxiv.org/abs/1502.01916
-* T. D. Wu, Bitpacking techniques for indexing genomes: I. Hash tables, Algorithms for Molecular Biology 11 (5), 2016. http://almob.biomedcentral.com/articles/10.1186/s13015-016-0069-5

cpp/simdcomp/benchmarks/benchmark.c

@@ -1,235 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#include <assert.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <time.h>
-
-#include "simdcomp.h"
-
-#ifdef _MSC_VER
-# include <windows.h>
-
-__int64 freq;
-
-typedef __int64 time_snap_t;
-
-static time_snap_t time_snap(void)
-{
-	__int64 now;
-
-	QueryPerformanceCounter((LARGE_INTEGER *)&now);
-
-	return (__int64)((now*1000000)/freq);
-}
-# define TIME_SNAP_FMT "%I64d"
-#else
-# define time_snap clock
-# define TIME_SNAP_FMT "%lu"
-typedef clock_t time_snap_t;
-#endif
-
-
-void benchmarkSelect() {
-    uint32_t buffer[128];
-    uint32_t backbuffer[128];
-    uint32_t initial = 33;
-    uint32_t b;
-    time_snap_t S1, S2, S3;
-    int i;
-    printf("benchmarking select \n");
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 0; b <= 32; b++) {
-        uint32_t prev = initial;
-        uint32_t out[128];
-        /* initialize the buffer */
-        for (i = 0; i < 128; i++) {
-            buffer[i] =  ((uint32_t)(1655765 * i )) ;
-            if(b < 32) buffer[i] %= (1<<b);
-        }
-        for (i = 0; i < 128; i++) {
-            buffer[i] = buffer[i] + prev;
-            prev = buffer[i];
-        }
-
-        for (i = 1; i < 128; i++) {
-            if(buffer[i] < buffer[i-1] )
-                buffer[i] = buffer[i-1];
-        }
-        assert(simdmaxbitsd1(initial, buffer)<=b);
-
-        for (i = 0; i < 128; i++) {
-            out[i] = 0; /* memset would do too */
-        }
-
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(initial, buffer, (__m128i *)out, b);
-
-        S1 = time_snap();
-        for (i = 0; i < 128 * 10; i++) {
-            uint32_t valretrieved = simdselectd1(initial, (__m128i *)out, b, (uint32_t)i % 128);
-            assert(valretrieved == buffer[i%128]);
-        }
-        S2 = time_snap();
-        for (i = 0; i < 128 * 10; i++) {
-            simdunpackd1(initial,  (__m128i *)out, backbuffer, b);
-            assert(backbuffer[i % 128] == buffer[i % 128]);
-        }
-        S3 = time_snap();
-        printf("bit width = %d, fast select function time = " TIME_SNAP_FMT ", naive time = " TIME_SNAP_FMT "  \n", b, (S2-S1), (S3-S2));
-    }
-}
-
-int uint32_cmp(const void *a, const void *b)
-{
-    const uint32_t *ia = (const uint32_t *)a;
-    const uint32_t *ib = (const uint32_t *)b;
-    if(*ia < *ib)
-        return -1;
-    else if (*ia > *ib)
-        return 1;
-    return 0;
-}
-
-/* adapted from wikipedia */
-int binary_search(uint32_t * A, uint32_t key, int imin, int imax)
-{
-    int imid;
-    imax --;
-    while(imin + 1 < imax) {
-        imid = imin + ((imax - imin) / 2);
-
-        if (A[imid] > key) {
-            imax = imid;
-        } else if (A[imid] < key) {
-            imin = imid;
-        } else {
-            return imid;
-        }
-    }
-    return imax;
-}
-
-
-/* adapted from wikipedia */
-int lower_bound(uint32_t * A, uint32_t key, int imin, int imax)
-{
-    int imid;
-    imax --;
-    while(imin + 1 < imax) {
-        imid = imin + ((imax - imin) / 2);
-
-        if (A[imid] >= key) {
-            imax = imid;
-        } else if (A[imid] < key) {
-            imin = imid;
-        }
-    }
-    if(A[imin] >= key) return imin;
-    return imax;
-}
-
-void benchmarkSearch() {
-    uint32_t buffer[128];
-    uint32_t backbuffer[128];
-    uint32_t out[128];
-    uint32_t result, initial = 0;
-    uint32_t b, i;
-    time_snap_t S1, S2, S3, S4;
-
-    printf("benchmarking search \n");
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 0; b <= 32; b++) {
-        uint32_t prev = initial;
-        /* initialize the buffer */
-        for (i = 0; i < 128; i++) {
-            buffer[i] =  ((uint32_t)rand()) ;
-            if(b < 32) buffer[i] %= (1<<b);
-        }
-
-        qsort(buffer,128, sizeof(uint32_t), uint32_cmp);
-
-        for (i = 0; i < 128; i++) {
-            buffer[i] = buffer[i] + prev;
-            prev = buffer[i];
-        }
-        for (i = 1; i < 128; i++) {
-            if(buffer[i] < buffer[i-1] )
-                buffer[i] = buffer[i-1];
-        }
-        assert(simdmaxbitsd1(initial, buffer)<=b);
-        for (i = 0; i < 128; i++) {
-            out[i] = 0; /* memset would do too */
-        }
-
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(initial, buffer, (__m128i *)out, b);
-        simdunpackd1(initial,  (__m128i *)out, backbuffer, b);
-
-        for (i = 0; i < 128; i++) {
-            assert(buffer[i] == backbuffer[i]);
-         }
-        S1 = time_snap();
-        for (i = 0; i < 128 * 10; i++) {
-
-            int pos;
-            uint32_t pseudorandomkey  =  buffer[i%128];
-            __m128i vecinitial = _mm_set1_epi32(initial);
-            pos = simdsearchd1(&vecinitial, (__m128i *)out, b,
-                               pseudorandomkey, &result);
-            if((result < pseudorandomkey) || (buffer[pos] != result)) {
-                printf("bug A.\n");
-            } else if (pos > 0) {
-                if(buffer[pos-1] >= pseudorandomkey)
-                    printf("bug B.\n");
-            }
-        }
-        S2 = time_snap();
-        for (i = 0; i < 128 * 10; i++) {
-            int pos;
-            uint32_t pseudorandomkey  =  buffer[i%128];
-            simdunpackd1(initial,  (__m128i *)out, backbuffer, b);
-            pos =  lower_bound(backbuffer, pseudorandomkey, 0, 128);
-            result = backbuffer[pos];
-
-            if((result < pseudorandomkey) || (buffer[pos] != result)) {
-                printf("bug C.\n");
-            } else if (pos > 0) {
-                if(buffer[pos-1] >= pseudorandomkey)
-                    printf("bug D.\n");
-            }
-        }
-        S3 = time_snap();
-        for (i = 0; i < 128 * 10; i++) {
-
-            int pos;
-            uint32_t pseudorandomkey  =  buffer[i%128];
-            pos = simdsearchwithlengthd1(initial, (__m128i *)out, b, 128,
-                               pseudorandomkey, &result);
-            if((result < pseudorandomkey) || (buffer[pos] != result)) {
-                printf("bug A.\n");
-            } else if (pos > 0) {
-                if(buffer[pos-1] >= pseudorandomkey)
-                    printf("bug B.\n");
-            }
-        }
-        S4 = time_snap();
-
-        printf("bit width = %d, fast search function time = " TIME_SNAP_FMT ", naive time = " TIME_SNAP_FMT " , fast with length time = " TIME_SNAP_FMT "  \n", b, (S2-S1), (S3-S2), (S4-S3) );
-    }
-}
-
-
-int main() {
-#ifdef _MSC_VER
-    QueryPerformanceFrequency((LARGE_INTEGER *)&freq);
-#endif
-    benchmarkSearch();
-    benchmarkSelect();
-    return 0;
-}

cpp/simdcomp/benchmarks/bitpackingbenchmark.c

@@ -1,205 +0,0 @@
-#include <stdio.h>
-
-#include "simdcomp.h"
-
-
-#define RDTSC_START(cycles)                                                   \
-    do {                                                                      \
-        register unsigned cyc_high, cyc_low;                                  \
-        __asm volatile(                                                       \
-            "cpuid\n\t"                                                       \
-            "rdtsc\n\t"                                                       \
-            "mov %%edx, %0\n\t"                                               \
-            "mov %%eax, %1\n\t"                                               \
-            : "=r"(cyc_high), "=r"(cyc_low)::"%rax", "%rbx", "%rcx", "%rdx"); \
-        (cycles) = ((uint64_t)cyc_high << 32) | cyc_low;                      \
-    } while (0)
-
-#define RDTSC_FINAL(cycles)                                                   \
-    do {                                                                      \
-        register unsigned cyc_high, cyc_low;                                  \
-        __asm volatile(                                                       \
-            "rdtscp\n\t"                                                      \
-            "mov %%edx, %0\n\t"                                               \
-            "mov %%eax, %1\n\t"                                               \
-            "cpuid\n\t"                                                       \
-            : "=r"(cyc_high), "=r"(cyc_low)::"%rax", "%rbx", "%rcx", "%rdx"); \
-        (cycles) = ((uint64_t)cyc_high << 32) | cyc_low;                      \
-    } while (0)
-
-
-
-
-uint32_t * get_random_array_from_bit_width(uint32_t length, uint32_t bit) {
-    uint32_t * answer = malloc(sizeof(uint32_t) * length);
-    uint32_t mask = (uint32_t) ((UINT64_C(1) << bit) - 1);
-    uint32_t i;
-    for(i = 0; i < length; ++i) {
-        answer[i] = rand() & mask;
-    }
-    return answer;
-}
-
-uint32_t * get_random_array_from_bit_width_d1(uint32_t length, uint32_t bit) {
-    uint32_t * answer = malloc(sizeof(uint32_t) * length);
-    uint32_t mask = (uint32_t) ((UINT64_C(1) << bit) - 1);
-    uint32_t i;
-    answer[0] = rand() & mask;
-    for(i = 1; i < length; ++i) {
-        answer[i] = answer[i-1] + (rand() & mask);
-    }
-    return answer;
-}
-
-
-void demo128() {
-    const uint32_t length = 128;
-    uint32_t bit;
-    printf("# --- %s\n", __func__);
-    printf("# compressing %d integers\n",length);
-    printf("# format: bit width, pack in cycles per int, unpack in cycles per int\n");
-    for(bit = 1; bit <= 32; ++bit) {
-        uint32_t i;
-
-        uint32_t * data = get_random_array_from_bit_width(length, bit);
-        __m128i * buffer = malloc(length * sizeof(uint32_t));
-        uint32_t * backdata = malloc(length * sizeof(uint32_t));
-        uint32_t repeat = 500;
-        uint64_t min_diff;
-        printf("%d\t",bit);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            simdpackwithoutmask(data,buffer, bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            simdunpack(buffer, backdata,bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-
-        free(data);
-        free(buffer);
-        free(backdata);
-        printf("\n");
-    }
-    printf("\n\n"); /* two blank lines are required by gnuplot */
-}
-
-void demo128_d1() {
-    const uint32_t length = 128;
-    uint32_t bit;
-    printf("# --- %s\n", __func__);
-    printf("# compressing %d integers\n",length);
-    printf("# format: bit width, pack in cycles per int, unpack in cycles per int\n");
-    for(bit = 1; bit <= 32; ++bit) {
-        uint32_t i;
-
-        uint32_t * data = get_random_array_from_bit_width_d1(length, bit);
-        __m128i * buffer = malloc(length * sizeof(uint32_t));
-        uint32_t * backdata = malloc(length * sizeof(uint32_t));
-        uint32_t repeat = 500;
-        uint64_t min_diff;
-        printf("%d\t",bit);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            simdpackwithoutmaskd1(0,data,buffer, bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            simdunpackd1(0,buffer, backdata,bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-
-        free(data);
-        free(buffer);
-        free(backdata);
-        printf("\n");
-    }
-    printf("\n\n"); /* two blank lines are required by gnuplot */
-}
-
-#ifdef __AVX2__
-void demo256() {
-    const uint32_t length = 256;
-    uint32_t bit;
-    printf("# --- %s\n", __func__);
-    printf("# compressing %d integers\n",length);
-    printf("# format: bit width, pack in cycles per int, unpack in cycles per int\n");
-    for(bit = 1; bit <= 32; ++bit) {
-        uint32_t i;
-
-        uint32_t * data = get_random_array_from_bit_width(length, bit);
-        __m256i * buffer = malloc(length * sizeof(uint32_t));
-        uint32_t * backdata = malloc(length * sizeof(uint32_t));
-        uint32_t repeat = 500;
-        uint64_t min_diff;
-        printf("%d\t",bit);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            avxpackwithoutmask(data,buffer, bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-        min_diff = (uint64_t)-1;
-        for (i = 0; i < repeat; i++) {
-            uint64_t cycles_start, cycles_final, cycles_diff;
-            __asm volatile("" ::: /* pretend to clobber */ "memory");
-            RDTSC_START(cycles_start);
-            avxunpack(buffer, backdata,bit);
-            RDTSC_FINAL(cycles_final);
-            cycles_diff = (cycles_final - cycles_start);
-            if (cycles_diff < min_diff) min_diff = cycles_diff;
-        }
-        printf("%.2f\t",min_diff*1.0/length);
-
-        free(data);
-        free(buffer);
-        free(backdata);
-        printf("\n");
-    }
-    printf("\n\n"); /* two blank lines are required by gnuplot */
-}
-#endif /* avx 2 */
-
-
-int main() {
-    demo128();
-    demo128_d1();
-#ifdef __AVX2__
-    demo256();
-#endif
-    return 0;
-
-
-}

cpp/simdcomp/example.c

@@ -1,195 +0,0 @@
-/* Type "make example" to build this example program. */
-#include <stdio.h>
-#include <time.h>
-#include <stdlib.h>
-#include "simdcomp.h"
-
-/**
-We provide several different code examples.
-**/
-
-
-/* very simple test to illustrate a simple application */
-int compress_decompress_demo() {
-    size_t k, N = 9999;
-    __m128i * endofbuf;
-    int howmanybytes;
-    float compratio;
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    uint8_t * buffer;
-    uint32_t * backbuffer = malloc(N * sizeof(uint32_t));
-    uint32_t b;
-    printf("== simple test\n");
-
-    for (k = 0; k < N; ++k) {       /* start with k=0, not k=1! */
-        datain[k] = k;
-    }
-
-    b = maxbits_length(datain, N);
-    buffer = malloc(simdpack_compressedbytes(N,b));
-    endofbuf = simdpack_length(datain, N, (__m128i *)buffer, b);
-    howmanybytes = (endofbuf-(__m128i *)buffer)*sizeof(__m128i); /* number of compressed bytes */
-    compratio = N*sizeof(uint32_t) * 1.0 / howmanybytes;
-    /* endofbuf points to the end of the compressed data */
-    buffer = realloc(buffer,(endofbuf-(__m128i *)buffer)*sizeof(__m128i)); /* optional but safe. */
-    printf("Compressed %d integers down to %d bytes (comp. ratio = %f).\n",(int)N,howmanybytes,compratio);
-    /* in actual applications b must be stored and retrieved: caller is responsible for that. */
-    simdunpack_length((const __m128i *)buffer, N, backbuffer, b); /* will return a pointer to endofbuf */ 
-
-    for (k = 0; k < N; ++k) {
-        if(datain[k] != backbuffer[k]) {
-            printf("bug at %lu \n",(unsigned long)k);
-            return -1;
-        }
-    }
-    printf("Code works!\n");
-    free(datain);
-    free(buffer);
-    free(backbuffer);
-    return 0;
-}
-
-
-
-/* compresses data from datain to buffer, returns how many bytes written
-used below in simple_demo */
-size_t compress(uint32_t * datain, size_t length, uint8_t * buffer) {
-    uint32_t offset;
-    uint8_t * initout;
-    size_t k;
-    if(length/SIMDBlockSize*SIMDBlockSize != length) {
-        printf("Data length should be a multiple of %i \n",SIMDBlockSize);
-    }
-    offset = 0;
-    initout = buffer;
-    for(k = 0; k < length / SIMDBlockSize; ++k) {
-        uint32_t b = simdmaxbitsd1(offset,
-                                   datain + k * SIMDBlockSize);
-        *buffer++ = b;
-        simdpackwithoutmaskd1(offset, datain + k * SIMDBlockSize, (__m128i *) buffer,
-                              b);
-        offset = datain[k * SIMDBlockSize + SIMDBlockSize - 1];
-        buffer += b * sizeof(__m128i);
-    }
-    return buffer - initout;
-}
-
-/* Another illustration ... */
-void simple_demo() {
-    size_t REPEAT = 10, gap;
-    size_t N = 1000 * SIMDBlockSize;/* SIMDBlockSize is 128 */
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    size_t compsize;
-    clock_t start, end;
-    uint8_t * buffer = malloc(N * sizeof(uint32_t) + N / SIMDBlockSize); /* output buffer */
-    uint32_t * backbuffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    printf("== simple demo\n");
-    for (gap = 1; gap <= 243; gap *= 3) {
-        size_t k, repeat;
-        uint32_t offset = 0;
-        uint32_t bogus = 0;
-        double numberofseconds;
-
-        printf("\n");
-        printf(" gap = %lu \n", (unsigned long) gap);
-        datain[0] = 0;
-        for (k = 1; k < N; ++k)
-            datain[k] = datain[k-1] + ( rand() % (gap + 1) );
-        compsize = compress(datain,N,buffer);
-        printf("compression ratio = %f \n",  (N * sizeof(uint32_t))/ (compsize * 1.0 ));
-        start = clock();
-        for(repeat = 0; repeat < REPEAT; ++repeat) {
-            uint8_t * decbuffer = buffer;
-            for (k = 0; k * SIMDBlockSize < N; ++k) {
-                uint8_t b = *decbuffer++;
-                simdunpackd1(offset, (__m128i *) decbuffer, backbuffer, b);
-                /* do something here with backbuffer */
-                bogus += backbuffer[3];
-                decbuffer += b * sizeof(__m128i);
-                offset = backbuffer[SIMDBlockSize - 1];
-            }
-        }
-        end = clock();
-        numberofseconds = (end-start)/(double)CLOCKS_PER_SEC;
-        printf("decoding speed in million of integers per second %f \n",N*REPEAT/(numberofseconds*1000.0*1000.0));
-        start = clock();
-        for(repeat = 0; repeat < REPEAT; ++repeat) {
-            uint8_t * decbuffer = buffer;
-            for (k = 0; k * SIMDBlockSize < N; ++k) {
-                memcpy(backbuffer,decbuffer+k*SIMDBlockSize,SIMDBlockSize*sizeof(uint32_t));
-                bogus += backbuffer[3] - backbuffer[100];
-            }
-        }
-        end = clock();
-        numberofseconds = (end-start)/(double)CLOCKS_PER_SEC;
-        printf("memcpy speed in million of integers per second %f \n",N*REPEAT/(numberofseconds*1000.0*1000.0));
-        printf("ignore me %i \n",bogus);
-        printf("All tests are in CPU cache. Avoid out-of-cache decoding in applications.\n");
-    }
-    free(buffer);
-    free(datain);
-    free(backbuffer);
-}
-
-/* Used below in more_sophisticated_demo ... */
-size_t varying_bit_width_compress(uint32_t * datain, size_t length, uint8_t * buffer) {
-    uint8_t * initout;
-    size_t k;
-    if(length/SIMDBlockSize*SIMDBlockSize != length) {
-        printf("Data length should be a multiple of %i \n",SIMDBlockSize);
-    }
-    initout = buffer;
-    for(k = 0; k < length / SIMDBlockSize; ++k) {
-        uint32_t b = maxbits(datain);
-        *buffer++ = b;
-        simdpackwithoutmask(datain, (__m128i *)buffer, b);
-        datain += SIMDBlockSize;
-        buffer += b * sizeof(__m128i);
-    }
-    return buffer - initout;
-}
-
-/* Here we compress the data in blocks of 128 integers with varying bit width */
-int varying_bit_width_demo() {
-    size_t nn = 128 * 2;
-    uint32_t * datainn = malloc(nn * sizeof(uint32_t));
-    uint8_t * buffern = malloc(nn * sizeof(uint32_t) + nn / SIMDBlockSize);
-    uint8_t * initbuffern = buffern;
-    uint32_t * backbuffern = malloc(nn * sizeof(uint32_t));
-    size_t k, compsize;
-    printf("== varying bit-width demo\n");
-
-    for(k=0; k<nn; ++k) {
-        datainn[k] = rand() % (k + 1);
-    }
-
-    compsize = varying_bit_width_compress(datainn,nn,buffern);
-    printf("encoded size: %u (original size: %u)\n", (unsigned)compsize,
-           (unsigned)(nn * sizeof(uint32_t)));
-
-    for (k = 0; k * SIMDBlockSize < nn; ++k) {
-        uint32_t b = *buffern;
-        buffern++;
-        simdunpack((const __m128i *)buffern, backbuffern + k * SIMDBlockSize, b);
-        buffern += b * sizeof(__m128i);
-    }
-
-    for (k = 0; k < nn; ++k) {
-        if(backbuffern[k] != datainn[k]) {
-            printf("bug\n");
-            return -1;
-        }
-    }
-    printf("Code works!\n");
-    free(datainn);
-    free(initbuffern);
-    free(backbuffern);
-    return 0;
-}
-
-int main() {
-    if(compress_decompress_demo() != 0) return -1;
-    if(varying_bit_width_demo() != 0) return -1;
-    simple_demo();
-    return 0;
-}

cpp/simdcomp/go/README.md

@@ -1,13 +0,0 @@
-Simple Go demo
-==============
-
-Setup
-======
-
-Start by installing the simdcomp library (make && make install).
-
-Then type:
-
-go run test.go
-
-

cpp/simdcomp/go/test.go

@@ -1,71 +0,0 @@
-/////////
-// This particular file is in the public domain.
-// Author: Daniel Lemire
-////////
-
-package main 
-
-/*
-#cgo LDFLAGS: -lsimdcomp
-#include <simdcomp.h>
-*/
-import "C"
-import "fmt"
-
-//////////
-// For this demo, we pack and unpack blocks of 128 integers
-/////////
-func main() {
-        // I am going to use C types. Alternative might be to use unsafe.Pointer calls, see http://bit.ly/1ndw3W3
-        // this is our original data
-        var data [128]C.uint32_t
-        for i := C.uint32_t(0); i < C.uint32_t(128); i++ {
-            data[i] = i
-        }
-
-
-
-
-
-        ////////////
-        // We first pack without differential coding
-        ///////////
-        // computing how many bits per int. is needed
-        b  := C.maxbits(&data[0])
-        ratio := 32.0/float64(b)
-        fmt.Println("Bit width  ", b)
-        fmt.Println(fmt.Sprintf("Compression ratio %f ", ratio))
-         // we are now going to create a buffer to receive the packed data (each __m128i uses 128 bits)
-        out := make([] C.__m128i,b)       
-        C.simdpackwithoutmask( &data[0],&out[0],b);
-        var recovereddata [128]C.uint32_t
-        C.simdunpack(&out[0],&recovereddata[0],b)
-        for i := 0; i < 128; i++ {
-            if data[i] != recovereddata[i]  {
-                  fmt.Println("Bug ")
-                  return
-            }
-        } 
-
-        ///////////
-        // Next, we use differential coding
-        //////////
-        offset := C.uint32_t(0) // if you pack data from K to K + 128, offset should be the value at K-1. When K = 0, choose a default
-        b1  := C.simdmaxbitsd1(offset,&data[0])
-        ratio1 := 32.0/float64(b1)
-        fmt.Println("Bit width  ", b1)
-        fmt.Println(fmt.Sprintf("Compression ratio %f ", ratio1))
-         // we are now going to create a buffer to receive the packed data (each __m128i uses 128 bits)
-        out = make([] C.__m128i,b1)       
-        C.simdpackwithoutmaskd1(offset, &data[0],&out[0],b1);
-        C.simdunpackd1(offset,&out[0],&recovereddata[0],b1)
-        for i := 0; i < 128; i++ {
-            if data[i] != recovereddata[i]  {
-                  fmt.Println("Bug ")
-                  return
-            }
-        } 
-
-        fmt.Println("test succesful.")
-      
-}

cpp/simdcomp/include/avxbitpacking.h

@@ -1,40 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-
-#ifndef INCLUDE_AVXBITPACKING_H_
-#define INCLUDE_AVXBITPACKING_H_
-
-
-#ifdef __AVX2__
-
-#include "portability.h"
-
-
-/* AVX2 is required */
-#include <immintrin.h>
-/* for memset */
-#include <string.h>
-
-#include "simdcomputil.h"
-
-enum{ AVXBlockSize = 256};
-
-/* max integer logarithm over a range of AVXBlockSize integers (256 integer) */
-uint32_t avxmaxbits(const uint32_t * begin);
-
-/* reads 256 values from "in", writes  "bit" 256-bit vectors to "out" */
-void avxpack(const uint32_t *  in,__m256i *  out, const uint32_t bit);
-
-/* reads 256 values from "in", writes  "bit" 256-bit vectors to "out" */
-void avxpackwithoutmask(const uint32_t *  in,__m256i *  out, const uint32_t bit);
-
-/* reads  "bit" 256-bit vectors from "in", writes  256 values to "out" */
-void avxunpack(const __m256i *  in,uint32_t *  out, const uint32_t bit);
-
-
-
-
-#endif /* __AVX2__ */
-
-#endif /* INCLUDE_AVXBITPACKING_H_ */

cpp/simdcomp/include/portability.h

@@ -1,81 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#ifndef SIMDBITCOMPAT_H_
-#define SIMDBITCOMPAT_H_
-
-#include <iso646.h> /* mostly for Microsoft compilers */
-#include <string.h>
-
-#if SIMDCOMP_DEBUG
-# define SIMDCOMP_ALWAYS_INLINE inline
-# define SIMDCOMP_NEVER_INLINE
-# define SIMDCOMP_PURE
-#else
-# if defined(__GNUC__)
-#  if __GNUC__ >= 3
-#   define SIMDCOMP_ALWAYS_INLINE inline __attribute__((always_inline))
-#   define SIMDCOMP_NEVER_INLINE __attribute__((noinline))
-#   define SIMDCOMP_PURE __attribute__((pure))
-#  else
-#   define SIMDCOMP_ALWAYS_INLINE inline
-#   define SIMDCOMP_NEVER_INLINE
-#   define SIMDCOMP_PURE
-#  endif
-# elif defined(_MSC_VER)
-#  define SIMDCOMP_ALWAYS_INLINE __forceinline
-#  define SIMDCOMP_NEVER_INLINE
-#  define SIMDCOMP_PURE
-# else
-#  if __has_attribute(always_inline)
-#   define SIMDCOMP_ALWAYS_INLINE inline __attribute__((always_inline))
-#  else
-#   define SIMDCOMP_ALWAYS_INLINE inline
-#  endif
-#  if __has_attribute(noinline)
-#   define SIMDCOMP_NEVER_INLINE __attribute__((noinline))
-#  else
-#   define SIMDCOMP_NEVER_INLINE
-#  endif
-#  if __has_attribute(pure)
-#   define SIMDCOMP_PURE __attribute__((pure))
-#  else
-#   define SIMDCOMP_PURE
-#  endif
-# endif
-#endif
-
-#if defined(_MSC_VER) && _MSC_VER < 1600
-typedef unsigned int uint32_t;
-typedef unsigned char uint8_t;
-typedef signed char int8_t;
-#else
-#include <stdint.h> /* part of Visual Studio 2010 and better, others likely anyway */
-#endif
-
-#if defined(_MSC_VER)
-#define SIMDCOMP_ALIGNED(x) __declspec(align(x))
-#else
-#if defined(__GNUC__)
-#define SIMDCOMP_ALIGNED(x) __attribute__ ((aligned(x)))
-#endif
-#endif
-
-#if defined(_MSC_VER)
-# include <intrin.h>
-/* 64-bit needs extending */
-# define SIMDCOMP_CTZ(result, mask) do { \
-		unsigned long index; \
-		if (!_BitScanForward(&(index), (mask))) { \
-			(result) = 32U; \
-		} else { \
-			(result) = (uint32_t)(index); \
-		} \
-	} while (0)
-#else
-# define SIMDCOMP_CTZ(result, mask) \
-	result = __builtin_ctz(mask)
-#endif
-
-#endif /* SIMDBITCOMPAT_H_ */
-

cpp/simdcomp/include/simdbitpacking.h

@@ -1,72 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#ifndef SIMDBITPACKING_H_
-#define SIMDBITPACKING_H_
-
-#include "portability.h"
-
-/* SSE2 is required */
-#include <emmintrin.h>
-/* for memset */
-#include <string.h>
-
-#include "simdcomputil.h"
-
-/***
-* Please see example.c for various examples on how to make good use
-* of these functions.
-*/
-
-
-
-/* reads 128 values from "in", writes  "bit" 128-bit vectors to "out".
- * The input values are masked so that only the least significant "bit" bits are used. */
-void simdpack(const uint32_t *  in,__m128i *  out, const uint32_t bit);
-
-/* reads 128 values from "in", writes  "bit" 128-bit vectors to "out".
- * The input values are assumed to be less than 1<<bit. */
-void simdpackwithoutmask(const uint32_t *  in,__m128i *  out, const uint32_t bit);
-
-/* reads  "bit" 128-bit vectors from "in", writes  128 values to "out" */
-void simdunpack(const __m128i *  in,uint32_t *  out, const uint32_t bit);
-
-
-
-/* how many compressed bytes are needed to compressed length integers using a bit width of bit with 
-the  simdpackFOR_length function. */
-int simdpack_compressedbytes(int length, const uint32_t bit);
-
-/* like simdpack, but supports an undetermined number of inputs.
- * This is useful if you need to unpack an array of integers that is not divisible by 128 integers.
- * Returns a pointer to the (advanced) compressed array. Compressed data is stored in the memory location between 
- the provided (out) pointer and the returned pointer. */
-__m128i * simdpack_length(const uint32_t *   in, size_t length, __m128i *    out, const uint32_t bit);
-
-/* like simdunpack, but supports an undetermined number of inputs.
- * This is useful if you need to unpack an array of integers that is not divisible by 128 integers.
- * Returns a pointer to the (advanced) compressed array. The read compressed data is between the provided 
- (in) pointer and the returned pointer. */
-const __m128i * simdunpack_length(const __m128i *   in, size_t length, uint32_t * out, const uint32_t bit);
-
-
-
-
-/* like simdpack, but supports an undetermined small number of inputs. This is useful if you need to pack less 
-than 128 integers.
- * Note that this function is much slower.
- * Returns a pointer to the (advanced) compressed array. Compressed data is stored in the memory location 
- between the provided (out) pointer and the returned pointer. */
-__m128i * simdpack_shortlength(const uint32_t *   in, int length, __m128i *    out, const uint32_t bit);
-
-/* like simdunpack, but supports an undetermined small number of inputs. This is useful if you need to unpack less
- than 128 integers.
- * Note that this function is much slower.
- * Returns a pointer to the (advanced) compressed array. The read compressed data is between the provided (in) 
- pointer and the returned pointer. */
-const __m128i * simdunpack_shortlength(const __m128i *   in, int length, uint32_t * out, const uint32_t bit);
-
-/* given a block of 128 packed values, this function sets the value at index "index" to "value" */
-void simdfastset(__m128i * in128, uint32_t b, uint32_t value, size_t index);
-
-#endif /* SIMDBITPACKING_H_ */

cpp/simdcomp/include/simdcomp.h

@@ -1,22 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-
-#ifndef SIMDCOMP_H_
-#define SIMDCOMP_H_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include "simdbitpacking.h"
-#include "simdcomputil.h"
-#include "simdfor.h"
-#include "simdintegratedbitpacking.h"
-#include "avxbitpacking.h"
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif 

cpp/simdcomp/include/simdcomputil.h

@@ -1,54 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-
-#ifndef SIMDCOMPUTIL_H_
-#define SIMDCOMPUTIL_H_
-
-#include "portability.h"
-
-/* SSE2 is required */
-#include <emmintrin.h>
-
-
-
-
-/* returns the integer logarithm of v (bit width) */
-uint32_t bits(const uint32_t v);
-
-/* max integer logarithm over a range of SIMDBlockSize integers (128 integer) */
-uint32_t maxbits(const uint32_t * begin);
-
-/* same as maxbits, but we specify the number of integers */
-uint32_t maxbits_length(const uint32_t * in,uint32_t length);
-
-enum{ SIMDBlockSize = 128};
-
-
-/* computes (quickly) the minimal value of 128 values */
-uint32_t simdmin(const uint32_t * in);
-
-/* computes (quickly) the minimal value of the specified number of values */
-uint32_t simdmin_length(const uint32_t * in, uint32_t length);
-
-#ifdef __SSE4_1__
-/* computes (quickly) the minimal and maximal value of the specified number of values */
-void simdmaxmin_length(const uint32_t * in, uint32_t length, uint32_t * getmin, uint32_t * getmax);
-
-/* computes (quickly) the minimal and maximal value of the 128 values */
-void simdmaxmin(const uint32_t * in, uint32_t * getmin, uint32_t * getmax);
-
-#endif
-
-/* like maxbit over 128 integers (SIMDBlockSize) with provided initial value 
-   and using differential coding */
-uint32_t simdmaxbitsd1(uint32_t initvalue, const uint32_t * in);
-
-/* like simdmaxbitsd1, but calculates maxbits over |length| integers 
-   with provided initial value. |length| can be any arbitrary value. */
-uint32_t simdmaxbitsd1_length(uint32_t initvalue, const uint32_t * in,
-                uint32_t length);
-
-
-
-#endif /* SIMDCOMPUTIL_H_ */

cpp/simdcomp/include/simdfor.h

@@ -1,72 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#ifndef INCLUDE_SIMDFOR_H_
-#define INCLUDE_SIMDFOR_H_
-
-#include "portability.h"
-
-/* SSE2 is required */
-#include <emmintrin.h>
-
-#include "simdcomputil.h"
-#include "simdbitpacking.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* reads 128 values from "in", writes  "bit" 128-bit vectors to "out" */
-void simdpackFOR(uint32_t initvalue, const uint32_t *  in,__m128i *  out, const uint32_t bit);
-
-
-/* reads "bit" 128-bit vectors from "in", writes  128 values to "out" */
-void simdunpackFOR(uint32_t initvalue, const __m128i *  in,uint32_t *  out, const uint32_t bit);
-
-
-/* how many compressed bytes are needed to compressed length integers using a bit width of bit with 
-the  simdpackFOR_length function. */
-int simdpackFOR_compressedbytes(int length, const uint32_t bit);
-
-/* like simdpackFOR, but supports an undetermined number of inputs. 
-This is useful if you need to pack less than 128 integers. Note that this function is much slower. 
- Compressed data is stored in the memory location between 
- the provided (out) pointer and the returned pointer. */
-__m128i * simdpackFOR_length(uint32_t initvalue, const uint32_t *   in, int length, __m128i *    out, const uint32_t bit);
-
-/* like simdunpackFOR, but supports an undetermined number of inputs. 
-This is useful if you need to unpack less than 128 integers. Note that this function is much slower. 
- The read compressed data is between the provided 
- (in) pointer and the returned pointer.  */
-const __m128i * simdunpackFOR_length(uint32_t initvalue, const __m128i *   in, int length, uint32_t * out, const uint32_t bit);
-
-
-/* returns the value stored at the specified "slot".
-* */
-uint32_t simdselectFOR(uint32_t initvalue, const __m128i *in, uint32_t bit,
-                int slot);
-
-/* given a block of 128 packed values, this function sets the value at index "index" to "value" */
-void simdfastsetFOR(uint32_t initvalue, __m128i * in, uint32_t bit, uint32_t value, size_t index);
-
-
-/* searches "bit" 128-bit vectors from "in" (= length<=128 encoded integers) for the first encoded uint32 value
- * which is >= |key|, and returns its position. It is assumed that the values
- * stored are in sorted order.
- * The encoded key is stored in "*presult".
- * The first length decoded integers, ignoring others. If no value is larger or equal to the key,
- * length is returned. Length should be no larger than 128.
- *
- * If no value is larger or equal to the key,
-* length is returned */
-int simdsearchwithlengthFOR(uint32_t initvalue, const __m128i *in, uint32_t bit,
-                int length, uint32_t key, uint32_t *presult);
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-
-
-
-#endif /* INCLUDE_SIMDFOR_H_ */

cpp/simdcomp/include/simdintegratedbitpacking.h

@@ -1,98 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-
-#ifndef SIMD_INTEGRATED_BITPACKING_H
-#define SIMD_INTEGRATED_BITPACKING_H
-
-#include "portability.h"
-
-/* SSE2 is required */
-#include <emmintrin.h>
-
-#include "simdcomputil.h"
-#include "simdbitpacking.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* reads 128 values from "in", writes  "bit" 128-bit vectors to "out"
-   integer values should be in sorted order (for best results).
-   The differences are masked so that only the least significant "bit" bits are used. */
-void simdpackd1(uint32_t initvalue, const uint32_t *  in,__m128i *  out, const uint32_t bit);
-
-
-/* reads 128 values from "in", writes  "bit" 128-bit vectors to "out"
-   integer values should be in sorted order (for best results).
-   The difference values are assumed to be less than 1<<bit. */
-void simdpackwithoutmaskd1(uint32_t initvalue, const uint32_t *  in,__m128i *  out, const uint32_t bit);
-
-
-/* reads "bit" 128-bit vectors from "in", writes  128 values to "out" */
-void simdunpackd1(uint32_t initvalue, const __m128i *  in,uint32_t *  out, const uint32_t bit);
-
-
-/* searches "bit" 128-bit vectors from "in" (= 128 encoded integers) for the first encoded uint32 value
- * which is >= |key|, and returns its position. It is assumed that the values
- * stored are in sorted order.
- * The encoded key is stored in "*presult". If no value is larger or equal to the key,
-* 128 is returned. The pointer initOffset is a pointer to the last four value decoded
-* (when starting out, this can be a zero vector or initialized with _mm_set1_epi32(init)),
-* and the vector gets updated.
-**/
-int
-simdsearchd1(__m128i * initOffset, const __m128i *in, uint32_t bit,
-                uint32_t key, uint32_t *presult);
-
-
-/* searches "bit" 128-bit vectors from "in" (= length<=128 encoded integers) for the first encoded uint32 value
- * which is >= |key|, and returns its position. It is assumed that the values
- * stored are in sorted order.
- * The encoded key is stored in "*presult".
- * The first length decoded integers, ignoring others. If no value is larger or equal to the key,
- * length is returned. Length should be no larger than 128.
- *
- * If no value is larger or equal to the key,
-* length is returned */
-int simdsearchwithlengthd1(uint32_t initvalue, const __m128i *in, uint32_t bit,
-                int length, uint32_t key, uint32_t *presult);
-
-
-
-/* returns the value stored at the specified "slot".
-* */
-uint32_t simdselectd1(uint32_t initvalue, const __m128i *in, uint32_t bit,
-                int slot);
-
-/* given a block of 128 packed values, this function sets the value at index "index" to "value",
- * you must somehow know the previous value.
- * Because of differential coding, all following values are incremented by the offset between this new
- * value and the old value... 
- * This functions is useful if you want to modify the last value. 
- */
-void simdfastsetd1fromprevious( __m128i * in, uint32_t bit, uint32_t previousvalue, uint32_t value, size_t index);
-
-/* given a block of 128 packed values, this function sets the value at index "index" to "value",
- * This function computes the previous value if needed.
- * Because of differential coding, all following values are incremented by the offset between this new
- * value and the old value...
- * This functions is useful if you want to modify the last value. 
- */
-void simdfastsetd1(uint32_t initvalue, __m128i * in, uint32_t bit, uint32_t value, size_t index);
-
-
-/*Simply scan the data
-* The pointer initOffset is a pointer to the last four value decoded
-* (when starting out, this can be a zero vector or initialized with _mm_set1_epi32(init);),
-* and the vector gets updated.
-* */
-
-void
-simdscand1(__m128i * initOffset, const __m128i *in, uint32_t bit);
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif

cpp/simdcomp/makefile

@@ -1,79 +0,0 @@
-# minimalist makefile
-.SUFFIXES:
-#
-.SUFFIXES: .cpp .o .c .h
-ifeq ($(DEBUG),1)
-CFLAGS = -fPIC  -std=c89 -ggdb -msse4.1 -march=native -Wall -Wextra -Wshadow -fsanitize=undefined  -fno-omit-frame-pointer -fsanitize=address
-else
-CFLAGS = -fPIC -std=c89 -O3 -msse4.1  -march=native -Wall -Wextra -Wshadow
-endif # debug
-LDFLAGS = -shared
-LIBNAME=libsimdcomp.so.0.0.3
-all:  unit unit_chars bitpackingbenchmark $(LIBNAME)
-test:
-	./unit
-	./unit_chars
-install: $(OBJECTS)
-	cp $(LIBNAME) /usr/local/lib
-	ln -s /usr/local/lib/$(LIBNAME) /usr/local/lib/libsimdcomp.so
-	ldconfig
-	cp $(HEADERS) /usr/local/include
-
-
-
-HEADERS=./include/simdbitpacking.h ./include/simdcomputil.h ./include/simdintegratedbitpacking.h ./include/simdcomp.h ./include/simdfor.h ./include/avxbitpacking.h
-
-uninstall:
-	for h in $(HEADERS) ; do rm  /usr/local/$$h; done
-	rm  /usr/local/lib/$(LIBNAME)
-	rm /usr/local/lib/libsimdcomp.so
-	ldconfig
-
-
-OBJECTS= simdbitpacking.o simdintegratedbitpacking.o simdcomputil.o \
-		 simdpackedsearch.o simdpackedselect.o simdfor.o avxbitpacking.o
-
-$(LIBNAME): $(OBJECTS)
-	$(CC) $(CFLAGS) -o $(LIBNAME) $(OBJECTS)  $(LDFLAGS)
-
-
-avxbitpacking.o: ./src/avxbitpacking.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/avxbitpacking.c -Iinclude
-
-
-simdfor.o: ./src/simdfor.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdfor.c -Iinclude
-
-
-simdcomputil.o: ./src/simdcomputil.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdcomputil.c -Iinclude
-
-simdbitpacking.o: ./src/simdbitpacking.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdbitpacking.c -Iinclude
-
-simdintegratedbitpacking.o: ./src/simdintegratedbitpacking.c  $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdintegratedbitpacking.c -Iinclude
-
-simdpackedsearch.o: ./src/simdpackedsearch.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdpackedsearch.c -Iinclude
-
-simdpackedselect.o: ./src/simdpackedselect.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/simdpackedselect.c -Iinclude
-
-example: ./example.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o example ./example.c -Iinclude  $(OBJECTS)
-
-unit: ./tests/unit.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o unit ./tests/unit.c -Iinclude  $(OBJECTS)
-
-bitpackingbenchmark: ./benchmarks/bitpackingbenchmark.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o bitpackingbenchmark ./benchmarks/bitpackingbenchmark.c -Iinclude  $(OBJECTS)
-benchmark: ./benchmarks/benchmark.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o benchmark ./benchmarks/benchmark.c -Iinclude  $(OBJECTS)
-dynunit: ./tests/unit.c    $(HEADERS) $(LIBNAME)
-	$(CC) $(CFLAGS) -o dynunit ./tests/unit.c -Iinclude  -lsimdcomp
-
-unit_chars: ./tests/unit_chars.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o unit_chars ./tests/unit_chars.c -Iinclude  $(OBJECTS)
-clean:
-	rm -f unit *.o $(LIBNAME) example benchmark bitpackingbenchmark dynunit unit_chars

cpp/simdcomp/makefile.vc

@@ -1,104 +0,0 @@
-
-!IFNDEF MACHINE
-!IF "$(PROCESSOR_ARCHITECTURE)"=="AMD64"
-MACHINE=x64
-!ELSE
-MACHINE=x86
-!ENDIF
-!ENDIF
-
-!IFNDEF DEBUG
-DEBUG=no
-!ENDIF
-
-!IFNDEF CC
-CC=cl.exe
-!ENDIF
-
-!IFNDEF AR
-AR=lib.exe
-!ENDIF
-
-!IFNDEF LINK
-LINK=link.exe
-!ENDIF
-
-!IFNDEF PGO
-PGO=no
-!ENDIF
-
-!IFNDEF PGI
-PGI=no
-!ENDIF
-
-INC = /Iinclude
-
-!IF "$(DEBUG)"=="yes"
-CFLAGS = /nologo /MDd /LDd /Od /Zi /D_DEBUG /RTC1 /W3 /GS /Gm
-ARFLAGS = /nologo
-LDFLAGS = /nologo /debug /nodefaultlib:msvcrt
-!ELSE
-CFLAGS = /nologo /MD /O2 /Zi /DNDEBUG /W3 /Gm- /GS /Gy /Oi /GL /MP
-ARFLAGS = /nologo /LTCG
-LDFLAGS = /nologo /LTCG /DYNAMICBASE /incremental:no /debug /opt:ref,icf
-!ENDIF
-
-!IF "$(PGI)"=="yes"
-LDFLAGS = $(LDFLAGS) /ltcg:pgi
-!ENDIF
-
-!IF "$(PGO)"=="yes"
-LDFLAGS = $(LDFLAGS) /ltcg:pgo
-!ENDIF
-
-LIB_OBJS = simdbitpacking.obj simdintegratedbitpacking.obj simdcomputil.obj \
-	simdpackedsearch.obj simdpackedselect.obj simdfor.obj
-
-
-all: lib dll dynunit unit_chars example benchmark
-# need some good use case scenario to train the instrumented build
-	@if "$(PGI)"=="yes" echo Running PGO training
-	@if "$(PGI)"=="yes" benchmark.exe >nul 2>&1
-	@if "$(PGI)"=="yes" example.exe >nul 2>&1
-
-
-$(LIB_OBJS):
-	$(CC) $(INC) $(CFLAGS) /c src/simdbitpacking.c src/simdintegratedbitpacking.c src/simdcomputil.c \
-		src/simdpackedsearch.c src/simdpackedselect.c src/simdfor.c
-
-lib: $(LIB_OBJS)
-	$(AR) $(ARFLAGS) /OUT:simdcomp_a.lib $(LIB_OBJS)
-
-dll: $(LIB_OBJS)
-	$(LINK) /DLL $(LDFLAGS) /OUT:simdcomp.dll /IMPLIB:simdcomp.lib /DEF:simdcomp.def $(LIB_OBJS)
-
-unit: lib
-	$(CC) $(INC) $(CFLAGS) /c src/unit.c 
-	$(LINK) $(LDFLAGS) /OUT:unit.exe unit.obj simdcomp_a.lib
-
-dynunit: dll
-	$(CC) $(INC) $(CFLAGS) /c src/unit.c 
-	$(LINK) $(LDFLAGS) /OUT:unit.exe unit.obj simdcomp.lib
-
-unit_chars: lib
-	$(CC) $(INC) $(CFLAGS) /c src/unit_chars.c
-	$(LINK) $(LDFLAGS) /OUT:unit_chars.exe unit_chars.obj simdcomp.lib
-
-
-example: lib
-	$(CC) $(INC) $(CFLAGS) /c example.c
-	$(LINK) $(LDFLAGS) /OUT:example.exe example.obj simdcomp.lib
-
-benchmark: lib
-	$(CC) $(INC) $(CFLAGS) /c src/benchmark.c
-	$(LINK) $(LDFLAGS) /OUT:benchmark.exe benchmark.obj simdcomp.lib
-
-clean:
-	del /Q *.obj
-	del /Q *.lib
-	del /Q *.exe
-	del /Q *.dll
-	del /Q *.pgc
-	del /Q *.pgd
-	del /Q *.pdb
-

cpp/simdcomp/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "simdcomp",
-  "version": "0.0.3",
-  "repo": "lemire/simdcomp",
-  "description": "A simple C library for compressing lists of integers",
-  "license": "BSD-3-Clause",
-  "src": [
-    "src/simdbitpacking.c",
-    "src/simdcomputil.c",
-    "src/simdintegratedbitpacking.c",
-    "include/simdbitpacking.h",
-    "include/simdcomp.h",
-    "include/simdcomputil.h",
-    "include/simdintegratedbitpacking.h"
-  ]
-}

cpp/simdcomp/scripts/avxpacking.py

@@ -1,182 +0,0 @@
-#!/usr/bin/env python
-import sys
-def howmany(bit):
-    """ how many values are we going to pack? """
-    return 256
-
-def howmanywords(bit):
-    return (howmany(bit) * bit + 255)/256
-
-def howmanybytes(bit):
-    return howmanywords(bit) * 16
-
-print("""
-/** code generated by avxpacking.py starts here **/
-""")
-
-print("""typedef void (*avxpackblockfnc)(const uint32_t * pin, __m256i * compressed);""")
-print("""typedef void (*avxunpackblockfnc)(const __m256i * compressed, uint32_t * pout);""")
-
-
-
-
-
-
-def plurial(number):
-    if(number <> 1):
-        return "s"
-    else :
-        return ""
-
-print("")
-print("static void avxpackblock0(const uint32_t * pin, __m256i * compressed) {");
-print("  (void)compressed;");
-print("  (void) pin; /* we consumed {0} 32-bit integer{1} */ ".format(howmany(0),plurial(howmany(0))));
-print("}");
-print("")
-
-for bit in range(1,33):
-    print("")
-    print("/* we are going to pack {0} {1}-bit values, touching {2} 256-bit words, using {3} bytes */ ".format(howmany(bit),bit,howmanywords(bit),howmanybytes(bit)))
-    print("static void avxpackblock{0}(const uint32_t * pin, __m256i * compressed) {{".format(bit));
-    print("  const __m256i * in = (const __m256i *)  pin;");
-    print("  /* we are going to touch  {0} 256-bit word{1} */ ".format(howmanywords(bit),plurial(howmanywords(bit))));
-    if(howmanywords(bit) == 1):
-      print("  __m256i w0;")
-    else:
-      print("  __m256i w0, w1;")
-    if( (bit & (bit-1)) <> 0) : print("  __m256i tmp; /* used to store inputs at word boundary */")
-    oldword = 0
-    for j in range(howmany(bit)/8):
-      firstword = j * bit / 32
-      if(firstword > oldword):
-        print("  _mm256_storeu_si256(compressed + {0}, w{1});".format(oldword,oldword%2))
-        oldword = firstword
-      secondword = (j * bit + bit - 1)/32
-      firstshift = (j*bit) % 32
-      if( firstword == secondword):
-          if(firstshift == 0):
-            print("  w{0} = _mm256_lddqu_si256 (in + {1});".format(firstword%2,j))
-          else:
-            print("  w{0} = _mm256_or_si256(w{0},_mm256_slli_epi32(_mm256_lddqu_si256 (in + {1}) , {2}));".format(firstword%2,j,firstshift))
-      else:
-          print("  tmp = _mm256_lddqu_si256 (in + {0});".format(j))
-          print("  w{0} = _mm256_or_si256(w{0},_mm256_slli_epi32(tmp , {2}));".format(firstword%2,j,firstshift))
-          secondshift = 32-firstshift
-          print("  w{0} = _mm256_srli_epi32(tmp,{2});".format(secondword%2,j,secondshift))
-    print("  _mm256_storeu_si256(compressed + {0}, w{1});".format(secondword,secondword%2))
-    print("}");
-    print("")
-
-
-print("")
-print("static void avxpackblockmask0(const uint32_t * pin, __m256i * compressed) {");
-print("  (void)compressed;");
-print("  (void) pin; /* we consumed {0} 32-bit integer{1} */ ".format(howmany(0),plurial(howmany(0))));
-print("}");
-print("")
-
-for bit in range(1,33):
-    print("")
-    print("/* we are going to pack {0} {1}-bit values, touching {2} 256-bit words, using {3} bytes */ ".format(howmany(bit),bit,howmanywords(bit),howmanybytes(bit)))
-    print("static void avxpackblockmask{0}(const uint32_t * pin, __m256i * compressed) {{".format(bit));
-    print("  /* we are going to touch  {0} 256-bit word{1} */ ".format(howmanywords(bit),plurial(howmanywords(bit))));
-    if(howmanywords(bit) == 1):
-      print("  __m256i w0;")
-    else:
-      print("  __m256i w0, w1;")
-    print("  const __m256i * in = (const __m256i *) pin;");
-    if(bit < 32): print("  const __m256i mask = _mm256_set1_epi32({0});".format((1<<bit)-1));
-    def maskfnc(x):
-        if(bit == 32): return x
-        return " _mm256_and_si256 ( mask, {0}) ".format(x)
-    if( (bit & (bit-1)) <> 0) : print("  __m256i tmp; /* used to store inputs at word boundary */")
-    oldword = 0
-    for j in range(howmany(bit)/8):
-      firstword = j * bit / 32
-      if(firstword > oldword):
-        print("  _mm256_storeu_si256(compressed + {0}, w{1});".format(oldword,oldword%2))
-        oldword = firstword
-      secondword = (j * bit + bit - 1)/32
-      firstshift = (j*bit) % 32
-      loadstr = maskfnc(" _mm256_lddqu_si256 (in + {0}) ".format(j))
-      if( firstword == secondword):
-          if(firstshift == 0):
-            print("  w{0} = {1};".format(firstword%2,loadstr))
-          else:
-            print("  w{0} = _mm256_or_si256(w{0},_mm256_slli_epi32({1} , {2}));".format(firstword%2,loadstr,firstshift))
-      else:
-          print("  tmp = {0};".format(loadstr))
-          print("  w{0} = _mm256_or_si256(w{0},_mm256_slli_epi32(tmp , {2}));".format(firstword%2,j,firstshift))
-          secondshift = 32-firstshift
-          print("  w{0} = _mm256_srli_epi32(tmp,{2});".format(secondword%2,j,secondshift))
-    print("  _mm256_storeu_si256(compressed + {0}, w{1});".format(secondword,secondword%2))
-    print("}");
-    print("")
-
-
-print("static void avxunpackblock0(const __m256i * compressed, uint32_t * pout) {");
-print("  (void) compressed;");
-print("  memset(pout,0,{0});".format(howmany(0)));
-print("}");
-print("")
-
-for bit in range(1,33):
-    print("")
-    print("/* we packed {0} {1}-bit values, touching {2} 256-bit words, using {3} bytes */ ".format(howmany(bit),bit,howmanywords(bit),howmanybytes(bit)))
-    print("static void avxunpackblock{0}(const __m256i * compressed, uint32_t * pout) {{".format(bit));
-    print("  /* we are going to access  {0} 256-bit word{1} */ ".format(howmanywords(bit),plurial(howmanywords(bit))));
-    if(howmanywords(bit) == 1):
-      print("  __m256i w0;")
-    else:
-      print("  __m256i w0, w1;")
-    print("  __m256i * out = (__m256i *) pout;");
-    if(bit < 32): print("  const __m256i mask = _mm256_set1_epi32({0});".format((1<<bit)-1));
-    maskstr = " _mm256_and_si256 ( mask, {0}) "
-    if (bit == 32) : maskstr = " {0} " # no need
-    oldword = 0
-    print("  w0 = _mm256_lddqu_si256 (compressed);")
-    for j in range(howmany(bit)/8):
-      firstword = j * bit / 32
-      secondword = (j * bit + bit - 1)/32
-      if(secondword > oldword):
-        print("  w{0} = _mm256_lddqu_si256 (compressed + {1});".format(secondword%2,secondword))
-        oldword = secondword
-      firstshift = (j*bit) % 32
-      firstshiftstr = "_mm256_srli_epi32( w{0} , "+str(firstshift)+") "
-      if(firstshift == 0):
-          firstshiftstr =" w{0} " # no need
-      wfirst = firstshiftstr.format(firstword%2)
-      if( firstword == secondword):
-          if(firstshift + bit <> 32):
-            wfirst  = maskstr.format(wfirst)
-          print("  _mm256_storeu_si256(out + {0}, {1});".format(j,wfirst))
-      else:
-          secondshift = (32-firstshift)
-          wsecond = "_mm256_slli_epi32( w{0} , {1} ) ".format((firstword+1)%2,secondshift)
-          wfirstorsecond = " _mm256_or_si256 ({0},{1}) ".format(wfirst,wsecond)
-          wfirstorsecond = maskstr.format(wfirstorsecond)
-          print("  _mm256_storeu_si256(out + {0},\n    {1});".format(j,wfirstorsecond))
-    print("}");
-    print("")
-
-
-print("static avxpackblockfnc avxfuncPackArr[] = {")
-for bit in range(0,32):
-  print("&avxpackblock{0},".format(bit))
-print("&avxpackblock32")
-print("};")
-
-print("static avxpackblockfnc avxfuncPackMaskArr[] = {")
-for bit in range(0,32):
-  print("&avxpackblockmask{0},".format(bit))
-print("&avxpackblockmask32")
-print("};")
-
-
-print("static avxunpackblockfnc avxfuncUnpackArr[] = {")
-for bit in range(0,32):
-  print("&avxunpackblock{0},".format(bit))
-print("&avxunpackblock32")
-print("};")
-print("/** code generated by avxpacking.py ends here **/")

cpp/simdcomp/scripts/simdfor.py

@@ -1,152 +0,0 @@
-#!/usr/bin/env python3
-
-
-from math import ceil
-
-print("""
-/**
-* Blablabla
-*
-*/
-
-""");
-
-def mask(bit):
-  return str((1 << bit) - 1)
-
-for length in [32]:
-  print("""
-static __m128i  iunpackFOR0(__m128i initOffset, const __m128i *   _in , uint32_t *    _out) {
-    __m128i       *out = (__m128i*)(_out);
-    int i;
-    (void) _in;
-    for (i = 0; i < 8; ++i) {
-        _mm_store_si128(out++, initOffset);
-    	_mm_store_si128(out++, initOffset);
-        _mm_store_si128(out++, initOffset);
-        _mm_store_si128(out++, initOffset);
-    }
-
-    return initOffset;
-}
-
-  """)
-  print("""
-
-static void ipackFOR0(__m128i initOffset , const uint32_t *   _in , __m128i *  out  ) {
-    (void) initOffset;
-    (void) _in;
-    (void) out;
-}
-""") 
-  for bit in range(1,33):
-    offsetVar = " initOffset";
-    print("""  
-static void ipackFOR"""+str(bit)+"""(__m128i """+offsetVar+""", const uint32_t *   _in, __m128i *   out) {
-    const __m128i       *in = (const __m128i*)(_in);
-    __m128i    OutReg;
-
-      """);
-    
-    if (bit != 32):
-      print("    __m128i CurrIn = _mm_load_si128(in);");
-      print("    __m128i InReg = _mm_sub_epi32(CurrIn, initOffset);");
-    else:
-      print("    __m128i InReg = _mm_load_si128(in);");
-      print("    (void) initOffset;");
-
-
-    inwordpointer = 0
-    valuecounter = 0
-    for k in range(ceil((length * bit) / 32)):
-      if(valuecounter == length): break
-      for x in range(inwordpointer,32,bit):
-        if(x!=0) :
-          print("    OutReg = _mm_or_si128(OutReg, _mm_slli_epi32(InReg, " + str(x) + "));");
-        else:
-          print("    OutReg = InReg; ");
-        if((x+bit>=32) ):
-          while(inwordpointer<32):
-            inwordpointer += bit
-          print("    _mm_store_si128(out, OutReg);");
-          print("");
-
-          if(valuecounter + 1 < length):
-            print("    ++out;")
-          inwordpointer -= 32;
-          if(inwordpointer>0):
-            print("    OutReg = _mm_srli_epi32(InReg, " + str(bit) + " - " + str(inwordpointer) + ");");
-        if(valuecounter + 1 < length):
-          print("    ++in;") 
-
-          if (bit != 32):
-            print("    CurrIn = _mm_load_si128(in);");
-            print("    InReg = _mm_sub_epi32(CurrIn, initOffset);");
-          else:
-            print("    InReg = _mm_load_si128(in);");
-          print("");
-        valuecounter = valuecounter + 1
-        if(valuecounter == length): break
-    assert(valuecounter == length)
-    print("\n}\n\n""")
-
-  for bit in range(1,32):
-    offsetVar = " initOffset";
-    print("""\n
-static __m128i iunpackFOR"""+str(bit)+"""(__m128i """+offsetVar+""", const  __m128i*   in, uint32_t *   _out) {
-      """);
-    print("""    __m128i*   out = (__m128i*)(_out);
-    __m128i    InReg = _mm_load_si128(in);
-    __m128i    OutReg;    
-    __m128i     tmp;
-    const __m128i mask =  _mm_set1_epi32((1U<<"""+str(bit)+""")-1);
-
-    """);
-
-    MainText = "";
-
-    MainText += "\n";
-    inwordpointer = 0
-    valuecounter = 0
-    for k in range(ceil((length * bit) / 32)):
-      for x in range(inwordpointer,32,bit):
-        if(valuecounter == length): break
-        if (x > 0):
-          MainText += "    tmp = _mm_srli_epi32(InReg," + str(x) +");\n"; 
-        else:
-          MainText += "    tmp = InReg;\n"; 
-        if(x+bit<32):
-          MainText += "    OutReg = _mm_and_si128(tmp, mask);\n";
-        else:
-          MainText += "    OutReg = tmp;\n";        
-        if((x+bit>=32) ):      
-          while(inwordpointer<32):
-            inwordpointer += bit
-          if(valuecounter + 1 < length):
-             MainText += "    ++in;"
-             MainText += "    InReg = _mm_load_si128(in);\n";
-          inwordpointer -= 32;
-          if(inwordpointer>0):
-            MainText += "    OutReg = _mm_or_si128(OutReg, _mm_and_si128(_mm_slli_epi32(InReg, " + str(bit) + "-" + str(inwordpointer) + "), mask));\n\n";
-        if (bit != 32):
-          MainText += "    OutReg = _mm_add_epi32(OutReg, initOffset);\n"; 
-        MainText += "    _mm_store_si128(out++, OutReg);\n\n"; 
-        MainText += "";
-        valuecounter = valuecounter + 1
-        if(valuecounter == length): break
-    assert(valuecounter == length)
-    print(MainText)
-    print("    return initOffset;");
-    print("\n}\n\n")
-  print("""
-static __m128i iunpackFOR32(__m128i initvalue , const  __m128i*   in, uint32_t *    _out) {
-	__m128i * mout = (__m128i *)_out;
-	__m128i invec;
-	size_t k;
-	for(k = 0; k < 128/4; ++k) {
-		invec =  _mm_load_si128(in++);
-	    _mm_store_si128(mout++, invec);
-	}
-	return invec;
-}
-  """)

cpp/simdcomp/simdcomp.def

@@ -1,40 +0,0 @@
-EXPORTS
-	simdpack
-	simdpackwithoutmask
-	simdunpack
-	bits
-	maxbits
-	maxbits_length
-	simdmin
-	simdmin_length
-	simdmaxmin
-	simdmaxmin_length
-	simdmaxbitsd1
-	simdmaxbitsd1_length
-	simdpackd1
-	simdpackwithoutmaskd1
-	simdunpackd1
-	simdsearchd1
-	simdsearchwithlengthd1
-	simdselectd1
-	simdpackFOR
-	simdselectFOR
-	simdsearchwithlengthFOR
-	simdunpackFOR
-	simdmin_length
-	simdmaxmin
-	simdmaxmin_length
-	simdpack_length
-	simdpackFOR_length
-	simdunpackFOR_length
-	simdpack_shortlength
-	simdfastsetFOR
-	simdfastset
-	simdfastsetd1
-	simdunpack_length
-	simdunpack_shortlength
-	simdsearchwithlengthFOR
-	simdscand1
-	simdfastsetd1fromprevious
-	simdfastsetd1
-

cpp/simdcomp/src/simdcomputil.c

@@ -1,234 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-
-#include "simdcomputil.h"
-#ifdef __SSE4_1__
-#include <smmintrin.h>
-#endif
-#include <assert.h>
-
-#define Delta(curr, prev) \
-    _mm_sub_epi32(curr, \
-            _mm_or_si128(_mm_slli_si128(curr, 4), _mm_srli_si128(prev, 12)))
-
-/* returns the integer logarithm of v (bit width) */
-uint32_t bits(const uint32_t v) {
-#ifdef _MSC_VER
-    unsigned long answer;
-    if (v == 0) {
-        return 0;
-    }
-    _BitScanReverse(&answer, v);
-    return answer + 1;
-#else
-    return v == 0 ? 0 : 32 - __builtin_clz(v); /* assume GCC-like compiler if not microsoft */
-#endif
-}
-
-
-
-static uint32_t maxbitas32int(const __m128i accumulator) {
-	const __m128i _tmp1 = _mm_or_si128(_mm_srli_si128(accumulator, 8), accumulator); /* (A,B,C,D) xor (0,0,A,B) = (A,B,C xor A,D xor B)*/
-	const __m128i _tmp2 = _mm_or_si128(_mm_srli_si128(_tmp1, 4), _tmp1); /*  (A,B,C xor A,D xor B) xor  (0,0,0,C xor A)*/
-	uint32_t ans =  _mm_cvtsi128_si32(_tmp2);
-	return bits(ans);
-}
-
-SIMDCOMP_PURE uint32_t maxbits(const uint32_t * begin) {
-	    const __m128i* pin = (const __m128i*)(begin);
-	    __m128i accumulator = _mm_loadu_si128(pin);
-	    uint32_t k = 1;
-	    for(; 4*k < SIMDBlockSize; ++k) {
-	    	__m128i newvec = _mm_loadu_si128(pin+k);
-	        accumulator = _mm_or_si128(accumulator,newvec);
-	    }
-	    return maxbitas32int(accumulator);
-}
-static uint32_t orasint(const __m128i accumulator) {
-	const __m128i _tmp1 = _mm_or_si128(_mm_srli_si128(accumulator, 8), accumulator); /* (A,B,C,D) xor (0,0,A,B) = (A,B,C xor A,D xor B)*/
-	const __m128i _tmp2 = _mm_or_si128(_mm_srli_si128(_tmp1, 4), _tmp1); /*  (A,B,C xor A,D xor B) xor  (0,0,0,C xor A)*/
-	return  _mm_cvtsi128_si32(_tmp2);
-}
-
-#ifdef __SSE4_1__
-
-static uint32_t minasint(const __m128i accumulator) {
-	const __m128i _tmp1 = _mm_min_epu32(_mm_srli_si128(accumulator, 8), accumulator); /* (A,B,C,D) xor (0,0,A,B) = (A,B,C xor A,D xor B)*/
-	const __m128i _tmp2 = _mm_min_epu32(_mm_srli_si128(_tmp1, 4), _tmp1); /*  (A,B,C xor A,D xor B) xor  (0,0,0,C xor A)*/
-	return  _mm_cvtsi128_si32(_tmp2);
-}
-
-static uint32_t maxasint(const __m128i accumulator) {
-	const __m128i _tmp1 = _mm_max_epu32(_mm_srli_si128(accumulator, 8), accumulator); /* (A,B,C,D) xor (0,0,A,B) = (A,B,C xor A,D xor B)*/
-	const __m128i _tmp2 = _mm_max_epu32(_mm_srli_si128(_tmp1, 4), _tmp1); /*  (A,B,C xor A,D xor B) xor  (0,0,0,C xor A)*/
-	return  _mm_cvtsi128_si32(_tmp2);
-}
-
-uint32_t simdmin(const uint32_t * in) {
-    const __m128i* pin = (const __m128i*)(in);
-    __m128i accumulator =  _mm_loadu_si128(pin);
-     uint32_t k = 1;
-     for(; 4*k < SIMDBlockSize; ++k) {
-    	 __m128i newvec = _mm_loadu_si128(pin+k);
-         accumulator = _mm_min_epu32(accumulator,newvec);
-     }
-     return minasint(accumulator);
-}
-
-void simdmaxmin(const uint32_t * in, uint32_t * getmin, uint32_t * getmax) {
-    const __m128i* pin = (const __m128i*)(in);
-    __m128i minaccumulator =  _mm_loadu_si128(pin);
-    __m128i maxaccumulator =  minaccumulator;
-    uint32_t k = 1;
-     for(; 4*k < SIMDBlockSize; ++k) {
-    	 __m128i newvec = _mm_loadu_si128(pin+k);
-         minaccumulator = _mm_min_epu32(minaccumulator,newvec);
-         maxaccumulator = _mm_max_epu32(maxaccumulator,newvec);
-     }
-     *getmin = minasint(minaccumulator);
-     *getmax = maxasint(maxaccumulator);
-}
-
-
-uint32_t simdmin_length(const uint32_t * in, uint32_t length) {
-	uint32_t currentmin = 0xFFFFFFFF;
-	uint32_t lengthdividedby4 = length / 4;
-	uint32_t offset = lengthdividedby4 * 4;
-	uint32_t k;
-	if (lengthdividedby4 > 0) {
-		const __m128i* pin = (const __m128i*)(in);
-		__m128i accumulator = _mm_loadu_si128(pin);
-		k = 1;
-		for(; 4*k < lengthdividedby4 * 4; ++k) {
-			__m128i newvec = _mm_loadu_si128(pin+k);
-			accumulator = _mm_min_epu32(accumulator,newvec);
-		}
-		currentmin = minasint(accumulator);
-	}
-	for (k = offset; k < length; ++k)
-		if (in[k] < currentmin)
-			currentmin = in[k];
-	return currentmin;
-}
-
-void simdmaxmin_length(const uint32_t * in, uint32_t length, uint32_t * getmin, uint32_t * getmax) {
-	uint32_t lengthdividedby4 = length / 4;
-	uint32_t offset = lengthdividedby4 * 4;
-	uint32_t k;
-	*getmin = 0xFFFFFFFF;
-	*getmax = 0;
-	if (lengthdividedby4 > 0) {
-		const __m128i* pin = (const __m128i*)(in);
-		__m128i minaccumulator = _mm_loadu_si128(pin);
-		__m128i maxaccumulator = minaccumulator;
-		k = 1;
-		for(; 4*k < lengthdividedby4 * 4; ++k) {
-			__m128i newvec = _mm_loadu_si128(pin+k);
-			minaccumulator = _mm_min_epu32(minaccumulator,newvec);
-			maxaccumulator = _mm_max_epu32(maxaccumulator,newvec);
-		}
-		*getmin = minasint(minaccumulator);
-		*getmax = maxasint(maxaccumulator);
-	}
-	for (k = offset; k < length; ++k) {
-		if (in[k] < *getmin)
-			*getmin = in[k];
-		if (in[k] > *getmax)
-			*getmax = in[k];
-	}
-}
-
-#endif
-
-SIMDCOMP_PURE uint32_t maxbits_length(const uint32_t * in,uint32_t length) {
-	  uint32_t k;
-	  uint32_t lengthdividedby4 = length / 4;
-	  uint32_t offset = lengthdividedby4 * 4;
-	  uint32_t bigxor = 0;
-	  if(lengthdividedby4 > 0) {
-		    const __m128i* pin = (const __m128i*)(in);
-		    __m128i accumulator = _mm_loadu_si128(pin);
-		    k = 1;
-		    for(; 4*k < 4*lengthdividedby4; ++k) {
-		    	__m128i newvec = _mm_loadu_si128(pin+k);
-		        accumulator = _mm_or_si128(accumulator,newvec);
-		    }
-		    bigxor = orasint(accumulator);
-	  }
-	  for(k = offset; k < length; ++k)
-		  bigxor |= in[k];
-	  return bits(bigxor);
-}
-
-
-/* maxbit over 128 integers (SIMDBlockSize) with provided initial value */
-uint32_t simdmaxbitsd1(uint32_t initvalue, const uint32_t * in) {
-    __m128i  initoffset = _mm_set1_epi32 (initvalue);
-    const __m128i* pin = (const __m128i*)(in);
-    __m128i newvec = _mm_loadu_si128(pin);
-    __m128i accumulator = Delta(newvec , initoffset);
-    __m128i oldvec = newvec;
-    uint32_t k = 1;
-    for(; 4*k < SIMDBlockSize; ++k) {
-        newvec = _mm_loadu_si128(pin+k);
-        accumulator = _mm_or_si128(accumulator,Delta(newvec , oldvec));
-        oldvec = newvec;
-    }
-    initoffset = oldvec;
-    return maxbitas32int(accumulator);
-}
-
-
-/* maxbit over |length| integers with provided initial value */
-uint32_t simdmaxbitsd1_length(uint32_t initvalue, const uint32_t * in,
-                uint32_t length) {
-    __m128i newvec;
-    __m128i oldvec;
-    __m128i initoffset;
-    __m128i accumulator;
-    const __m128i *pin;
-    uint32_t tmparray[4];
-    uint32_t k = 1;
-    uint32_t acc;
-
-    assert(length > 0);
-
-    pin = (const __m128i *)(in);
-    initoffset = _mm_set1_epi32(initvalue);
-    switch (length) {
-      case 1:
-        newvec = _mm_set1_epi32(in[0]);
-        break;
-      case 2:
-        newvec = _mm_setr_epi32(in[0], in[1], in[1], in[1]);
-        break;
-      case 3:
-        newvec = _mm_setr_epi32(in[0], in[1], in[2], in[2]);
-        break;
-      default:
-        newvec = _mm_loadu_si128(pin);
-        break;
-    }
-    accumulator = Delta(newvec, initoffset);
-    oldvec = newvec;
-
-    /* process 4 integers and build an accumulator */
-    while (k * 4 + 4 <= length) {
-        newvec = _mm_loadu_si128(pin + k);
-        accumulator = _mm_or_si128(accumulator, Delta(newvec, oldvec));
-        oldvec = newvec;
-        k++;
-    }
-
-    /* extract the accumulator as an integer */
-    _mm_storeu_si128((__m128i *)(tmparray), accumulator);
-    acc = tmparray[0] | tmparray[1] | tmparray[2] | tmparray[3];
-
-    /* now process the remaining integers */
-    for (k *= 4; k < length; k++)
-        acc |= in[k] - (k == 0 ? initvalue : in[k - 1]);
-
-    /* return the number of bits */
-    return bits(acc);
-}

cpp/simdcomp/tests/unit.c

@@ -1,900 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#include <assert.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include "simdcomp.h"
-
-
-
-int testshortpack() {
-	int bit;
-	size_t i;
-	size_t length;
-	__m128i * bb;
-	srand(0);
-	printf("testshortpack\n");
-	for (bit = 0; bit < 32; ++bit) {
-		const size_t N = 128;
-		uint32_t * data = malloc(N * sizeof(uint32_t));
-		uint32_t * backdata = malloc(N * sizeof(uint32_t));
-		uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-		for (i = 0; i < N; ++i) {
-			data[i] = rand() & ((1 << bit) - 1);
-		}
-		for (length = 0; length <= N; ++length) {
-			for (i = 0; i < N; ++i) {
-				backdata[i] = 0;
-			}
-			bb = simdpack_shortlength(data, length, (__m128i *) buffer,
-					bit);
-			if((bb - (__m128i *) buffer) * sizeof(__m128i) != (unsigned) simdpack_compressedbytes(length,bit)) {
-			 printf("bug\n");
-			 return -1;
-			}
-			simdunpack_shortlength((__m128i *) buffer, length,
-					backdata, bit);
-			for (i = 0; i < length; ++i) {
-
-				if (data[i] != backdata[i]) {
-				    printf("bug\n");
-					return -1;
-				}
-			}
-		}
-		free(data);
-		free(backdata);
-		free(buffer);
-	}
-	return 0;
-}
-
-int testlongpack() {
-	int bit;
-	size_t i;
-	size_t length;
-	__m128i * bb;
-	srand(0);
-	printf("testlongpack\n");
-	for (bit = 0; bit < 32; ++bit) {
-		const size_t N = 2048;
-		uint32_t * data = malloc(N * sizeof(uint32_t));
-		uint32_t * backdata = malloc(N * sizeof(uint32_t));
-		uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-		for (i = 0; i < N; ++i) {
-			data[i] = rand() & ((1 << bit) - 1);
-		}
-		for (length = 0; length <= N; ++length) {
-			for (i = 0; i < N; ++i) {
-				backdata[i] = 0;
-			}
-			bb = simdpack_length(data, length, (__m128i *) buffer,
-					bit);
-			if((bb - (__m128i *) buffer) * sizeof(__m128i) != (unsigned) simdpack_compressedbytes(length,bit)) {
-			 printf("bug\n");
-			 return -1;
-			}
-			simdunpack_length((__m128i *) buffer, length,
-					backdata, bit);
-			for (i = 0; i < length; ++i) {
-
-				if (data[i] != backdata[i]) {
-				    printf("bug\n");
-					return -1;
-				}
-			}
-		}
-		free(data);
-		free(backdata);
-		free(buffer);
-	}
-	return 0;
-}
-
-
-
-int testset() {
-	int bit;
-	size_t i;
-	const size_t N = 128;
-	uint32_t * data = malloc(N * sizeof(uint32_t));
-	uint32_t * backdata = malloc(N * sizeof(uint32_t));
-	uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-	srand(0);
-
-	for (bit = 0; bit < 32; ++bit) {
-		printf("simple set %d \n",bit);
-
-		for (i = 0; i < N; ++i) {
-			data[i] = rand() & ((1 << bit) - 1);
-		}
-		for (i = 0; i < N; ++i) {
-			backdata[i] = 0;
-		}
-		simdpack(data, (__m128i *) buffer, bit);
-		simdunpack((__m128i *) buffer, backdata, bit);
-		for (i = 0; i < N; ++i) {
-			if (data[i] != backdata[i]) {
-			    printf("bug\n");
-				return -1;
-			}
-		}
-
-		for(i = N  ; i > 0; i--) {
-			simdfastset((__m128i *) buffer, bit, data[N - i], i - 1);
-		}
-		simdunpack((__m128i *) buffer, backdata, bit);
-		for (i = 0; i < N; ++i) {
-			if (data[i] != backdata[N - i - 1]) {
-			    printf("bug\n");
-				return -1;
-			}
-		}
-		simdpack(data, (__m128i *) buffer, bit);
-		for(i = 1  ; i <= N; i++) {
-			simdfastset((__m128i *) buffer, bit, data[i - 1], i - 1);
-		}
-		simdunpack((__m128i *) buffer, backdata, bit);
-		for (i = 0; i < N; ++i) {
-			if (data[i] != backdata[i]) {
-			    printf("bug\n");
-				return -1;
-			}
-		}
-
-	}
-	free(data);
-	free(backdata);
-	free(buffer);
-
-	return 0;
-}
-
-#ifdef __SSE4_1__
-
-int testsetd1() {
-	int bit;
-	size_t i;
-	uint32_t newvalue;
-	const size_t N = 128;
-	uint32_t * data = malloc(N * sizeof(uint32_t));
-	uint32_t * datazeroes = malloc(N * sizeof(uint32_t));
-
-	uint32_t * backdata = malloc(N * sizeof(uint32_t));
-	uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-	srand(0);
-	for (bit = 0; bit < 32; ++bit) {
-		printf("simple set d1 %d \n",bit);
-		data[0] = rand() & ((1 << bit) - 1);
-		datazeroes[0] = 0;
-
-		for (i = 1; i < N; ++i) {
-			data[i] = data[i - 1] + (rand() & ((1 << bit) - 1));
-			datazeroes[i] = 0;
-		}
-		for (i = 0; i < N; ++i) {
-			backdata[i] = 0;
-		}
-		simdpackd1(0,datazeroes, (__m128i *) buffer, bit);
- 	    for(i = 1  ; i <= N; i++) {
-			simdfastsetd1(0,(__m128i *) buffer, bit, data[i - 1], i - 1);
-			newvalue = simdselectd1(0, (const __m128i *) buffer, bit,i - 1);
-			if( newvalue != data[i-1] ) {
-				printf("bad set-select\n");
-				return -1;
-			}
-		}
-		simdunpackd1(0,(__m128i *) buffer, backdata, bit);
-		for (i = 0; i < N; ++i) {
-			if (data[i] != backdata[i])
-				return -1;
-		}
-	}
-	free(data);
-	free(backdata);
-	free(buffer);
-        free(datazeroes);
-	return 0;
-}
-#endif
-
-int testsetFOR() {
-	int bit;
-	size_t i;
-	uint32_t newvalue;
-	const size_t N = 128;
-	uint32_t * data = malloc(N * sizeof(uint32_t));
-	uint32_t * datazeroes = malloc(N * sizeof(uint32_t));
-
-	uint32_t * backdata = malloc(N * sizeof(uint32_t));
-	uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-	srand(0);
-	for (bit = 0; bit < 32; ++bit) {
-		printf("simple set FOR %d \n",bit);
-		for (i = 0; i < N; ++i) {
-			data[i] = (rand() & ((1 << bit) - 1));
-			datazeroes[i] = 0;
-		}
-		for (i = 0; i < N; ++i) {
-			backdata[i] = 0;
-		}
-		simdpackFOR(0,datazeroes, (__m128i *) buffer, bit);
- 	    for(i = 1  ; i <= N; i++) {
- 	    	simdfastsetFOR(0,(__m128i *) buffer, bit, data[i - 1], i - 1);
-			newvalue = simdselectFOR(0, (const __m128i *) buffer, bit,i - 1);
-			if( newvalue != data[i-1] ) {
-				printf("bad set-select\n");
-				return -1;
-			}
-		}
-		simdunpackFOR(0,(__m128i *) buffer, backdata, bit);
-		for (i = 0; i < N; ++i) {
-			if (data[i] != backdata[i])
-				return -1;
-		}
-	}
-	free(data);
-	free(backdata);
-	free(buffer);
-        free(datazeroes);
-	return 0;
-}
-
-int testshortFORpack() {
-	int bit;
-	size_t i;
-	__m128i * rb;
-	size_t length;
-	uint32_t offset = 7;
-	srand(0);
-	for (bit = 0; bit < 32; ++bit) {
-		const size_t N = 128;
-		uint32_t * data = malloc(N * sizeof(uint32_t));
-		uint32_t * backdata = malloc(N * sizeof(uint32_t));
-		uint32_t * buffer = malloc((2 * N + 1024) * sizeof(uint32_t));
-
-		for (i = 0; i < N; ++i) {
-			data[i] = (rand() & ((1 << bit) - 1)) + offset;
-		}
-		for (length = 0; length <= N; ++length) {
-			for (i = 0; i < N; ++i) {
-				backdata[i] = 0;
-			}
-			rb = simdpackFOR_length(offset,data, length, (__m128i *) buffer,
-					bit);
-		    if(((rb - (__m128i *) buffer)*sizeof(__m128i)) != (unsigned) simdpackFOR_compressedbytes(length,bit)) {
-		      return -1;
-		    }
-			simdunpackFOR_length(offset,(__m128i *) buffer, length,
-					backdata, bit);
-			for (i = 0; i < length; ++i) {
-
-				if (data[i] != backdata[i])
-					return -1;
-			}
-		}
-		free(data);
-		free(backdata);
-		free(buffer);
-	}
-	return 0;
-}
-
-
-#ifdef __AVX2__
-
-int testbabyavx() {
-	int bit;
-	int trial;
-	unsigned int i,j;
-	const size_t N = AVXBlockSize;
-	srand(0);
-	printf("testbabyavx\n");
-	printf("bit = ");
-	for (bit = 0; bit < 32; ++bit) {
-		printf(" %d ",bit);
-		fflush(stdout);
-		for(trial = 0; trial < 100; ++trial) {
-			uint32_t * data = malloc(N * sizeof(uint32_t)+ 64 * sizeof(uint32_t));
-			uint32_t * backdata = malloc(N * sizeof(uint32_t) + 64 * sizeof(uint32_t) );
-			__m256i * buffer = malloc((2 * N + 1024) * sizeof(uint32_t) + 32);
-
-			for (i = 0; i < N; ++i) {
-				data[i] = rand() & ((uint32_t)(1 << bit) - 1);
-			}
-			for (i = 0; i < N; ++i) {
-				backdata[i] = 0;
-			}
-            if(avxmaxbits(data) != maxbits_length(data,N)) {
-            	printf("avxmaxbits is buggy\n");
-				return -1;
-            }
-
-			avxpackwithoutmask(data, buffer, bit);
-			avxunpack(buffer, backdata, bit);
-			for (i = 0; i < AVXBlockSize; ++i) {
-				if (data[i] != backdata[i]) {
-					printf("bug\n");
-					for (j = 0; j < N; ++j) {
-						if (data[j] != backdata[j]) {
-							printf("data[%d]=%d v.s. backdata[%d]=%d\n",j,data[j],j,backdata[j]);
-						} else {
-							printf("data[%d]=%d\n",j,data[j]);
-						}
-					}
-					return -1;
-				}
-			}
-			free(data);
-			free(backdata);
-			free(buffer);
-		}
-	}
-	printf("\n");
-	return 0;
-}
-
-int testavx2() {
-    int N = 5000 * AVXBlockSize, gap;
-    __m256i * buffer = malloc(AVXBlockSize * sizeof(uint32_t));
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    uint32_t * backbuffer = malloc(AVXBlockSize * sizeof(uint32_t));
-    for (gap = 1; gap <= 387420489; gap *= 3) {
-        int k;
-        printf(" gap = %u \n", gap);
-        for (k = 0; k < N; ++k)
-            datain[k] = k * gap;
-        for (k = 0; k * AVXBlockSize < N; ++k) {
-            /*
-               First part works for general arrays (sorted or unsorted)
-            */
-            int j;
-       	    /* we compute the bit width */
-            const uint32_t b = avxmaxbits(datain + k * AVXBlockSize);
-            if(avxmaxbits(datain + k * AVXBlockSize) != maxbits_length(datain + k * AVXBlockSize,AVXBlockSize)) {
-            	printf("avxmaxbits is buggy %d %d \n",
-            			avxmaxbits(datain + k * AVXBlockSize),
-						maxbits_length(datain + k * AVXBlockSize,AVXBlockSize));
-				return -1;
-            }
-            printf("bit width = %d\n",b);
-
-
-            /* we read 256 integers at "datain + k * AVXBlockSize" and
-               write b 256-bit vectors at "buffer" */
-            avxpackwithoutmask(datain + k * AVXBlockSize, buffer, b);
-            /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-			avxunpack(buffer, backbuffer, b);/* uncompressed */
-			for (j = 0; j < AVXBlockSize; ++j) {
-				if (backbuffer[j] != datain[k * AVXBlockSize + j]) {
-					int i;
-					printf("bug in avxpack\n");
-					for(i = 0; i < AVXBlockSize; ++i) {
-						printf("data[%d]=%d got back %d %s\n",i,
-								datain[k * AVXBlockSize + i],backbuffer[i],
-								datain[k * AVXBlockSize + i]!=backbuffer[i]?"bug":"");
-					}
-					return -2;
-				}
-			}
-        }
-    }
-    free(buffer);
-    free(datain);
-    free(backbuffer);
-    printf("Code looks good.\n");
-    return 0;
-}
-#endif /* avx2 */
-
-int test() {
-    int N = 5000 * SIMDBlockSize, gap;
-    __m128i * buffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    uint32_t * backbuffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    for (gap = 1; gap <= 387420489; gap *= 3) {
-        int k;
-        printf(" gap = %u \n", gap);
-        for (k = 0; k < N; ++k)
-            datain[k] = k * gap;
-        for (k = 0; k * SIMDBlockSize < N; ++k) {
-            /*
-               First part works for general arrays (sorted or unsorted)
-            */
-            int j;
-       	    /* we compute the bit width */
-            const uint32_t b = maxbits(datain + k * SIMDBlockSize);
-            /* we read 128 integers at "datain + k * SIMDBlockSize" and
-               write b 128-bit vectors at "buffer" */
-            simdpackwithoutmask(datain + k * SIMDBlockSize, buffer, b);
-            /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-            simdunpack(buffer, backbuffer, b);/* uncompressed */
-            for (j = 0; j < SIMDBlockSize; ++j) {
-                if (backbuffer[j] != datain[k * SIMDBlockSize + j]) {
-                    printf("bug in simdpack\n");
-                    return -2;
-                }
-            }
-
-	    {
-                /*
-                 next part assumes that the data is sorted (uses differential coding)
-                */
-                uint32_t offset = 0;
-                /* we compute the bit width */
-                const uint32_t b1 = simdmaxbitsd1(offset,
-                    datain + k * SIMDBlockSize);
-               /* we read 128 integers at "datain + k * SIMDBlockSize" and
-                  write b1 128-bit vectors at "buffer" */
-               simdpackwithoutmaskd1(offset, datain + k * SIMDBlockSize, buffer,
-                    b1);
-               /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-               simdunpackd1(offset, buffer, backbuffer, b1);
-               for (j = 0; j < SIMDBlockSize; ++j) {
-                   if (backbuffer[j] != datain[k * SIMDBlockSize + j]) {
-                       printf("bug in simdpack d1\n");
-                       return -3;
-                   }
-               }
-               offset = datain[k * SIMDBlockSize + SIMDBlockSize - 1];
-	    }
-        }
-    }
-    free(buffer);
-    free(datain);
-    free(backbuffer);
-    printf("Code looks good.\n");
-    return 0;
-}
-
-#ifdef __SSE4_1__
-int testFOR() {
-    int N = 5000 * SIMDBlockSize, gap;
-    __m128i * buffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    uint32_t * backbuffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    uint32_t tmax, tmin, tb;
-    for (gap = 1; gap <= 387420489; gap *= 2) {
-        int k;
-        printf(" gap = %u \n", gap);
-        for (k = 0; k < N; ++k)
-            datain[k] = k * gap;
-        for (k = 0; k * SIMDBlockSize < N; ++k) {
-            int j;
-            simdmaxmin_length(datain + k * SIMDBlockSize,SIMDBlockSize,&tmin,&tmax);
-       	    /* we compute the bit width */
-            tb  = bits(tmax - tmin);
-
-
-            /* we read 128 integers at "datain + k * SIMDBlockSize" and
-               write b 128-bit vectors at "buffer" */
-            simdpackFOR(tmin,datain + k * SIMDBlockSize, buffer, tb);
-
-            for (j = 0; j < SIMDBlockSize; ++j) {
-                        uint32_t selectedvalue = simdselectFOR(tmin,buffer,tb,j);
-                    	if (selectedvalue != datain[k * SIMDBlockSize + j]) {
-                            printf("bug in simdselectFOR\n");
-                            return -3;
-                        }
-            }
-            /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-            simdunpackFOR(tmin,buffer, backbuffer, tb);/* uncompressed */
-            for (j = 0; j < SIMDBlockSize; ++j) {
-            	if (backbuffer[j] != datain[k * SIMDBlockSize + j]) {
-                    printf("bug in simdpackFOR\n");
-                    return -2;
-                }
-            }
-        }
-    }
-    free(buffer);
-    free(datain);
-    free(backbuffer);
-    printf("Code looks good.\n");
-    return 0;
-}
-#endif
-
-#define MAX 300
-int test_simdmaxbitsd1_length() {
-    uint32_t result, buffer[MAX + 1];
-    int i, j;
-
-    memset(&buffer[0], 0xff, sizeof(buffer));
-
-    /* this test creates buffers of different length; each buffer is
-     * initialized to result in the following deltas:
-     * length 1: 2
-     * length 2: 1 2
-     * length 3: 1 1 2
-     * length 4: 1 1 1 2
-     * length 5: 1 1 1 1 2
-     * etc. Each sequence's "maxbits" is 2. */
-    for (i = 0; i < MAX; i++) {
-      for (j = 0; j < i; j++)
-        buffer[j] = j + 1;
-      buffer[i] = i + 2;
-
-      result = simdmaxbitsd1_length(0, &buffer[0], i + 1);
-      if (result != 2) {
-        printf("simdmaxbitsd1_length: unexpected result %u in loop %d\n",
-                result, i);
-        return -1;
-      }
-    }
-    printf("simdmaxbitsd1_length: ok\n");
-    return 0;
-}
-
-int uint32_cmp(const void *a, const void *b)
-{
-    const uint32_t *ia = (const uint32_t *)a;
-    const uint32_t *ib = (const uint32_t *)b;
-    if(*ia < *ib)
-    	return -1;
-    else if (*ia > *ib)
-    	return 1;
-    return 0;
-}
-
-#ifdef __SSE4_1__
-int test_simdpackedsearch() {
-    uint32_t buffer[128];
-    uint32_t result = 0;
-    int b, i;
-    uint32_t init = 0;
-    __m128i initial = _mm_set1_epi32(init);
-
-    /* initialize the buffer */
-    for (i = 0; i < 128; i++)
-        buffer[i] = (uint32_t)(i + 1);
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 1; b <= 32; b++) {
-        uint32_t out[128];
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(init, buffer, (__m128i *)out, b);
-        initial = _mm_setzero_si128();
-        printf("simdsearchd1: %d bits\n", b);
-
-        /* now perform the searches */
-        initial = _mm_set1_epi32(init);
-        assert(simdsearchd1(&initial, (__m128i *)out, b, 0, &result) == 0);
-        assert(result > 0);
-
-        for (i = 1; i <= 128; i++) {
-        	initial = _mm_set1_epi32(init);
-            assert(simdsearchd1(&initial, (__m128i *)out, b,
-                                    (uint32_t)i, &result) == i - 1);
-            assert(result == (unsigned)i);
-        }
-        initial = _mm_set1_epi32(init);
-        assert(simdsearchd1(&initial, (__m128i *)out, b, 200, &result)
-                        == 128);
-        assert(result > 200);
-    }
-    printf("simdsearchd1: ok\n");
-    return 0;
-}
-
-int test_simdpackedsearchFOR() {
-    uint32_t buffer[128];
-    uint32_t result = 0;
-    int b;
-    uint32_t i;
-    uint32_t maxv, tmin, tmax, tb;
-    uint32_t out[128];
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 1; b <= 32; b++) {
-        /* initialize the buffer */
-    	maxv = (b == 32)
-    			? 0xFFFFFFFF
-    					: ((1U<<b) - 1);
-        for (i = 0; i < 128; i++)
-            buffer[i] = maxv * (i + 1) / 128;
-        simdmaxmin_length(buffer,SIMDBlockSize,&tmin,&tmax);
-   	    /* we compute the bit width */
-        tb  = bits(tmax - tmin);
-        /* delta-encode to 'i' bits */
-        simdpackFOR(tmin, buffer, (__m128i *)out, tb);
-        printf("simdsearchd1: %d bits\n", b);
-
-        /* now perform the searches */
-        for (i = 0; i < 128; i++) {
-        	assert(buffer[i] == simdselectFOR(tmin, (__m128i *)out, tb,i));
-        }
-        for (i = 0; i < 128; i++) {
-            int x = simdsearchwithlengthFOR(tmin, (__m128i *)out, tb,
-                                    128,buffer[i], &result) ;
-            assert(simdselectFOR(tmin, (__m128i *)out, tb,x) == buffer[x]);
-            assert(simdselectFOR(tmin, (__m128i *)out, tb,x) == result);
-            assert(buffer[x] == result);
-            assert(result == buffer[i]);
-            assert(buffer[x] == buffer[i]);
-        }
-    }
-    printf("simdsearchFOR: ok\n");
-    return 0;
-}
-
-int test_simdpackedsearch_advanced() {
-    uint32_t buffer[128];
-    uint32_t backbuffer[128];
-	uint32_t out[128];
-    uint32_t result = 0;
-    uint32_t b, i;
-    uint32_t init = 0;
-    __m128i initial = _mm_set1_epi32(init);
-
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 0; b <= 32; b++) {
-    	uint32_t prev = init;
-        /* initialize the buffer */
-        for (i = 0; i < 128; i++) {
-            buffer[i] =  ((uint32_t)(1431655765 * i + 0xFFFFFFFF)) ;
-            if(b < 32) buffer[i] %= (1<<b);
-        }
-
-        qsort(buffer,128, sizeof(uint32_t), uint32_cmp);
-
-        for (i = 0; i < 128; i++) {
-           buffer[i] = buffer[i] + prev;
-           prev = buffer[i];
-        }
-        for (i = 1; i < 128; i++) {
-        	if(buffer[i] < buffer[i-1] )
-        		buffer[i] = buffer[i-1];
-        }
-        assert(simdmaxbitsd1(init, buffer)<=b);
-        for (i = 0; i < 128; i++) {
-        	out[i] = 0; /* memset would do too */
-        }
-
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(init, buffer, (__m128i *)out, b);
-        simdunpackd1(init,  (__m128i *)out, backbuffer, b);
-
-        for (i = 0; i < 128; i++) {
-        	assert(buffer[i] == backbuffer[i]);
-        }
-
-        printf("advanced simdsearchd1: %d bits\n", b);
-
-        for (i = 0; i < 128; i++) {
-        	int pos;
-            initial = _mm_set1_epi32(init);
-        	pos = simdsearchd1(&initial, (__m128i *)out, b,
-                    buffer[i], &result);
-        	assert(pos == simdsearchwithlengthd1(init, (__m128i *)out, b, 128,
-                    buffer[i], &result));
-        	assert(buffer[pos] == buffer[i]);
-            if(pos > 0)
-            	assert(buffer[pos - 1] < buffer[i]);
-            assert(result == buffer[i]);
-        }
-        for (i = 0; i < 128; i++) {
-        	int pos;
-        	if(buffer[i] == 0) continue;
-        	initial = _mm_set1_epi32(init);
-        	pos = simdsearchd1(&initial, (__m128i *)out, b,
-                    buffer[i] - 1, &result);
-        	assert(pos == simdsearchwithlengthd1(init, (__m128i *)out, b, 128,
-                    buffer[i] - 1, &result));
-        	assert(buffer[pos] >= buffer[i]  - 1);
-            if(pos > 0)
-            	assert(buffer[pos - 1] < buffer[i]  - 1);
-            assert(result == buffer[pos]);
-        }
-		for (i = 0; i < 128; i++) {
-			int pos;
-			if (buffer[i] + 1 == 0)
-				continue;
-			initial = _mm_set1_epi32(init);
-			pos = simdsearchd1(&initial, (__m128i *) out, b,
-					buffer[i] + 1, &result);
-			assert(pos == simdsearchwithlengthd1(init, (__m128i *)out, b, 128,
-                    buffer[i] + 1, &result));
-			if(pos == 128) {
-				assert(buffer[i] == buffer[127]);
-			} else {
-			  assert(buffer[pos] >= buffer[i] + 1);
-			  if (pos > 0)
-				assert(buffer[pos - 1] < buffer[i] + 1);
-			  assert(result == buffer[pos]);
-			}
-		}
-    }
-    printf("advanced simdsearchd1: ok\n");
-    return 0;
-}
-
-int test_simdpackedselect() {
-    uint32_t buffer[128];
-    uint32_t initial = 33;
-    int b, i;
-
-    /* initialize the buffer */
-    for (i = 0; i < 128; i++)
-        buffer[i] = (uint32_t)(initial + i);
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 1; b <= 32; b++) {
-        uint32_t out[128];
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(initial, buffer, (__m128i *)out, b);
-
-        printf("simdselectd1: %d bits\n", b);
-
-        /* now perform the searches */
-        for (i = 0; i < 128; i++) {
-            assert(simdselectd1(initial, (__m128i *)out, b, (uint32_t)i)
-                            == initial + i);
-        }
-    }
-    printf("simdselectd1: ok\n");
-    return 0;
-}
-
-int test_simdpackedselect_advanced() {
-    uint32_t buffer[128];
-    uint32_t initial = 33;
-    uint32_t b;
-    int i;
-
-    /* this test creates delta encoded buffers with different bits, then
-     * performs lower bound searches for each key */
-    for (b = 0; b <= 32; b++) {
-        uint32_t prev = initial;
-    	uint32_t out[128];
-        /* initialize the buffer */
-        for (i = 0; i < 128; i++) {
-            buffer[i] =  ((uint32_t)(165576 * i)) ;
-            if(b < 32) buffer[i] %= (1<<b);
-        }
-        for (i = 0; i < 128; i++) {
-           buffer[i] = buffer[i] + prev;
-           prev = buffer[i];
-        }
-
-        for (i = 1; i < 128; i++) {
-        	if(buffer[i] < buffer[i-1] )
-        		buffer[i] = buffer[i-1];
-        }
-        assert(simdmaxbitsd1(initial, buffer)<=b);
-
-        for (i = 0; i < 128; i++) {
-        	out[i] = 0; /* memset would do too */
-        }
-
-        /* delta-encode to 'i' bits */
-        simdpackwithoutmaskd1(initial, buffer, (__m128i *)out, b);
-
-        printf("simdselectd1: %d bits\n", b);
-
-        /* now perform the searches */
-        for (i = 0; i < 128; i++) {
-        	uint32_t valretrieved = simdselectd1(initial, (__m128i *)out, b, (uint32_t)i);
-            assert(valretrieved == buffer[i]);
-        }
-    }
-    printf("advanced simdselectd1: ok\n");
-    return 0;
-}
-#endif
-
-
-int main() {
-    int r;
-    r =  testsetFOR();
-    if (r) {
-         printf("test failure 1\n");
-         return r;
-    }
-
-#ifdef __SSE4_1__
-    r =  testsetd1();
-    if (r) {
-         printf("test failure 2\n");
-         return r;
-    }
-#endif
-    r =  testset();
-    if (r) {
-         printf("test failure 3\n");
-         return r;
-    }
-
-    r = testshortFORpack();
-    if (r) {
-         printf("test failure 4\n");
-         return r;
-    }
-    r = testshortpack();
-    if (r) {
-         printf("test failure 5\n");
-         return r;
-    }
-    r = testlongpack();
-    if (r) {
-         printf("test failure 6\n");
-         return r;
-    }
-#ifdef __SSE4_1__
-    r = test_simdpackedsearchFOR();
-    if (r) {
-         printf("test failure 7\n");
-         return r;
-    }
-
-    r = testFOR();
-    if (r) {
-         printf("test failure 8\n");
-         return r;
-    }
-#endif
-#ifdef __AVX2__
-    r= testbabyavx();
-    if (r) {
-         printf("test failure baby avx\n");
-         return r;
-    }
-
-    r = testavx2();
-    if (r) {
-         printf("test failure 9 avx\n");
-         return r;
-    }
-#endif
-    r = test();
-    if (r) {
-         printf("test failure 9\n");
-         return r;
-    }
-
-    r = test_simdmaxbitsd1_length();
-    if (r) {
-         printf("test failure 10\n");
-         return r;
-    }
-#ifdef __SSE4_1__
-    r = test_simdpackedsearch();
-    if (r) {
-         printf("test failure 11\n");
-         return r;
-    }
-
-    r = test_simdpackedsearch_advanced();
-    if (r) {
-         printf("test failure 12\n");
-         return r;
-    }
-
-    r = test_simdpackedselect();
-    if (r) {
-         printf("test failure 13\n");
-         return r;
-    }
-
-    r = test_simdpackedselect_advanced();
-    if (r) {
-         printf("test failure 14\n");
-         return r;
-    }
-#endif
-    printf("All tests OK!\n");
-
-
-    return 0;
-}

cpp/simdcomp/tests/unit_chars.c

@@ -1,102 +0,0 @@
-/**
- * This code is released under a BSD License.
- */
-#include <stdio.h>
-#include <stdlib.h>
-#include <time.h>
-#include "simdcomp.h"
-
-
-#define get_random_char() (uint8_t)(rand() % 256);
-
-
-int main() {
-    int N = 5000 * SIMDBlockSize, gap;
-    __m128i * buffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-    uint32_t * datain = malloc(N * sizeof(uint32_t));
-    uint32_t * backbuffer = malloc(SIMDBlockSize * sizeof(uint32_t));
-
-    srand(time(NULL));
-
-    for (gap = 1; gap <= 387420489; gap *= 3) {
-        int k;
-        printf(" gap = %u \n", gap);
-
-    /* simulate some random character string, don't care about endiannes */
-        for (k = 0; k < N; ++k) {
-        uint8_t _tmp[4];
- 
-            _tmp[0] = get_random_char();
-            _tmp[1] = get_random_char();
-            _tmp[2] = get_random_char();
-            _tmp[3] = get_random_char();
-
-            memmove(&datain[k], _tmp, 4);
-        }
-        for (k = 0; k * SIMDBlockSize < N; ++k) {
-            /*
-               First part works for general arrays (sorted or unsorted)
-            */
-            int j;
-               /* we compute the bit width */
-            const uint32_t b = maxbits(datain + k * SIMDBlockSize);
-            /* we read 128 integers at "datain + k * SIMDBlockSize" and
-               write b 128-bit vectors at "buffer" */
-            simdpackwithoutmask(datain + k * SIMDBlockSize, buffer, b);
-            /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-            simdunpack(buffer, backbuffer, b);/* uncompressed */
-            for (j = 0; j < SIMDBlockSize; ++j) {
-                uint8_t chars_back[4];
-                uint8_t chars_in[4];
-
-                memmove(chars_back, &backbuffer[j], 4);
-                memmove(chars_in, &datain[k * SIMDBlockSize + j], 4);
-
-                if (chars_in[0] != chars_back[0]
-                    || chars_in[1] != chars_back[1]
-                    || chars_in[2] != chars_back[2]
-                    || chars_in[3] != chars_back[3]) {
-                    printf("bug in simdpack\n");
-                    return -2;
-                }
-            }
-
-            {
-                /*
-                 next part assumes that the data is sorted (uses differential coding)
-                */
-                uint32_t offset = 0;
-                /* we compute the bit width */
-                const uint32_t b1 = simdmaxbitsd1(offset,
-                datain + k * SIMDBlockSize);
-                   /* we read 128 integers at "datain + k * SIMDBlockSize" and
-                  write b1 128-bit vectors at "buffer" */
-                   simdpackwithoutmaskd1(offset, datain + k * SIMDBlockSize, buffer,
-                b1);
-                   /* we read back b1 128-bit vectors at "buffer" and write 128 integers at backbuffer */
-                   simdunpackd1(offset, buffer, backbuffer, b1);
-                for (j = 0; j < SIMDBlockSize; ++j) {
-                    uint8_t chars_back[4];
-                    uint8_t chars_in[4];
-
-                    memmove(chars_back, &backbuffer[j], 4);
-                    memmove(chars_in, &datain[k * SIMDBlockSize + j], 4);
-
-                    if (chars_in[0] != chars_back[0]
-                        || chars_in[1] != chars_back[1]
-                        || chars_in[2] != chars_back[2]
-                        || chars_in[3] != chars_back[3]) {
-                        printf("bug in simdpack\n");
-                        return -3;
-                    }
-                }
-                offset = datain[k * SIMDBlockSize + SIMDBlockSize - 1];
-            }
-        }
-    }
-    free(buffer);
-    free(datain);
-    free(backbuffer);
-    printf("Code looks good.\n");
-    return 0;
-}

cpp/simdcomp_wrapper.c

@@ -1,42 +0,0 @@
-#include "simdcomp.h"
-#include "simdcomputil.h"
-
-// assumes datain has a size of 128 uint32
-// and that buffer is large enough to host the data.
-size_t compress_sorted(
-        const uint32_t* datain,
-        uint8_t* output,
-        const uint32_t offset) {
-    const uint32_t b = simdmaxbitsd1(offset, datain);
-    *output++ = b;
-    simdpackwithoutmaskd1(offset, datain, (__m128i *) output,  b);
-    return 1 + b * sizeof(__m128i);
-}
-
-// assumes datain has a size of 128 uint32
-// and that buffer is large enough to host the data.
-size_t uncompress_sorted(
-        const uint8_t* compressed_data, 
-        uint32_t* output, 
-        uint32_t offset) {
-    const uint32_t b = *compressed_data++;
-    simdunpackd1(offset, (__m128i *)compressed_data, output, b);
-    return 1 + b * sizeof(__m128i);
-}
-
-size_t compress_unsorted(
-        const uint32_t* datain,
-        uint8_t* output) {
-    const uint32_t b = maxbits(datain);
-    *output++ = b;
-    simdpackwithoutmask(datain, (__m128i *) output,  b);
-    return 1 + b * sizeof(__m128i);
-}
-
-size_t uncompress_unsorted(
-        const uint8_t* compressed_data, 
-        uint32_t* output) {
-    const uint32_t b = *compressed_data++;
-    simdunpack((__m128i *)compressed_data, output, b);
-    return 1 + b * sizeof(__m128i);
-}

cpp/streamvbyte/.gitignore

@@ -1,32 +0,0 @@
-# Object files
-*.o
-*.ko
-*.obj
-*.elf
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Libraries
-*.lib
-*.a
-*.la
-*.lo
-
-# Shared objects (inc. Windows DLLs)
-*.dll
-*.so
-*.so.*
-*.dylib
-
-# Executables
-*.exe
-*.out
-*.app
-*.i*86
-*.x86_64
-*.hex
-
-# Debug files
-*.dSYM/

cpp/streamvbyte/.travis.yml

@@ -1,7 +0,0 @@
-language: c
-sudo: false
-compiler:
-  - gcc
-  - clang
-
-script: make && ./unit

cpp/streamvbyte/LICENSE

@@ -1,202 +0,0 @@
-Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-

cpp/streamvbyte/README.md

@@ -1,60 +0,0 @@
-streamvbyte
-===========
-[![Build Status](https://travis-ci.org/lemire/streamvbyte.png)](https://travis-ci.org/lemire/streamvbyte)
-
-StreamVByte is a new integer compression technique that applies SIMD instructions (vectorization) to
-Google's Group Varint approach. The net result is faster than other byte-oriented compression
-techniques.
-
-The approach is patent-free, the code is available under the Apache License.
-
-
-It includes fast differential coding.
-
-It assumes a recent Intel processor (e.g., haswell or better) .
-
-The code should build using most standard-compliant C99 compilers. The provided makefile
-expects a Linux-like system.
-
-
-Usage:
-
-      make
-      ./unit
-
-See example.c for an example.
-
-Short code sample:
-```C
-// suppose that datain is an array of uint32_t integers
-size_t compsize = streamvbyte_encode(datain, N, compressedbuffer); // encoding
-// here the result is stored in compressedbuffer using compsize bytes
-streamvbyte_decode(compressedbuffer, recovdata, N); // decoding (fast)
-```
-
-If the values are sorted, then it might be preferable to use differential coding:
-```C
-// suppose that datain is an array of uint32_t integers
-size_t compsize = streamvbyte_delta_encode(datain, N, compressedbuffer,0); // encoding
-// here the result is stored in compressedbuffer using compsize bytes
-streamvbyte_delta_decode(compressedbuffer, recovdata, N,0); // decoding (fast)
-```
-You have to know how many integers were coded when you decompress. You can store this 
-information along with the compressed stream.
-
-See also
---------
-* SIMDCompressionAndIntersection: A C++ library to compress and intersect sorted lists of integers using SIMD instructions https://github.com/lemire/SIMDCompressionAndIntersect
-* The FastPFOR C++ library : Fast integer compression https://github.com/lemire/FastPFor
-* High-performance dictionary coding https://github.com/lemire/dictionary
-* LittleIntPacker: C library to pack and unpack short arrays of integers as fast as possible https://github.com/lemire/LittleIntPacker
-* The SIMDComp library: A simple C library for compressing lists of integers using binary packing https://github.com/lemire/simdcomp
-* MaskedVByte: Fast decoder for VByte-compressed integers https://github.com/lemire/MaskedVByte
-* CSharpFastPFOR: A C#  integer compression library  https://github.com/Genbox/CSharpFastPFOR
-* JavaFastPFOR: A java integer compression library https://github.com/lemire/JavaFastPFOR
-* Encoding: Integer Compression Libraries for Go https://github.com/zhenjl/encoding
-* FrameOfReference is a C++ library dedicated to frame-of-reference (FOR) compression: https://github.com/lemire/FrameOfReference
-* libvbyte: A fast implementation for varbyte 32bit/64bit integer compression https://github.com/cruppstahl/libvbyte
-* TurboPFor is a C library that offers lots of interesting optimizations. Well worth checking! (GPL license) https://github.com/powturbo/TurboPFor
-* Oroch is a C++ library that offers a usable API (MIT license) https://github.com/ademakov/Oroch
-

cpp/streamvbyte/example.c

@@ -1,24 +0,0 @@
-#include <stdio.h>
-#include <stdlib.h>
-#include <assert.h>
-
-#include "streamvbyte.h"
-
-int main() {
-	int N = 5000;
-	uint32_t * datain = malloc(N * sizeof(uint32_t));
-	uint8_t * compressedbuffer = malloc(N * sizeof(uint32_t));
-	uint32_t * recovdata = malloc(N * sizeof(uint32_t));
-	for (int k = 0; k < N; ++k)
-		datain[k] = 120;
-	size_t compsize = streamvbyte_encode(datain, N, compressedbuffer); // encoding
-	// here the result is stored in compressedbuffer using compsize bytes
-	size_t compsize2 = streamvbyte_decode(compressedbuffer, recovdata,
-					N); // decoding (fast)
-	assert(compsize == compsize2);
-	free(datain);
-	free(compressedbuffer);
-	free(recovdata);
-	printf("Compressed %d integers down to %d bytes.\n",N,(int) compsize);
-	return 0;
-}

cpp/streamvbyte/include/streamvbyte.h

@@ -1,19 +0,0 @@
-
-#ifndef VARINTDECODE_H_
-#define VARINTDECODE_H_
-#define __STDC_FORMAT_MACROS
-#include <inttypes.h>
-#include <stdint.h>// please use a C99-compatible compiler
-#include <stddef.h>
-
-
-// Encode an array of a given length read from in to bout in varint format.
-// Returns the number of bytes written.
-size_t streamvbyte_encode(const uint32_t *in, uint32_t length, uint8_t *out);
-
-// Read "length" 32-bit integers in varint format from in, storing the result in out.
-// Returns the number of bytes read.
-size_t streamvbyte_decode(const uint8_t* in, uint32_t* out, uint32_t length);
-
-
-#endif /* VARINTDECODE_H_ */

cpp/streamvbyte/include/streamvbytedelta.h

@@ -1,24 +0,0 @@
-/*
- * streamvbytedelta.h
- *
- *  Created on: Apr 14, 2016
- *      Author: lemire
- */
-
-#ifndef INCLUDE_STREAMVBYTEDELTA_H_
-#define INCLUDE_STREAMVBYTEDELTA_H_
-
-
-// Encode an array of a given length read from in to bout in StreamVByte format.
-// Returns the number of bytes written.
-// this version uses differential coding (coding differences between values) starting at prev (you can often set prev to zero)
-size_t streamvbyte_delta_encode(const uint32_t *in, uint32_t length, uint8_t *out, uint32_t  prev);
-
-// Read "length" 32-bit integers in StreamVByte format from in, storing the result in out.
-// Returns the number of bytes read.
-// this version uses differential coding (coding differences between values) starting at prev (you can often set prev to zero)
-size_t streamvbyte_delta_decode(const uint8_t* in, uint32_t* out, uint32_t length, uint32_t  prev);
-
-
-
-#endif /* INCLUDE_STREAMVBYTEDELTA_H_ */

cpp/streamvbyte/makefile

@@ -1,58 +0,0 @@
-# minimalist makefile
-.SUFFIXES:
-#
-.SUFFIXES: .cpp .o .c .h
-
-CFLAGS = -fPIC -march=native -std=c99 -O3 -Wall -Wextra -pedantic -Wshadow
-LDFLAGS = -shared
-LIBNAME=libstreamvbyte.so.0.0.1
-all:  unit $(LIBNAME)
-test:
-	./unit
-install: $(OBJECTS)
-	cp $(LIBNAME) /usr/local/lib
-	ln -s /usr/local/lib/$(LIBNAME) /usr/local/lib/libstreamvbyte.so
-	ldconfig
-	cp $(HEADERS) /usr/local/include
-
-
-
-HEADERS=./include/streamvbyte.h ./include/streamvbytedelta.h 
-
-uninstall:
-	for h in $(HEADERS) ; do rm  /usr/local/$$h; done
-	rm  /usr/local/lib/$(LIBNAME)
-	rm /usr/local/lib/libstreamvbyte.so
-	ldconfig
-
-
-OBJECTS= streamvbyte.o streamvbytedelta.o
-
-
-
-streamvbytedelta.o: ./src/streamvbytedelta.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/streamvbytedelta.c -Iinclude
-
-
-streamvbyte.o: ./src/streamvbyte.c $(HEADERS)
-	$(CC) $(CFLAGS) -c ./src/streamvbyte.c -Iinclude
-
-
-
-$(LIBNAME): $(OBJECTS)
-	$(CC) $(CFLAGS) -o $(LIBNAME) $(OBJECTS)  $(LDFLAGS)
-
-
-
-
-example: ./example.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o example ./example.c -Iinclude  $(OBJECTS)
-
-unit: ./tests/unit.c    $(HEADERS) $(OBJECTS)
-	$(CC) $(CFLAGS) -o unit ./tests/unit.c -Iinclude  $(OBJECTS)
-
-dynunit: ./tests/unit.c    $(HEADERS) $(LIBNAME)
-	$(CC) $(CFLAGS) -o dynunit ./tests/unit.c -Iinclude  -lstreamvbyte
-
-clean:
-	rm -f unit *.o $(LIBNAME) example

cpp/streamvbyte/src/streamvbyte.c

@@ -1,495 +0,0 @@
-#include "streamvbyte.h"
-#if defined(_MSC_VER)
-     /* Microsoft C/C++-compatible compiler */
-     #include <intrin.h>
-#elif defined(__GNUC__) && (defined(__x86_64__) || defined(__i386__))
-     /* GCC-compatible compiler, targeting x86/x86-64 */
-     #include <x86intrin.h>
-#elif defined(__GNUC__) && defined(__ARM_NEON__)
-     /* GCC-compatible compiler, targeting ARM with NEON */
-     #include <arm_neon.h>
-#elif defined(__GNUC__) && defined(__IWMMXT__)
-     /* GCC-compatible compiler, targeting ARM with WMMX */
-     #include <mmintrin.h>
-#elif (defined(__GNUC__) || defined(__xlC__)) && (defined(__VEC__) || defined(__ALTIVEC__))
-     /* XLC or GCC-compatible compiler, targeting PowerPC with VMX/VSX */
-     #include <altivec.h>
-#elif defined(__GNUC__) && defined(__SPE__)
-     /* GCC-compatible compiler, targeting PowerPC with SPE */
-     #include <spe.h>
-#endif
-
-static uint8_t lengthTable[256] = { 4, 5, 6, 7, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9,
-		10, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10, 11, 6, 7, 8, 9, 7, 8,
-		9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10,
-		11, 12, 10, 11, 12, 13, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10,
-		11, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 7, 8, 9, 10,
-		8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 8, 9, 10, 11, 9, 10, 11,
-		12, 10, 11, 12, 13, 11, 12, 13, 14, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10,
-		11, 9, 10, 11, 12, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12,
-		13, 8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 11, 12, 13, 14, 9, 10,
-		11, 12, 10, 11, 12, 13, 11, 12, 13, 14, 12, 13, 14, 15, 7, 8, 9, 10, 8,
-		9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 8, 9, 10, 11, 9, 10, 11, 12,
-		10, 11, 12, 13, 11, 12, 13, 14, 9, 10, 11, 12, 10, 11, 12, 13, 11, 12,
-		13, 14, 12, 13, 14, 15, 10, 11, 12, 13, 11, 12, 13, 14, 12, 13, 14, 15,
-		13, 14, 15, 16 };
-
-static uint8_t shuffleTable[256][16] = { { 0, -1, -1, -1, 1, -1, -1, -1, 2, -1,
-		-1, -1, 3, -1, -1, -1 }, // 1111
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, -1, -1, -1 },  // 2111
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 3111
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 4111
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, -1, -1, -1 },  // 1211
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 2211
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 3211
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, -1, -1, -1 },     // 4211
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 1311
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 2311
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, -1, -1, -1 },     // 3311
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, -1, -1, -1 },      // 4311
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, -1, -1, -1 },    // 1411
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, -1, -1, -1 },     // 2411
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, -1, -1, -1 },      // 3411
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, -1, -1, -1 },       // 4411
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1 },  // 1121
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, -1, -1, -1 },   // 2121
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 3121
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 4121
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, -1, -1, -1 },   // 1221
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 2221
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 3221
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, -1, -1, -1 },      // 4221
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 1321
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 2321
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, -1, -1, -1 },      // 3321
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, -1, -1, -1 },       // 4321
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, -1, -1, -1 },     // 1421
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, -1, -1, -1 },      // 2421
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, -1, -1, -1 },       // 3421
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, -1, -1, -1 },       // 4421
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1 },   // 1131
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, -1, -1, -1 },    // 2131
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 3131
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 4131
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, -1, -1, -1 },    // 1231
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 2231
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 3231
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, -1, -1, -1 },       // 4231
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 1331
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 2331
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, -1, -1, -1 },       // 3331
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, -1, -1, -1 },       // 4331
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, -1, -1, -1 },      // 1431
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, -1, -1, -1 },       // 2431
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, -1, -1, -1 },       // 3431
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, -1, -1, -1 },       // 4431
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1 },    // 1141
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, -1, -1, -1 },     // 2141
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 3141
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 4141
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, -1, -1, -1 },     // 1241
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 2241
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 3241
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, -1, -1, -1 },       // 4241
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 1341
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 2341
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, -1, -1, -1 },       // 3341
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, -1, -1, -1 },       // 4341
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1 },       // 1441
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, -1, -1 },       // 2441
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1, -1, -1 },       // 3441
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1, -1, -1 },       // 4441
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1 },  // 1112
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, -1, -1 },   // 2112
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 3112
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 4112
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, -1, -1 },   // 1212
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 2212
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 3212
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, -1, -1 },      // 4212
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 1312
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 2312
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, -1, -1 },      // 3312
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, -1, -1 },       // 4312
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, -1, -1 },     // 1412
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, -1, -1 },      // 2412
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, -1, -1 },       // 3412
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, -1, -1 },       // 4412
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1 },   // 1122
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, -1, -1 },    // 2122
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 3122
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 4122
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, -1, -1 },    // 1222
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 2222
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 3222
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, -1, -1 },       // 4222
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 1322
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 2322
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, -1, -1 },       // 3322
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, -1, -1 },       // 4322
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, -1, -1 },      // 1422
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, -1, -1 },       // 2422
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, -1, -1 },       // 3422
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, -1, -1 },       // 4422
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1 },    // 1132
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, -1, -1 },     // 2132
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 3132
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 4132
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, -1, -1 },     // 1232
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 2232
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 3232
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, -1, -1 },       // 4232
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 1332
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 2332
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, -1, -1 },       // 3332
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, -1, -1 },       // 4332
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, -1, -1 },       // 1432
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, -1, -1 },       // 2432
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, -1, -1 },       // 3432
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, -1, -1 },       // 4432
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1 },     // 1142
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, -1, -1 },      // 2142
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 3142
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 4142
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, -1, -1 },      // 1242
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 2242
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 3242
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, -1, -1 },       // 4242
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 1342
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 2342
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, -1, -1 },       // 3342
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, -1, -1 },       // 4342
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, -1 },       // 1442
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1, -1 },       // 2442
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1, -1 },       // 3442
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1, -1 },       // 4442
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1 },   // 1113
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, 6, -1 },    // 2113
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 3113
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 4113
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, 6, -1 },    // 1213
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 2213
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 3213
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, 9, -1 },       // 4213
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 1313
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 2313
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, 9, -1 },       // 3313
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, 10, -1 },       // 4313
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, 8, -1 },      // 1413
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, 9, -1 },       // 2413
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, 10, -1 },       // 3413
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, 11, -1 },       // 4413
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1 },    // 1123
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, 7, -1 },     // 2123
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 3123
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 4123
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, 7, -1 },     // 1223
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 2223
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 3223
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, 10, -1 },       // 4223
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 1323
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 2323
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, 10, -1 },       // 3323
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, 11, -1 },       // 4323
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, 9, -1 },       // 1423
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, 10, -1 },       // 2423
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, 11, -1 },       // 3423
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, 12, -1 },       // 4423
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1 },     // 1133
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, 8, -1 },      // 2133
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 3133
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 4133
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, 8, -1 },      // 1233
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 2233
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 3233
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, 11, -1 },       // 4233
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 1333
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 2333
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, 11, -1 },       // 3333
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, 12, -1 },       // 4333
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, 10, -1 },       // 1433
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, 11, -1 },       // 2433
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, 12, -1 },       // 3433
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, 13, -1 },       // 4433
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1 },      // 1143
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, 9, -1 },       // 2143
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 3143
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 4143
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, 9, -1 },       // 1243
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 2243
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 3243
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, 12, -1 },       // 4243
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 1343
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 2343
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, 12, -1 },       // 3343
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, 13, -1 },       // 4343
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1 },       // 1443
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1 },       // 2443
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 },       // 3443
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, -1 },       // 4443
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6 },    // 1114
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, 6, 7 },     // 2114
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 3114
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 4114
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, 6, 7 },     // 1214
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 2214
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 3214
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, 9, 10 },       // 4214
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 1314
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 2314
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, 9, 10 },       // 3314
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, 10, 11 },       // 4314
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, 8, 9 },       // 1414
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, 9, 10 },       // 2414
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, 10, 11 },       // 3414
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, 11, 12 },       // 4414
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7 },     // 1124
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, 7, 8 },      // 2124
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 3124
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 4124
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, 7, 8 },      // 1224
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 2224
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 3224
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, 10, 11 },       // 4224
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 1324
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 2324
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, 10, 11 },       // 3324
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, 11, 12 },       // 4324
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, 9, 10 },       // 1424
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, 10, 11 },       // 2424
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, 11, 12 },       // 3424
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, 12, 13 },       // 4424
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8 },      // 1134
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, 8, 9 },       // 2134
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 3134
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 4134
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, 8, 9 },       // 1234
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 2234
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 3234
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, 11, 12 },       // 4234
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 1334
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 2334
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, 11, 12 },       // 3334
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, 12, 13 },       // 4334
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, 10, 11 },       // 1434
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, 11, 12 },       // 2434
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, 12, 13 },       // 3434
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, 13, 14 },       // 4434
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9 },       // 1144
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, 9, 10 },       // 2144
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 3144
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 4144
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, 9, 10 },       // 1244
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 2244
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 3244
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, 12, 13 },       // 4244
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 1344
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 2344
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, 12, 13 },       // 3344
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, 13, 14 },       // 4344
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 },       // 1444
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 },       // 2444
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 },       // 3444
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }        // 4444
-};
-
-static uint8_t _encode_data(uint32_t val, uint8_t *__restrict__ *dataPtrPtr) {
-	uint8_t *dataPtr = *dataPtrPtr;
-	uint8_t code;
-
-	if (val < (1 << 8)) { // 1 byte
-		*dataPtr = (uint8_t)(val);
-		*dataPtrPtr += 1;
-		code = 0;
-	} else if (val < (1 << 16)) { // 2 bytes
-		*(uint16_t *) dataPtr = (uint16_t)(val);
-		*dataPtrPtr += 2;
-		code = 1;
-	} else if (val < (1 << 24)) { // 3 bytes
-		*(uint16_t *) dataPtr = (uint16_t)(val);
-		*(dataPtr + 2) = (uint8_t)(val >> 16);
-		*dataPtrPtr += 3;
-		code = 2;
-	} else { // 4 bytes
-		*(uint32_t *) dataPtr = val;
-		*dataPtrPtr += 4;
-		code = 3;
-	}
-
-	return code;
-}
-
-static uint8_t *svb_encode_scalar(const uint32_t *in,
-		uint8_t *__restrict__ keyPtr, uint8_t *__restrict__ dataPtr,
-		uint32_t count) {
-	if (count == 0)
-		return dataPtr; // exit immediately if no data
-
-	uint8_t shift = 0; // cycles 0, 2, 4, 6, 0, 2, 4, 6, ...
-	uint8_t key = 0;
-	for (uint32_t c = 0; c < count; c++) {
-		if (shift == 8) {
-			shift = 0;
-			*keyPtr++ = key;
-			key = 0;
-		}
-		uint32_t val = in[c];
-		uint8_t code = _encode_data(val, &dataPtr);
-		key |= code << shift;
-		shift += 2;
-	}
-
-	*keyPtr = key;  // write last key (no increment needed)
-	return dataPtr; // pointer to first unused data byte
-}
-
-// Encode an array of a given length read from in to bout in streamvbyte format.
-// Returns the number of bytes written.
-size_t streamvbyte_encode(const uint32_t *in, uint32_t count, uint8_t *out) {
-	uint8_t *keyPtr = out;
-	uint32_t keyLen = (count + 3) / 4; // 2-bits rounded to full byte
-	uint8_t *dataPtr = keyPtr + keyLen; // variable byte data after all keys
-	return svb_encode_scalar(in, keyPtr, dataPtr, count) - out;
-}
-
-static inline __m128i _decode_avx(uint32_t key,
-		const uint8_t *__restrict__ *dataPtrPtr) {
-	uint8_t len = lengthTable[key];
-	__m128i Data = _mm_loadu_si128((__m128i *) *dataPtrPtr);
-	__m128i Shuf = *(__m128i *) &shuffleTable[key];
-
-	Data = _mm_shuffle_epi8(Data, Shuf);
-	*dataPtrPtr += len;
-	return Data;
-}
-
-static inline void _write_avx(uint32_t *out, __m128i Vec) {
-	_mm_storeu_si128((__m128i *) out, Vec);
-}
-
-static inline uint32_t _decode_data(const uint8_t **dataPtrPtr, uint8_t code) {
-	const uint8_t *dataPtr = *dataPtrPtr;
-	uint32_t val;
-
-	if (code == 0) { // 1 byte
-		val = (uint32_t) * dataPtr;
-		dataPtr += 1;
-	} else if (code == 1) { // 2 bytes
-		val = (uint32_t) * (uint16_t *) dataPtr;
-		dataPtr += 2;
-	} else if (code == 2) { // 3 bytes
-		val = (uint32_t) * (uint16_t *) dataPtr;
-		val |= *(dataPtr + 2) << 16;
-		dataPtr += 3;
-	} else {                      // code == 3
-		val = *(uint32_t *) dataPtr; // 4 bytes
-		dataPtr += 4;
-	}
-
-	*dataPtrPtr = dataPtr;
-	return val;
-}
-static const uint8_t *svb_decode_scalar(uint32_t *outPtr, const uint8_t *keyPtr,
-		const uint8_t *dataPtr, uint32_t count) {
-	if (count == 0)
-		return dataPtr; // no reads or writes if no data
-
-	uint8_t shift = 0;
-	uint32_t key = *keyPtr++;
-	for (uint32_t c = 0; c < count; c++) {
-		if (shift == 8) {
-			shift = 0;
-			key = *keyPtr++;
-		}
-		uint32_t val = _decode_data(&dataPtr, (key >> shift) & 0x3);
-		*outPtr++ = val;
-		shift += 2;
-	}
-
-	return dataPtr; // pointer to first unused byte after end
-}
-
-const uint8_t *svb_decode_avx_simple(uint32_t *out,
-		const uint8_t *__restrict__ keyPtr, const uint8_t *__restrict__ dataPtr,
-		uint64_t count) {
-
-	uint64_t keybytes = count / 4; // number of key bytes
-	__m128i Data;
-	if (keybytes >= 8) {
-
-		int64_t Offset = -(int64_t) keybytes / 8 + 1;
-
-		const uint64_t *keyPtr64 = (const uint64_t *) keyPtr - Offset;
-		uint64_t nextkeys = keyPtr64[Offset];
-		for (; Offset != 0; ++Offset) {
-			uint64_t keys = nextkeys;
-			nextkeys = keyPtr64[Offset + 1];
-
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 4, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 8, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 12, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 16, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 20, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 24, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 28, Data);
-
-			out += 32;
-		}
-		{
-			uint64_t keys = nextkeys;
-
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 4, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 8, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 12, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 16, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 20, Data);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0xFF), &dataPtr);
-			_write_avx(out + 24, Data);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			_write_avx(out + 28, Data);
-
-			out += 32;
-		}
-	}
-	uint64_t consumedkeys = keybytes - (keybytes & 7);
-	return svb_decode_scalar(out, keyPtr + consumedkeys, dataPtr, count & 31);
-}
-
-// Read count 32-bit integers in maskedvbyte format from in, storing the result in out.  Returns the number of bytes read.
-size_t streamvbyte_decode(const uint8_t* in, uint32_t* out, uint32_t count) {
-	if (count == 0)
-		return 0;
-	const uint8_t *keyPtr = in;            // full list of keys is next
-	uint32_t keyLen = ((count + 3) / 4); // 2-bits per key (rounded up)
-	const uint8_t *dataPtr = keyPtr + keyLen;  // data starts at end of keys
-	return svb_decode_avx_simple(out, keyPtr, dataPtr, count) - in;
-
-}

cpp/streamvbyte/src/streamvbytedelta.c

@@ -1,575 +0,0 @@
-#include "streamvbyte.h"
-#if defined(_MSC_VER)
-     /* Microsoft C/C++-compatible compiler */
-     #include <intrin.h>
-#elif defined(__GNUC__) && (defined(__x86_64__) || defined(__i386__))
-     /* GCC-compatible compiler, targeting x86/x86-64 */
-     #include <x86intrin.h>
-#elif defined(__GNUC__) && defined(__ARM_NEON__)
-     /* GCC-compatible compiler, targeting ARM with NEON */
-     #include <arm_neon.h>
-#elif defined(__GNUC__) && defined(__IWMMXT__)
-     /* GCC-compatible compiler, targeting ARM with WMMX */
-     #include <mmintrin.h>
-#elif (defined(__GNUC__) || defined(__xlC__)) && (defined(__VEC__) || defined(__ALTIVEC__))
-     /* XLC or GCC-compatible compiler, targeting PowerPC with VMX/VSX */
-     #include <altivec.h>
-#elif defined(__GNUC__) && defined(__SPE__)
-     /* GCC-compatible compiler, targeting PowerPC with SPE */
-     #include <spe.h>
-#endif
-
-static uint8_t lengthTable[256] = { 4, 5, 6, 7, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9,
-		10, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10, 11, 6, 7, 8, 9, 7, 8,
-		9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10,
-		11, 12, 10, 11, 12, 13, 5, 6, 7, 8, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10,
-		11, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 7, 8, 9, 10,
-		8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 8, 9, 10, 11, 9, 10, 11,
-		12, 10, 11, 12, 13, 11, 12, 13, 14, 6, 7, 8, 9, 7, 8, 9, 10, 8, 9, 10,
-		11, 9, 10, 11, 12, 7, 8, 9, 10, 8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12,
-		13, 8, 9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 11, 12, 13, 14, 9, 10,
-		11, 12, 10, 11, 12, 13, 11, 12, 13, 14, 12, 13, 14, 15, 7, 8, 9, 10, 8,
-		9, 10, 11, 9, 10, 11, 12, 10, 11, 12, 13, 8, 9, 10, 11, 9, 10, 11, 12,
-		10, 11, 12, 13, 11, 12, 13, 14, 9, 10, 11, 12, 10, 11, 12, 13, 11, 12,
-		13, 14, 12, 13, 14, 15, 10, 11, 12, 13, 11, 12, 13, 14, 12, 13, 14, 15,
-		13, 14, 15, 16 };
-
-static uint8_t shuffleTable[256][16] = { { 0, -1, -1, -1, 1, -1, -1, -1, 2, -1,
-		-1, -1, 3, -1, -1, -1 }, // 1111
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, -1, -1, -1 },  // 2111
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 3111
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 4111
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, -1, -1, -1 },  // 1211
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 2211
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 3211
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, -1, -1, -1 },     // 4211
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, -1, -1, -1 },   // 1311
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, -1, -1, -1 },    // 2311
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, -1, -1, -1 },     // 3311
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, -1, -1, -1 },      // 4311
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, -1, -1, -1 },    // 1411
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, -1, -1, -1 },     // 2411
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, -1, -1, -1 },      // 3411
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, -1, -1, -1 },       // 4411
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1 },  // 1121
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, -1, -1, -1 },   // 2121
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 3121
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 4121
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, -1, -1, -1 },   // 1221
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 2221
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 3221
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, -1, -1, -1 },      // 4221
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, -1, -1, -1 },    // 1321
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, -1, -1, -1 },     // 2321
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, -1, -1, -1 },      // 3321
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, -1, -1, -1 },       // 4321
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, -1, -1, -1 },     // 1421
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, -1, -1, -1 },      // 2421
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, -1, -1, -1 },       // 3421
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, -1, -1, -1 },       // 4421
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1 },   // 1131
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, -1, -1, -1 },    // 2131
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 3131
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 4131
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, -1, -1, -1 },    // 1231
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 2231
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 3231
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, -1, -1, -1 },       // 4231
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, -1, -1, -1 },     // 1331
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, -1, -1, -1 },      // 2331
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, -1, -1, -1 },       // 3331
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, -1, -1, -1 },       // 4331
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, -1, -1, -1 },      // 1431
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, -1, -1, -1 },       // 2431
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, -1, -1, -1 },       // 3431
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, -1, -1, -1 },       // 4431
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1 },    // 1141
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, -1, -1, -1 },     // 2141
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 3141
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 4141
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, -1, -1, -1 },     // 1241
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 2241
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 3241
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, -1, -1, -1 },       // 4241
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, -1, -1, -1 },      // 1341
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, -1, -1, -1 },       // 2341
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, -1, -1, -1 },       // 3341
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, -1, -1, -1 },       // 4341
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1 },       // 1441
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, -1, -1 },       // 2441
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1, -1, -1 },       // 3441
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1, -1, -1 },       // 4441
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1 },  // 1112
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, -1, -1 },   // 2112
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 3112
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 4112
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, -1, -1 },   // 1212
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 2212
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 3212
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, -1, -1 },      // 4212
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, -1, -1 },    // 1312
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, -1, -1 },     // 2312
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, -1, -1 },      // 3312
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, -1, -1 },       // 4312
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, -1, -1 },     // 1412
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, -1, -1 },      // 2412
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, -1, -1 },       // 3412
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, -1, -1 },       // 4412
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1 },   // 1122
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, -1, -1 },    // 2122
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 3122
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 4122
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, -1, -1 },    // 1222
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 2222
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 3222
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, -1, -1 },       // 4222
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, -1, -1 },     // 1322
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, -1, -1 },      // 2322
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, -1, -1 },       // 3322
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, -1, -1 },       // 4322
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, -1, -1 },      // 1422
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, -1, -1 },       // 2422
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, -1, -1 },       // 3422
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, -1, -1 },       // 4422
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1 },    // 1132
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, -1, -1 },     // 2132
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 3132
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 4132
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, -1, -1 },     // 1232
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 2232
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 3232
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, -1, -1 },       // 4232
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, -1, -1 },      // 1332
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, -1, -1 },       // 2332
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, -1, -1 },       // 3332
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, -1, -1 },       // 4332
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, -1, -1 },       // 1432
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, -1, -1 },       // 2432
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, -1, -1 },       // 3432
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, -1, -1 },       // 4432
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1 },     // 1142
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, -1, -1 },      // 2142
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 3142
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 4142
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, -1, -1 },      // 1242
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 2242
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 3242
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, -1, -1 },       // 4242
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, -1, -1 },       // 1342
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, -1, -1 },       // 2342
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, -1, -1 },       // 3342
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, -1, -1 },       // 4342
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, -1 },       // 1442
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1, -1 },       // 2442
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1, -1 },       // 3442
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1, -1 },       // 4442
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1 },   // 1113
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, 6, -1 },    // 2113
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 3113
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 4113
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, 6, -1 },    // 1213
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 2213
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 3213
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, 9, -1 },       // 4213
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, 7, -1 },     // 1313
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, 8, -1 },      // 2313
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, 9, -1 },       // 3313
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, 10, -1 },       // 4313
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, 8, -1 },      // 1413
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, 9, -1 },       // 2413
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, 10, -1 },       // 3413
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, 11, -1 },       // 4413
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1 },    // 1123
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, 7, -1 },     // 2123
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 3123
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 4123
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, 7, -1 },     // 1223
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 2223
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 3223
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, 10, -1 },       // 4223
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, 8, -1 },      // 1323
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, 9, -1 },       // 2323
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, 10, -1 },       // 3323
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, 11, -1 },       // 4323
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, 9, -1 },       // 1423
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, 10, -1 },       // 2423
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, 11, -1 },       // 3423
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, 12, -1 },       // 4423
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1 },     // 1133
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, 8, -1 },      // 2133
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 3133
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 4133
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, 8, -1 },      // 1233
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 2233
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 3233
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, 11, -1 },       // 4233
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, 9, -1 },       // 1333
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, 10, -1 },       // 2333
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, 11, -1 },       // 3333
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, 12, -1 },       // 4333
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, 10, -1 },       // 1433
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, 11, -1 },       // 2433
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, 12, -1 },       // 3433
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, 13, -1 },       // 4433
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1 },      // 1143
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, 9, -1 },       // 2143
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 3143
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 4143
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, 9, -1 },       // 1243
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 2243
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 3243
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, 12, -1 },       // 4243
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, 10, -1 },       // 1343
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, 11, -1 },       // 2343
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, 12, -1 },       // 3343
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, 13, -1 },       // 4343
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, -1 },       // 1443
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, -1 },       // 2443
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 },       // 3443
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, -1 },       // 4443
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6 },    // 1114
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, -1, -1, -1, 4, 5, 6, 7 },     // 2114
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 3114
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 4114
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, -1, -1, -1, 4, 5, 6, 7 },     // 1214
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 2214
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 3214
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, -1, -1, -1, 7, 8, 9, 10 },       // 4214
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, -1, -1, -1, 5, 6, 7, 8 },      // 1314
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, -1, -1, -1, 6, 7, 8, 9 },       // 2314
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, -1, -1, -1, 7, 8, 9, 10 },       // 3314
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, -1, -1, -1, 8, 9, 10, 11 },       // 4314
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, -1, -1, -1, 6, 7, 8, 9 },       // 1414
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, -1, -1, -1, 7, 8, 9, 10 },       // 2414
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, -1, -1, -1, 8, 9, 10, 11 },       // 3414
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, 9, 10, 11, 12 },       // 4414
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7 },     // 1124
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, -1, -1, 5, 6, 7, 8 },      // 2124
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 3124
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 4124
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, -1, -1, 5, 6, 7, 8 },      // 1224
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 2224
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 3224
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, -1, -1, 8, 9, 10, 11 },       // 4224
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, -1, -1, 6, 7, 8, 9 },       // 1324
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, -1, -1, 7, 8, 9, 10 },       // 2324
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, -1, -1, 8, 9, 10, 11 },       // 3324
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, -1, -1, 9, 10, 11, 12 },       // 4324
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, -1, -1, 7, 8, 9, 10 },       // 1424
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, -1, -1, 8, 9, 10, 11 },       // 2424
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, -1, -1, 9, 10, 11, 12 },       // 3424
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, 10, 11, 12, 13 },       // 4424
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8 },      // 1134
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, -1, 6, 7, 8, 9 },       // 2134
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 3134
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 4134
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, -1, 6, 7, 8, 9 },       // 1234
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 2234
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 3234
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, -1, 9, 10, 11, 12 },       // 4234
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, -1, 7, 8, 9, 10 },       // 1334
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, -1, 8, 9, 10, 11 },       // 2334
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, -1, 9, 10, 11, 12 },       // 3334
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, -1, 10, 11, 12, 13 },       // 4334
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, -1, 8, 9, 10, 11 },       // 1434
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, -1, 9, 10, 11, 12 },       // 2434
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, -1, 10, 11, 12, 13 },       // 3434
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, -1, 11, 12, 13, 14 },       // 4434
-		{ 0, -1, -1, -1, 1, -1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9 },       // 1144
-		{ 0, 1, -1, -1, 2, -1, -1, -1, 3, 4, 5, 6, 7, 8, 9, 10 },       // 2144
-		{ 0, 1, 2, -1, 3, -1, -1, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 3144
-		{ 0, 1, 2, 3, 4, -1, -1, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 4144
-		{ 0, -1, -1, -1, 1, 2, -1, -1, 3, 4, 5, 6, 7, 8, 9, 10 },       // 1244
-		{ 0, 1, -1, -1, 2, 3, -1, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 2244
-		{ 0, 1, 2, -1, 3, 4, -1, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 3244
-		{ 0, 1, 2, 3, 4, 5, -1, -1, 6, 7, 8, 9, 10, 11, 12, 13 },       // 4244
-		{ 0, -1, -1, -1, 1, 2, 3, -1, 4, 5, 6, 7, 8, 9, 10, 11 },       // 1344
-		{ 0, 1, -1, -1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10, 11, 12 },       // 2344
-		{ 0, 1, 2, -1, 3, 4, 5, -1, 6, 7, 8, 9, 10, 11, 12, 13 },       // 3344
-		{ 0, 1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10, 11, 12, 13, 14 },       // 4344
-		{ 0, -1, -1, -1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 },       // 1444
-		{ 0, 1, -1, -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 },       // 2444
-		{ 0, 1, 2, -1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 },       // 3444
-		{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }        // 4444
-};
-
-static uint8_t _encode_data(uint32_t val, uint8_t *__restrict__ *dataPtrPtr) {
-	uint8_t *dataPtr = *dataPtrPtr;
-	uint8_t code;
-
-	if (val < (1 << 8)) { // 1 byte
-		*dataPtr = (uint8_t)(val);
-		*dataPtrPtr += 1;
-		code = 0;
-	} else if (val < (1 << 16)) { // 2 bytes
-		*(uint16_t *) dataPtr = (uint16_t)(val);
-		*dataPtrPtr += 2;
-		code = 1;
-	} else if (val < (1 << 24)) { // 3 bytes
-		*(uint16_t *) dataPtr = (uint16_t)(val);
-		*(dataPtr + 2) = (uint8_t)(val >> 16);
-		*dataPtrPtr += 3;
-		code = 2;
-	} else { // 4 bytes
-		*(uint32_t *) dataPtr = val;
-		*dataPtrPtr += 4;
-		code = 3;
-	}
-
-	return code;
-}
-
-static uint8_t *svb_encode_scalar_d1_init(const uint32_t *in,
-		uint8_t *__restrict__ keyPtr, uint8_t *__restrict__ dataPtr,
-		uint32_t count, uint32_t prev) {
-	if (count == 0)
-		return dataPtr; // exit immediately if no data
-
-	uint8_t shift = 0; // cycles 0, 2, 4, 6, 0, 2, 4, 6, ...
-	uint8_t key = 0;
-	for (uint32_t c = 0; c < count; c++) {
-		if (shift == 8) {
-			shift = 0;
-			*keyPtr++ = key;
-			key = 0;
-		}
-		uint32_t val = in[c] - prev;
-		prev = in[c];
-		uint8_t code = _encode_data(val, &dataPtr);
-		key |= code << shift;
-		shift += 2;
-	}
-
-	*keyPtr = key;  // write last key (no increment needed)
-	return dataPtr; // pointer to first unused data byte
-}
-
-size_t streamvbyte_delta_encode(const uint32_t *in, uint32_t count, uint8_t *out,
-		uint32_t prev) {
-	uint8_t *keyPtr = out;         // keys come immediately after 32-bit count
-	uint32_t keyLen = (count + 3) / 4; // 2-bits rounded to full byte
-	uint8_t *dataPtr = keyPtr + keyLen; // variable byte data after all keys
-
-	return svb_encode_scalar_d1_init(in, keyPtr, dataPtr, count, prev) - out;
-
-}
-
-static inline __m128i _decode_avx(uint32_t key, const uint8_t *__restrict__ *dataPtrPtr) {
-	uint8_t len = lengthTable[key];
-	__m128i Data = _mm_loadu_si128((__m128i *) *dataPtrPtr);
-	__m128i Shuf = *(__m128i *) &shuffleTable[key];
-
-	Data = _mm_shuffle_epi8(Data, Shuf);
-	*dataPtrPtr += len;
-
-	return Data;
-}
-#define BroadcastLastXMM 0xFF // bits 0-7 all set to choose highest element
-
-
-
-static inline void _write_avx(uint32_t *out, __m128i Vec) {
-	_mm_storeu_si128((__m128i *) out, Vec);
-}
-
-static __m128i _write_avx_d1(uint32_t *out, __m128i Vec, __m128i Prev) {
-	__m128i Add = _mm_slli_si128(Vec, 4); // Cycle 1: [- A B C] (already done)
-	Prev = _mm_shuffle_epi32(Prev, BroadcastLastXMM); // Cycle 2: [P P P P]
-	Vec = _mm_add_epi32(Vec, Add);                    // Cycle 2: [A AB BC CD]
-	Add = _mm_slli_si128(Vec, 8);                     // Cycle 3: [- - A AB]
-	Vec = _mm_add_epi32(Vec, Prev);                 // Cycle 3: [PA PAB PBC PCD]
-	Vec = _mm_add_epi32(Vec, Add); // Cycle 4: [PA PAB PABC PABCD]
-
-	_write_avx(out, Vec);
-	return Vec;
-}
-
-#ifndef _MSC_VER
-static __m128i High16To32 = {0xFFFF0B0AFFFF0908, 0xFFFF0F0EFFFF0D0C};
-#else
-static __m128i High16To32 = {8,  9,  -1, -1, 10, 11, -1, -1,
-                           12, 13, -1, -1, 14, 15, -1, -1};
-#endif
-
-static inline __m128i _write_16bit_avx_d1(uint32_t *out, __m128i Vec, __m128i Prev) {
-  // vec == [A B C D E F G H] (16 bit values)
-  __m128i Add = _mm_slli_si128(Vec, 2);               // [- A B C D E F G]
-  Prev = _mm_shuffle_epi32(Prev, BroadcastLastXMM); // [P P P P] (32-bit)
-  Vec = _mm_add_epi32(Vec, Add);                    // [A AB BC CD DE FG GH]
-  Add = _mm_slli_si128(Vec, 4);                     // [- - A AB BC CD DE EF]
-  Vec = _mm_add_epi32(Vec, Add);      // [A AB ABC ABCD BCDE CDEF DEFG EFGH]
-  __m128i V1 = _mm_cvtepu16_epi32(Vec); // [A AB ABC ABCD] (32-bit)
-  V1 = _mm_add_epi32(V1, Prev);       // [PA PAB PABC PABCD] (32-bit)
-  __m128i V2 =
-      _mm_shuffle_epi8(Vec, High16To32); // [BCDE CDEF DEFG EFGH] (32-bit)
-  V2 = _mm_add_epi32(V1, V2); // [PABCDE PABCDEF PABCDEFG PABCDEFGH] (32-bit)
-  _write_avx(out, V1);
-  _write_avx(out + 4, V2);
-  return V2;
-}
-
-static inline uint32_t _decode_data(const uint8_t **dataPtrPtr, uint8_t code) {
-	const uint8_t *dataPtr = *dataPtrPtr;
-	uint32_t val;
-
-	if (code == 0) { // 1 byte
-		val = (uint32_t) * dataPtr;
-		dataPtr += 1;
-	} else if (code == 1) { // 2 bytes
-		val = (uint32_t) * (uint16_t *) dataPtr;
-		dataPtr += 2;
-	} else if (code == 2) { // 3 bytes
-		val = (uint32_t) * (uint16_t *) dataPtr;
-		val |= *(dataPtr + 2) << 16;
-		dataPtr += 3;
-	} else {                      // code == 3
-		val = *(uint32_t *) dataPtr; // 4 bytes
-		dataPtr += 4;
-	}
-
-	*dataPtrPtr = dataPtr;
-	return val;
-}
-
-const uint8_t *svb_decode_scalar_d1_init(uint32_t *outPtr, const uint8_t *keyPtr,
-		const uint8_t *dataPtr, uint32_t count,
-                                   uint32_t prev) {
-  if (count == 0)
-    return dataPtr; // no reads or writes if no data
-
-  uint8_t shift = 0;
-  uint32_t key = *keyPtr++;
-
-  for (uint32_t c = 0; c < count; c++) {
-    if (shift == 8) {
-      shift = 0;
-      key = *keyPtr++;
-    }
-    uint32_t val = _decode_data(&dataPtr, (key >> shift) & 0x3);
-    val += prev;
-    *outPtr++ = val;
-    prev = val;
-    shift += 2;
-  }
-
-  return dataPtr; // pointer to first unused byte after end
-}
-
-const uint8_t *svb_decode_avx_d1_init(uint32_t *out, const uint8_t *__restrict__ keyPtr,
-		const uint8_t *__restrict__ dataPtr, uint64_t count, uint32_t prev) {
-	uint64_t keybytes = count / 4; // number of key bytes
-	if (keybytes >= 8) {
-		__m128i Prev = _mm_set1_epi32(prev);
-		__m128i Data;
-
-		int64_t Offset = -(int64_t) keybytes / 8 + 1;
-
-		const uint64_t *keyPtr64 = (const uint64_t *) keyPtr - Offset;
-		uint64_t nextkeys = keyPtr64[Offset];
-		for (; Offset != 0; ++Offset) {
-			uint64_t keys = nextkeys;
-			nextkeys = keyPtr64[Offset + 1];
-			// faster 16-bit delta since we only have 8-bit values
-			if (!keys) { // 32 1-byte ints in a row
-
-				Data = _mm_cvtepu8_epi16(_mm_lddqu_si128((__m128i *) (dataPtr)));
-				Prev = _write_16bit_avx_d1(out, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_lddqu_si128((__m128i *) (dataPtr + 8)));
-				Prev = _write_16bit_avx_d1(out + 8, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_lddqu_si128((__m128i *) (dataPtr + 16)));
-				Prev = _write_16bit_avx_d1(out + 16, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_lddqu_si128((__m128i *) (dataPtr + 24)));
-				Prev = _write_16bit_avx_d1(out + 24, Data, Prev);
-				out += 32;
-				dataPtr += 32;
-				continue;
-			}
-
-			Data = _decode_avx(keys & 0x00FF, &dataPtr);
-			Prev = _write_avx_d1(out, Data, Prev);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			Prev = _write_avx_d1(out + 4, Data, Prev);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0x00FF), &dataPtr);
-			Prev = _write_avx_d1(out + 8, Data, Prev);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			Prev = _write_avx_d1(out + 12, Data, Prev);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0x00FF), &dataPtr);
-			Prev = _write_avx_d1(out + 16, Data, Prev);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			Prev = _write_avx_d1(out + 20, Data, Prev);
-
-			keys >>= 16;
-			Data = _decode_avx((keys & 0x00FF), &dataPtr);
-			Prev = _write_avx_d1(out + 24, Data, Prev);
-			Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-			Prev = _write_avx_d1(out + 28, Data, Prev);
-
-			out += 32;
-		}
-		{
-			uint64_t keys = nextkeys;
-			// faster 16-bit delta since we only have 8-bit values
-			if (!keys) { // 32 1-byte ints in a row
-				Data = _mm_cvtepu8_epi16(_mm_lddqu_si128((__m128i *) (dataPtr)));
-				Prev = _write_16bit_avx_d1(out, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_lddqu_si128((__m128i *) (dataPtr + 8)));
-				Prev = _write_16bit_avx_d1(out + 8, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_lddqu_si128((__m128i *) (dataPtr + 16)));
-				Prev = _write_16bit_avx_d1(out + 16, Data, Prev);
-				Data = _mm_cvtepu8_epi16(
-						_mm_loadl_epi64((__m128i *) (dataPtr + 24)));
-				Prev = _write_16bit_avx_d1(out + 24, Data, Prev);
-				out += 32;
-				dataPtr += 32;
-
-			} else {
-
-				Data = _decode_avx(keys & 0x00FF, &dataPtr);
-				Prev = _write_avx_d1(out, Data, Prev);
-				Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-				Prev = _write_avx_d1(out + 4, Data, Prev);
-
-				keys >>= 16;
-				Data = _decode_avx((keys & 0x00FF), &dataPtr);
-				Prev = _write_avx_d1(out + 8, Data, Prev);
-				Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-				Prev = _write_avx_d1(out + 12, Data, Prev);
-
-				keys >>= 16;
-				Data = _decode_avx((keys & 0x00FF), &dataPtr);
-				Prev = _write_avx_d1(out + 16, Data, Prev);
-				Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-				Prev = _write_avx_d1(out + 20, Data, Prev);
-
-				keys >>= 16;
-				Data = _decode_avx((keys & 0x00FF), &dataPtr);
-				Prev = _write_avx_d1(out + 24, Data, Prev);
-				Data = _decode_avx((keys & 0xFF00) >> 8, &dataPtr);
-				Prev = _write_avx_d1(out + 28, Data, Prev);
-
-				out += 32;
-			}
-		}
-		prev = out[-1];
-	}
-	uint64_t consumedkeys = keybytes - (keybytes & 7);
-	return svb_decode_scalar_d1_init(out, keyPtr + consumedkeys, dataPtr,
-			count & 31, prev);
-}
-
-size_t streamvbyte_delta_decode(const uint8_t* in, uint32_t* out,
-		uint32_t count, uint32_t prev) {
-	uint32_t keyLen = ((count + 3) / 4); // 2-bits per key (rounded up)
-	const uint8_t *keyPtr = in;
-	const uint8_t *dataPtr = keyPtr + keyLen;  // data starts at end of keys
-	return svb_decode_avx_d1_init(out, keyPtr, dataPtr, count, prev) - in;
-}

cpp/streamvbyte/tests/unit.c

@@ -1,73 +0,0 @@
-#include <stdio.h>
-#include <stdlib.h>
-
-#include "streamvbyte.h"
-#include "streamvbytedelta.h"
-
-int main() {
-	int N = 4096;
-	uint32_t * datain = malloc(N * sizeof(uint32_t));
-	uint8_t * compressedbuffer = malloc(2 * N * sizeof(uint32_t));
-	uint32_t * recovdata = malloc(N * sizeof(uint32_t));
-
-	for (int length = 0; length <= N;) {
-		printf("length = %d \n", length);
-		for (uint32_t gap = 1; gap <= 387420489; gap *= 3) {
-			for (int k = 0; k < length; ++k)
-				datain[k] = gap;
-			size_t compsize = streamvbyte_encode(datain, length,
-					compressedbuffer);
-			size_t usedbytes = streamvbyte_decode(compressedbuffer, recovdata,
-					length);
-			if (compsize != usedbytes) {
-				printf(
-						"[streamvbyte_decode] code is buggy gap = %d, size mismatch %d %d \n",
-						(int) gap, (int) compsize, (int) usedbytes);
-				return -1;
-			}
-			for (int k = 0; k < length; ++k) {
-				if (recovdata[k] != datain[k]) {
-					printf("[streamvbyte_decode] code is buggy gap = %d\n",
-							(int) gap);
-					return -1;
-				}
-			}
-		}
-
-		printf("Delta \n");
-		for (size_t gap = 1; gap <= 531441; gap *= 3) {
-			for (int k = 0; k < length; ++k)
-				datain[k] = gap * k;
-			size_t compsize = streamvbyte_delta_encode(datain, length,
-					compressedbuffer, 0);
-			size_t usedbytes = streamvbyte_delta_decode(compressedbuffer,
-					recovdata, length, 0);
-			if (compsize != usedbytes) {
-				printf(
-						"[streamvbyte_delta_decode] code is buggy gap = %d, size mismatch %d %d \n",
-						(int) gap, (int) compsize, (int) usedbytes);
-				return -1;
-			}
-			for (int k = 0; k < length; ++k) {
-				if (recovdata[k] != datain[k]) {
-					printf(
-							"[streamvbyte_delta_decode] code is buggy gap = %d\n",
-							(int) gap);
-					return -1;
-				}
-			}
-
-		}
-
-		if (length < 128)
-			++length;
-		else {
-			length *= 2;
-		}
-	}
-	free(datain);
-	free(compressedbuffer);
-	free(recovdata);
-	printf("Code looks good.\n");
-	return 0;
-}

doc/.gitignore

@@ -0,0 +1 @@
+book

doc/book.toml

@@ -0,0 +1,5 @@
+[book]
+authors = ["Paul Masurel"]
+multilingual = false
+src = "src"
+title = "Tantivy, the user guide"

doc/src/SUMMARY.md

@@ -0,0 +1,15 @@
+# Summary
+
+
+
+[Avant Propos](./avant-propos.md)
+
+- [Segments](./basis.md)
+- [Defining your schema](./schema.md)
+- [Facetting](./facetting.md)
+- [Innerworkings](./innerworkings.md)
+  - [Inverted index](./inverted_index.md)
+- [Best practise](./inverted_index.md)
+
+[Frequently Asked Questions](./faq.md)
+[Examples](./examples.md)

doc/src/avant-propos.md

@@ -0,0 +1,34 @@
+# Foreword, what is the scope of tantivy?
+
+> Tantivy is a **search** engine **library** for Rust.
+
+If you are familiar with Lucene, it's an excellent approximation to consider tantivy as Lucene for rust. tantivy is heavily inspired by Lucene's design and
+they both have the same scope and targetted use cases.
+
+If you are not familiar with Lucene, let's break down our little tagline.
+
+- **Search** here means full-text search : fundamentally, tantivy is here to help you
+identify efficiently what are the documents matching a given query in your corpus.
+But modern search UI are so much more : text processing, facetting, autocomplete, fuzzy search, good
+relevancy, collapsing, highlighting, spatial search.
+
+  While some of these features are not available in tantivy yet, all of these are relevant
+  feature requests. Tantivy's objective is to offer a solid toolbox to create the best search
+  experience. But keep in mind this is just a toolbox.
+  Which bring us to the second keyword...
+
+- **Library** means that you will have to write code. tantivy is not an *all-in-one* server solution like elastic search for instance.
+
+  Sometimes a functionality will not be available in tantivy because it is too
+  specific to your use case. By design, tantivy should make it possible to extend
+  the available set of features using the existing rock-solid datastructures.
+
+  Most frequently this will mean writing your own `Collector`, your own `Scorer` or your own
+  `TokenFilter`... Some of your requirements may also be related to
+  something closer to architecture or operations. For instance, you may
+  want to build a large corpus on Hadoop, fine-tune the merge policy to keep your
+  index sharded in a time-wise fashion, or you may want to convert and existing
+  index from a different format.
+
+  Tantivy exposes a lot of low level API to do all of these things.
+  

doc/src/basis.md

@@ -0,0 +1,77 @@
+# Anatomy of an index
+
+## Straight from disk
+
+Tantivy accesses its data using an abstracting trait called `Directory`.
+In theory, one can come and override the data access logic. In practise, the
+trait somewhat assumes that your data can be mapped to memory, and tantivy
+seems deeply married to using `mmap` for its io [^1], and the only persisting
+directory shipped with tantivy is the `MmapDirectory`.
+
+While this design has some downsides, this greatly simplifies the source code of
+tantivy. Caching is also entirely delegated to the OS.
+
+`tantivy` works entirely (or almost) by directly reading the datastructures as they are layed on disk. As a result, the act of opening an indexing does not involve loading different datastructures from the disk into random access memory : starting a process, opening an index, and performing your first query can typically be done in a matter of milliseconds.
+
+This is an interesting property for a command line search engine, or for some multi-tenant log search engine : spawning a new process for each new query can be a perfectly sensible solution in some use case.
+
+In later chapters, we will discuss tantivy's inverted index data layout.
+One key take away is that to achieve great performance, search indexes are extremely compact.
+Of course this is crucial to reduce IO, and ensure that as much of our index can sit in RAM.
+
+Also, whenever possible its data is accessed sequentially. Of course, this is an amazing property when tantivy needs to access the data from your spinning hard disk, but this is also
+critical for performance, if your data is read from and an `SSD` or even already in your pagecache.
+
+
+## Segments, and the log method
+
+That kind of compact layout comes at one cost: it prevents our datastructures from being dynamic.
+In fact, the `Directory` trait does not even allow you to modify part of a file.
+
+To allow the addition / deletion of documents, and create the illusion that
+your index is dynamic (i.e.: adding and deleting documents), tantivy uses a common database trick sometimes referred to as the *log method*.
+
+Let's forget about deletes for a moment.
+
+As you add documents, these documents are processed and stored in a dedicated datastructure, in a `RAM` buffer. This datastructure is not ready for search, but it is useful to receive your data and rearrange it very rapidly.
+
+As you add documents, this buffer will reach its capacity and tantivy will transparently stop adding document to it and start converting this datastructure to its final read-only format on disk. Once written, an brand empty buffer is available to resume adding documents.
+
+The resulting chunk of index obtained after this serialization is called a `Segment`.
+
+> A segment is a self-contained atomic piece of index. It is identified with a UUID, and all of its files are identified using the naming scheme : `<UUID>.*`.
+
+Which brings us to the nature of a tantivy `Index`.
+
+> A tantivy `Index` is a collection of `Segments`.
+
+Physically, this really just means and index is a bunch of segment files in a given `Directory`,
+linked together by a `meta.json` file. This transparency can become extremely handy
+to get tantivy to fit your use case:
+
+*Example 1* You could for instance use hadoop to build a very large search index in a timely manner, copy all of the resulting segment files in the same directory and edit the `meta.json` to get a functional index.[^2]
+
+*Example 2* You could also disable your merge policy and enforce daily segments. Removing data after one week can then be done very efficiently by just editing the `meta.json` and deleting the files associated to segment `D-7`.
+
+
+
+
+
+# Merging
+
+As you index more and more data, your index will accumulate more and more segments.
+Having a lot of small segments is not really optimal. There is a bit of redundancy in having
+all these term dictionary. Also when searching, we will need to do term lookups as many times as we have segments.  It can hurt search performance a bit.
+
+That's where merging or compacting comes into place. Tantivy will continuously consider merge
+opportunities and start merging segments in the background.
+
+
+# Indexing throughput, number of indexing threads
+
+
+
+
+[^1]: This may eventually change.
+
+[^2]: Be careful however. By default these files will not be considered as *managed* by tantivy. This means they will never be garbage collected by tantivy, regardless of whether they become obsolete or not.

doc/src/examples.md

@@ -0,0 +1,3 @@
+# Examples
+
+- [Basic search](/examples/basic_search.html)

doc/src/facetting.md

@@ -0,0 +1,5 @@
+# Facetting
+
+wewew
+
+## weeewe

doc/src/innerworkings.md

@@ -0,0 +1 @@
+# Innerworkings

doc/src/inverted_index.md

@@ -0,0 +1 @@
+# Inverted index

doc/src/schema.md

@@ -0,0 +1 @@
+# Defining your schema

examples/basic_search.rs

@@ -0,0 +1,225 @@
+// # Basic Example
+//
+// This example covers the basic functionalities of
+// tantivy.
+//
+// We will :
+// - define our schema
+// - create an index in a directory
+// - index a few documents into our index
+// - search for the best document matching a basic query
+// - retrieve the best document's original content.
+
+// ---
+// Importing tantivy...
+use tantivy::collector::TopDocs;
+use tantivy::query::QueryParser;
+use tantivy::schema::*;
+use tantivy::{doc, Index, ReloadPolicy};
+use tempfile::TempDir;
+
+fn main() -> tantivy::Result<()> {
+    // Let's create a temporary directory for the
+    // sake of this example
+    let index_path = TempDir::new()?;
+
+    // # Defining the schema
+    //
+    // The Tantivy index requires a very strict schema.
+    // The schema declares which fields are in the index,
+    // and for each field, its type and "the way it should
+    // be indexed".
+
+    // First we need to define a schema ...
+    let mut schema_builder = Schema::builder();
+
+    // Our first field is title.
+    // We want full-text search for it, and we also want
+    // to be able to retrieve the document after the search.
+    //
+    // `TEXT | STORED` is some syntactic sugar to describe
+    // that.
+    //
+    // `TEXT` means the field should be tokenized and indexed,
+    // along with its term frequency and term positions.
+    //
+    // `STORED` means that the field will also be saved
+    // in a compressed, row-oriented key-value store.
+    // This store is useful for reconstructing the
+    // documents that were selected during the search phase.
+    schema_builder.add_text_field("title", TEXT | STORED);
+
+    // Our second field is body.
+    // We want full-text search for it, but we do not
+    // need to be able to be able to retrieve it
+    // for our application.
+    //
+    // We can make our index lighter by omitting the `STORED` flag.
+    schema_builder.add_text_field("body", TEXT);
+
+    let schema = schema_builder.build();
+
+    // # Indexing documents
+    //
+    // Let's create a brand new index.
+    //
+    // This will actually just save a meta.json
+    // with our schema in the directory.
+    let index = Index::create_in_dir(&index_path, schema.clone())?;
+
+    // To insert a document we will need an index writer.
+    // There must be only one writer at a time.
+    // This single `IndexWriter` is already
+    // multithreaded.
+    //
+    // Here we give tantivy a budget of `50MB`.
+    // Using a bigger heap for the indexer may increase
+    // throughput, but 50 MB is already plenty.
+    let mut index_writer = index.writer(50_000_000)?;
+
+    // Let's index our documents!
+    // We first need a handle on the title and the body field.
+
+    // ### Adding documents
+    //
+    // We can create a document manually, by setting the fields
+    // one by one in a Document object.
+    let title = schema.get_field("title").unwrap();
+    let body = schema.get_field("body").unwrap();
+
+    let mut old_man_doc = Document::default();
+    old_man_doc.add_text(title, "The Old Man and the Sea");
+    old_man_doc.add_text(
+        body,
+        "He was an old man who fished alone in a skiff in the Gulf Stream and \
+         he had gone eighty-four days now without taking a fish.",
+    );
+
+    // ... and add it to the `IndexWriter`.
+    index_writer.add_document(old_man_doc);
+
+    // For convenience, tantivy also comes with a macro to
+    // reduce the boilerplate above.
+    index_writer.add_document(doc!(
+    title => "Of Mice and Men",
+    body => "A few miles south of Soledad, the Salinas River drops in close to the hillside \
+            bank and runs deep and green. The water is warm too, for it has slipped twinkling \
+            over the yellow sands in the sunlight before reaching the narrow pool. On one \
+            side of the river the golden foothill slopes curve up to the strong and rocky \
+            Gabilan Mountains, but on the valley side the water is lined with trees—willows \
+            fresh and green with every spring, carrying in their lower leaf junctures the \
+            debris of the winter’s flooding; and sycamores with mottled, white, recumbent \
+            limbs and branches that arch over the pool"
+    ));
+
+    // Multivalued field just need to be repeated.
+    index_writer.add_document(doc!(
+    title => "Frankenstein",
+    title => "The Modern Prometheus",
+    body => "You will rejoice to hear that no disaster has accompanied the commencement of an \
+             enterprise which you have regarded with such evil forebodings.  I arrived here \
+             yesterday, and my first task is to assure my dear sister of my welfare and \
+             increasing confidence in the success of my undertaking."
+    ));
+
+    // This is an example, so we will only index 3 documents
+    // here. You can check out tantivy's tutorial to index
+    // the English wikipedia. Tantivy's indexing is rather fast.
+    // Indexing 5 million articles of the English wikipedia takes
+    // around 3 minutes on my computer!
+
+    // ### Committing
+    //
+    // At this point our documents are not searchable.
+    //
+    //
+    // We need to call `.commit()` explicitly to force the
+    // `index_writer` to finish processing the documents in the queue,
+    // flush the current index to the disk, and advertise
+    // the existence of new documents.
+    //
+    // This call is blocking.
+    index_writer.commit()?;
+
+    // If `.commit()` returns correctly, then all of the
+    // documents that have been added are guaranteed to be
+    // persistently indexed.
+    //
+    // In the scenario of a crash or a power failure,
+    // tantivy behaves as if it has rolled back to its last
+    // commit.
+
+    // # Searching
+    //
+    // ### Searcher
+    //
+    // A reader is required first in order to search an index.
+    // It acts as a `Searcher` pool that reloads itself,
+    // depending on a `ReloadPolicy`.
+    //
+    // For a search server you will typically create one reader for the entire lifetime of your
+    // program, and acquire a new searcher for every single request.
+    //
+    // In the code below, we rely on the 'ON_COMMIT' policy: the reader
+    // will reload the index automatically after each commit.
+    let reader = index
+        .reader_builder()
+        .reload_policy(ReloadPolicy::OnCommit)
+        .try_into()?;
+
+    // We now need to acquire a searcher.
+    //
+    // A searcher points to a snapshotted, immutable version of the index.
+    //
+    // Some search experience might require more than
+    // one query. Using the same searcher ensures that all of these queries will run on the
+    // same version of the index.
+    //
+    // Acquiring a `searcher` is very cheap.
+    //
+    // You should acquire a searcher every time you start processing a request and
+    // and release it right after your query is finished.
+    let searcher = reader.searcher();
+
+    // ### Query
+
+    // The query parser can interpret human queries.
+    // Here, if the user does not specify which
+    // field they want to search, tantivy will search
+    // in both title and body.
+    let query_parser = QueryParser::for_index(&index, vec![title, body]);
+
+    // `QueryParser` may fail if the query is not in the right
+    // format. For user facing applications, this can be a problem.
+    // A ticket has been opened regarding this problem.
+    let query = query_parser.parse_query("sea whale")?;
+
+    // A query defines a set of documents, as
+    // well as the way they should be scored.
+    //
+    // A query created by the query parser is scored according
+    // to a metric called Tf-Idf, and will consider
+    // any document matching at least one of our terms.
+
+    // ### Collectors
+    //
+    // We are not interested in all of the documents but
+    // only in the top 10. Keeping track of our top 10 best documents
+    // is the role of the `TopDocs` collector.
+
+    // We can now perform our query.
+    let top_docs = searcher.search(&query, &TopDocs::with_limit(10))?;
+
+    // The actual documents still need to be
+    // retrieved from Tantivy's store.
+    //
+    // Since the body field was not configured as stored,
+    // the document returned will only contain
+    // a title.
+    for (_score, doc_address) in top_docs {
+        let retrieved_doc = searcher.doc(doc_address)?;
+        println!("{}", schema.to_json(&retrieved_doc));
+    }
+
+    Ok(())
+}

examples/custom_collector.rs

@@ -0,0 +1,182 @@
+// # Custom collector example
+//
+// This example shows how you can implement your own
+// collector. As an example, we will compute a collector
+// that computes the standard deviation of a given fast field.
+//
+// Of course, you can have a look at the tantivy's built-in collectors
+// such as the `CountCollector` for more examples.
+
+// ---
+// Importing tantivy...
+use tantivy::collector::{Collector, SegmentCollector};
+use tantivy::fastfield::FastFieldReader;
+use tantivy::query::QueryParser;
+use tantivy::schema::Field;
+use tantivy::schema::{Schema, FAST, INDEXED, TEXT};
+use tantivy::{doc, Index, Score, SegmentReader};
+
+#[derive(Default)]
+struct Stats {
+    count: usize,
+    sum: f64,
+    squared_sum: f64,
+}
+
+impl Stats {
+    pub fn count(&self) -> usize {
+        self.count
+    }
+
+    pub fn mean(&self) -> f64 {
+        self.sum / (self.count as f64)
+    }
+
+    fn square_mean(&self) -> f64 {
+        self.squared_sum / (self.count as f64)
+    }
+
+    pub fn standard_deviation(&self) -> f64 {
+        let mean = self.mean();
+        (self.square_mean() - mean * mean).sqrt()
+    }
+
+    fn non_zero_count(self) -> Option<Stats> {
+        if self.count == 0 {
+            None
+        } else {
+            Some(self)
+        }
+    }
+}
+
+struct StatsCollector {
+    field: Field,
+}
+
+impl StatsCollector {
+    fn with_field(field: Field) -> StatsCollector {
+        StatsCollector { field }
+    }
+}
+
+impl Collector for StatsCollector {
+    // That's the type of our result.
+    // Our standard deviation will be a float.
+    type Fruit = Option<Stats>;
+
+    type Child = StatsSegmentCollector;
+
+    fn for_segment(
+        &self,
+        _segment_local_id: u32,
+        segment_reader: &SegmentReader,
+    ) -> tantivy::Result<StatsSegmentCollector> {
+        let fast_field_reader = segment_reader.fast_fields().u64(self.field)?;
+        Ok(StatsSegmentCollector {
+            fast_field_reader,
+            stats: Stats::default(),
+        })
+    }
+
+    fn requires_scoring(&self) -> bool {
+        // this collector does not care about score.
+        false
+    }
+
+    fn merge_fruits(&self, segment_stats: Vec<Option<Stats>>) -> tantivy::Result<Option<Stats>> {
+        let mut stats = Stats::default();
+        for segment_stats_opt in segment_stats {
+            if let Some(segment_stats) = segment_stats_opt {
+                stats.count += segment_stats.count;
+                stats.sum += segment_stats.sum;
+                stats.squared_sum += segment_stats.squared_sum;
+            }
+        }
+        Ok(stats.non_zero_count())
+    }
+}
+
+struct StatsSegmentCollector {
+    fast_field_reader: FastFieldReader<u64>,
+    stats: Stats,
+}
+
+impl SegmentCollector for StatsSegmentCollector {
+    type Fruit = Option<Stats>;
+
+    fn collect(&mut self, doc: u32, _score: Score) {
+        let value = self.fast_field_reader.get(doc) as f64;
+        self.stats.count += 1;
+        self.stats.sum += value;
+        self.stats.squared_sum += value * value;
+    }
+
+    fn harvest(self) -> <Self as SegmentCollector>::Fruit {
+        self.stats.non_zero_count()
+    }
+}
+
+fn main() -> tantivy::Result<()> {
+    // # Defining the schema
+    //
+    // The Tantivy index requires a very strict schema.
+    // The schema declares which fields are in the index,
+    // and for each field, its type and "the way it should
+    // be indexed".
+
+    // first we need to define a schema ...
+    let mut schema_builder = Schema::builder();
+
+    // We'll assume a fictional index containing
+    // products, and with a name, a description, and a price.
+    let product_name = schema_builder.add_text_field("name", TEXT);
+    let product_description = schema_builder.add_text_field("description", TEXT);
+    let price = schema_builder.add_u64_field("price", INDEXED | FAST);
+    let schema = schema_builder.build();
+
+    // # Indexing documents
+    //
+    // Lets index a bunch of fake documents for the sake of
+    // this example.
+    let index = Index::create_in_ram(schema.clone());
+
+    let mut index_writer = index.writer(50_000_000)?;
+    index_writer.add_document(doc!(
+        product_name => "Super Broom 2000",
+        product_description => "While it is ok for short distance travel, this broom \
+        was designed quiditch. It will up your game.",
+        price => 30_200u64
+    ));
+    index_writer.add_document(doc!(
+        product_name => "Turbulobroom",
+        product_description => "You might have heard of this broom before : it is the sponsor of the Wales team.\
+            You'll enjoy its sharp turns, and rapid acceleration",
+        price => 29_240u64
+    ));
+    index_writer.add_document(doc!(
+        product_name => "Broomio",
+        product_description => "Great value for the price. This broom is a market favorite",
+        price => 21_240u64
+    ));
+    index_writer.add_document(doc!(
+        product_name => "Whack a Mole",
+        product_description => "Prime quality bat.",
+        price => 5_200u64
+    ));
+    index_writer.commit()?;
+
+    let reader = index.reader()?;
+    let searcher = reader.searcher();
+    let query_parser = QueryParser::for_index(&index, vec![product_name, product_description]);
+
+    // here we want to get a hit on the 'ken' in Frankenstein
+    let query = query_parser.parse_query("broom")?;
+    if let Some(stats) = searcher.search(&query, &StatsCollector::with_field(price))? {
+        println!("count: {}", stats.count());
+        println!("mean: {}", stats.mean());
+        println!("standard deviation: {}", stats.standard_deviation());
+    }
+
+    Ok(())
+}

examples/custom_tokenizer.rs

@@ -0,0 +1,112 @@
+// # Defining a tokenizer pipeline
+//
+// In this example, we'll see how to define a tokenizer pipeline
+// by aligning a bunch of `TokenFilter`.
+use tantivy::collector::TopDocs;
+use tantivy::query::QueryParser;
+use tantivy::schema::*;
+use tantivy::tokenizer::NgramTokenizer;
+use tantivy::{doc, Index};
+
+fn main() -> tantivy::Result<()> {
+    // # Defining the schema
+    //
+    // The Tantivy index requires a very strict schema.
+    // The schema declares which fields are in the index,
+    // and for each field, its type and "the way it should
+    // be indexed".
+
+    // first we need to define a schema ...
+    let mut schema_builder = Schema::builder();
+
+    // Our first field is title.
+    // In this example we want to use NGram searching
+    // we will set that to 3 characters, so any three
+    // char in the title should be findable.
+    let text_field_indexing = TextFieldIndexing::default()
+        .set_tokenizer("ngram3")
+        .set_index_option(IndexRecordOption::WithFreqsAndPositions);
+    let text_options = TextOptions::default()
+        .set_indexing_options(text_field_indexing)
+        .set_stored();
+    let title = schema_builder.add_text_field("title", text_options);
+
+    // Our second field is body.
+    // We want full-text search for it, but we do not
+    // need to be able to be able to retrieve it
+    // for our application.
+    //
+    // We can make our index lighter and
+    // by omitting `STORED` flag.
+    let body = schema_builder.add_text_field("body", TEXT);
+
+    let schema = schema_builder.build();
+
+    // # Indexing documents
+    //
+    // Let's create a brand new index.
+    // To simplify we will work entirely in RAM.
+    // This is not what you want in reality, but it is very useful
+    // for your unit tests... Or this example.
+    let index = Index::create_in_ram(schema.clone());
+
+    // here we are registering our custome tokenizer
+    // this will store tokens of 3 characters each
+    index
+        .tokenizers()
+        .register("ngram3", NgramTokenizer::new(3, 3, false));
+
+    // To insert document we need an index writer.
+    // There must be only one writer at a time.
+    // This single `IndexWriter` is already
+    // multithreaded.
+    //
+    // Here we use a buffer of 50MB per thread. Using a bigger
+    // heap for the indexer can increase its throughput.
+    let mut index_writer = index.writer(50_000_000)?;
+    index_writer.add_document(doc!(
+    title => "The Old Man and the Sea",
+    body => "He was an old man who fished alone in a skiff in the Gulf Stream and \
+     he had gone eighty-four days now without taking a fish."
+    ));
+    index_writer.add_document(doc!(
+    title => "Of Mice and Men",
+       body => r#"A few miles south of Soledad, the Salinas River drops in close to the hillside
+                bank and runs deep and green. The water is warm too, for it has slipped twinkling
+                over the yellow sands in the sunlight before reaching the narrow pool. On one
+                side of the river the golden foothill slopes curve up to the strong and rocky
+                Gabilan Mountains, but on the valley side the water is lined with trees—willows
+                fresh and green with every spring, carrying in their lower leaf junctures the
+                debris of the winter’s flooding; and sycamores with mottled, white, recumbent
+                limbs and branches that arch over the pool"#
+    ));
+    index_writer.add_document(doc!(
+    title => "Frankenstein",
+        body => r#"You will rejoice to hear that no disaster has accompanied the commencement of an
+                enterprise which you have regarded with such evil forebodings.  I arrived here
+                yesterday, and my first task is to assure my dear sister of my welfare and
+                increasing confidence in the success of my undertaking."#
+    ));
+    index_writer.commit()?;
+
+    let reader = index.reader()?;
+    let searcher = reader.searcher();
+
+    // The query parser can interpret human queries.
+    // Here, if the user does not specify which
+    // field they want to search, tantivy will search
+    // in both title and body.
+    let query_parser = QueryParser::for_index(&index, vec![title, body]);
+
+    // here we want to get a hit on the 'ken' in Frankenstein
+    let query = query_parser.parse_query("ken")?;
+
+    let top_docs = searcher.search(&query, &TopDocs::with_limit(10))?;
+
+    for (_, doc_address) in top_docs {
+        let retrieved_doc = searcher.doc(doc_address)?;
+        println!("{}", schema.to_json(&retrieved_doc));
+    }
+
+    Ok(())
+}

examples/deleting_updating_documents.rs

@@ -0,0 +1,143 @@
+// # Deleting and Updating (?) documents
+//
+// This example explains how to delete and update documents.
+// In fact there is actually no such thing as an update in tantivy.
+//
+// To update a document, you need to delete a document and then reinsert
+// its new version.
+//
+// ---
+// Importing tantivy...
+use tantivy::collector::TopDocs;
+use tantivy::query::TermQuery;
+use tantivy::schema::*;
+use tantivy::{doc, Index, IndexReader};
+
+// A simple helper function to fetch a single document
+// given its id from our index.
+// It will be helpful to check our work.
+fn extract_doc_given_isbn(
+    reader: &IndexReader,
+    isbn_term: &Term,
+) -> tantivy::Result<Option<Document>> {
+    let searcher = reader.searcher();
+
+    // This is the simplest query you can think of.
+    // It matches all of the documents containing a specific term.
+    //
+    // The second argument is here to tell we don't care about decoding positions,
+    // or term frequencies.
+    let term_query = TermQuery::new(isbn_term.clone(), IndexRecordOption::Basic);
+    let top_docs = searcher.search(&term_query, &TopDocs::with_limit(1))?;
+
+    if let Some((_score, doc_address)) = top_docs.first() {
+        let doc = searcher.doc(*doc_address)?;
+        Ok(Some(doc))
+    } else {
+        // no doc matching this ID.
+        Ok(None)
+    }
+}
+
+fn main() -> tantivy::Result<()> {
+    // # Defining the schema
+    //
+    // Check out the *basic_search* example if this makes
+    // small sense to you.
+    let mut schema_builder = Schema::builder();
+
+    // Tantivy does not really have a notion of primary id.
+    // This may change in the future.
+    //
+    // Still, we can create a `isbn` field and use it as an id. This
+    // field can be `u64` or a `text`, depending on your use case.
+    // It just needs to be indexed.
+    //
+    // If it is `text`, let's make sure to keep it `raw` and let's avoid
+    // running any text processing on it.
+    // This is done by associating this field to the tokenizer named `raw`.
+    // Rather than building our [`TextOptions`](//docs.rs/tantivy/~0/tantivy/schema/struct.TextOptions.html) manually,
+    // We use the `STRING` shortcut. `STRING` stands for indexed (without term frequency or positions)
+    // and untokenized.
+    //
+    // Because we also want to be able to see this `id` in our returned documents,
+    // we also mark the field as stored.
+    let isbn = schema_builder.add_text_field("isbn", STRING | STORED);
+    let title = schema_builder.add_text_field("title", TEXT | STORED);
+    let schema = schema_builder.build();
+
+    let index = Index::create_in_ram(schema.clone());
+
+    let mut index_writer = index.writer(50_000_000)?;
+
+    // Let's add a couple of documents, for the sake of the example.
+    let mut old_man_doc = Document::default();
+    old_man_doc.add_text(title, "The Old Man and the Sea");
+    index_writer.add_document(doc!(
+        isbn => "978-0099908401",
+        title => "The old Man and the see"
+    ));
+    index_writer.add_document(doc!(
+        isbn => "978-0140177398",
+        title => "Of Mice and Men",
+    ));
+    index_writer.add_document(doc!(
+       title => "Frankentein", //< Oops there is a typo here.
+       isbn => "978-9176370711",
+    ));
+    index_writer.commit()?;
+    let reader = index.reader()?;
+
+    let frankenstein_isbn = Term::from_field_text(isbn, "978-9176370711");
+
+    // Oops our frankenstein doc seems mispelled
+    let frankenstein_doc_misspelled = extract_doc_given_isbn(&reader, &frankenstein_isbn)?.unwrap();
+    assert_eq!(
+        schema.to_json(&frankenstein_doc_misspelled),
+        r#"{"isbn":["978-9176370711"],"title":["Frankentein"]}"#,
+    );
+
+    // # Update = Delete + Insert
+    //
+    // Here we will want to update the typo in the `Frankenstein` book.
+    //
+    // Tantivy does not handle updates directly, we need to delete
+    // and reinsert the document.
+    //
+    // This can be complicated as it means you need to have access
+    // to the entire document. It is good practise to integrate tantivy
+    // with a key value store for this reason.
+    //
+    // To remove one of the document, we just call `delete_term`
+    // on its id.
+    //
+    // Note that `tantivy` does nothing to enforce the idea that
+    // there is only one document associated to this id.
+    //
+    // Also you might have noticed that we apply the delete before
+    // having committed. This does not matter really...
+    index_writer.delete_term(frankenstein_isbn.clone());
+
+    // We now need to reinsert our document without the typo.
+    index_writer.add_document(doc!(
+       title => "Frankenstein",
+       isbn => "978-9176370711",
+    ));
+
+    // You are guaranteed that your clients will only observe your index in
+    // the state it was in after a commit.
+    // In this example, your search engine will at no point be missing the *Frankenstein* document.
+    // Everything happened as if the document was updated.
+    index_writer.commit()?;
+    // We reload our searcher to make our change available to clients.
+    reader.reload()?;
+
+    // No more typo!
+    let frankenstein_new_doc = extract_doc_given_isbn(&reader, &frankenstein_isbn)?.unwrap();
+    assert_eq!(
+        schema.to_json(&frankenstein_new_doc),
+        r#"{"isbn":["978-9176370711"],"title":["Frankenstein"]}"#,
+    );
+
+    Ok(())
+}

examples/faceted_search.rs

@@ -0,0 +1,112 @@
+// # Basic Example
+//
+// This example covers the basic functionalities of
+// tantivy.
+//
+// We will :
+// - define our schema
+// = create an index in a directory
+// - index few documents in our index
+// - search for the best document matchings "sea whale"
+// - retrieve the best document original content.
+
+// ---
+// Importing tantivy...
+use tantivy::collector::FacetCollector;
+use tantivy::query::{AllQuery, TermQuery};
+use tantivy::schema::*;
+use tantivy::{doc, Index};
+
+fn main() -> tantivy::Result<()> {
+    // Let's create a temporary directory for the sake of this example
+    let mut schema_builder = Schema::builder();
+
+    let name = schema_builder.add_text_field("felin_name", TEXT | STORED);
+    // this is our faceted field: its scientific classification
+    let classification = schema_builder.add_facet_field("classification", INDEXED);
+
+    let schema = schema_builder.build();
+    let index = Index::create_in_ram(schema);
+
+    let mut index_writer = index.writer(30_000_000)?;
+
+    // For convenience, tantivy also comes with a macro to
+    // reduce the boilerplate above.
+    index_writer.add_document(doc!(
+        name => "Cat",
+        classification => Facet::from("/Felidae/Felinae/Felis")
+    ));
+    index_writer.add_document(doc!(
+        name => "Canada lynx",
+        classification => Facet::from("/Felidae/Felinae/Lynx")
+    ));
+    index_writer.add_document(doc!(
+        name => "Cheetah",
+        classification => Facet::from("/Felidae/Felinae/Acinonyx")
+    ));
+    index_writer.add_document(doc!(
+        name => "Tiger",
+        classification => Facet::from("/Felidae/Pantherinae/Panthera")
+    ));
+    index_writer.add_document(doc!(
+        name => "Lion",
+        classification => Facet::from("/Felidae/Pantherinae/Panthera")
+    ));
+    index_writer.add_document(doc!(
+        name => "Jaguar",
+        classification => Facet::from("/Felidae/Pantherinae/Panthera")
+    ));
+    index_writer.add_document(doc!(
+        name => "Sunda clouded leopard",
+        classification => Facet::from("/Felidae/Pantherinae/Neofelis")
+    ));
+    index_writer.add_document(doc!(
+        name => "Fossa",
+        classification => Facet::from("/Eupleridae/Cryptoprocta")
+    ));
+    index_writer.commit()?;
+
+    let reader = index.reader()?;
+    let searcher = reader.searcher();
+    {
+        let mut facet_collector = FacetCollector::for_field(classification);
+        facet_collector.add_facet("/Felidae");
+        let facet_counts = searcher.search(&AllQuery, &facet_collector)?;
+        // This lists all of the facet counts, right below "/Felidae".
+        let facets: Vec<(&Facet, u64)> = facet_counts.get("/Felidae").collect();
+        assert_eq!(
+            facets,
+            vec![
+                (&Facet::from("/Felidae/Felinae"), 3),
+                (&Facet::from("/Felidae/Pantherinae"), 4),
+            ]
+        );
+    }
+
+    // Facets are also searchable.
+    //
+    // For instance a common UI pattern is to allow the user someone to click on a facet link
+    // (e.g: `Pantherinae`) to drill down and filter the current result set with this subfacet.
+    //
+    // The search would then look as follows.
+
+    // Check the reference doc for different ways to create a `Facet` object.
+    {
+        let facet = Facet::from_text("/Felidae/Pantherinae");
+        let facet_term = Term::from_facet(classification, &facet);
+        let facet_term_query = TermQuery::new(facet_term, IndexRecordOption::Basic);
+        let mut facet_collector = FacetCollector::for_field(classification);
+        facet_collector.add_facet("/Felidae/Pantherinae");
+        let facet_counts = searcher.search(&facet_term_query, &facet_collector)?;
+        let facets: Vec<(&Facet, u64)> = facet_counts.get("/Felidae/Pantherinae").collect();
+        assert_eq!(
+            facets,
+            vec![
+                (&Facet::from("/Felidae/Pantherinae/Neofelis"), 1),
+                (&Facet::from("/Felidae/Pantherinae/Panthera"), 3),
+            ]
+        );
+    }
+
+    Ok(())
+}

examples/faceted_search_with_tweaked_score.rs

@@ -0,0 +1,98 @@
+use std::collections::HashSet;
+use tantivy::collector::TopDocs;
+use tantivy::doc;
+use tantivy::query::BooleanQuery;
+use tantivy::schema::*;
+use tantivy::{DocId, Index, Score, SegmentReader};
+
+fn main() -> tantivy::Result<()> {
+    let mut schema_builder = Schema::builder();
+
+    let title = schema_builder.add_text_field("title", STORED);
+    let ingredient = schema_builder.add_facet_field("ingredient", INDEXED);
+
+    let schema = schema_builder.build();
+    let index = Index::create_in_ram(schema.clone());
+
+    let mut index_writer = index.writer(30_000_000)?;
+
+    index_writer.add_document(doc!(
+        title => "Fried egg",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/oil"),
+    ));
+    index_writer.add_document(doc!(
+        title => "Scrambled egg",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/butter"),
+        ingredient => Facet::from("/ingredient/milk"),
+        ingredient => Facet::from("/ingredient/salt"),
+    ));
+    index_writer.add_document(doc!(
+        title => "Egg rolls",
+        ingredient => Facet::from("/ingredient/egg"),
+        ingredient => Facet::from("/ingredient/garlic"),
+        ingredient => Facet::from("/ingredient/salt"),
+        ingredient => Facet::from("/ingredient/oil"),
+        ingredient => Facet::from("/ingredient/tortilla-wrap"),
+        ingredient => Facet::from("/ingredient/mushroom"),
+    ));
+    index_writer.commit()?;
+
+    let reader = index.reader()?;
+    let searcher = reader.searcher();
+    {
+        let facets = vec![
+            Facet::from("/ingredient/egg"),
+            Facet::from("/ingredient/oil"),
+            Facet::from("/ingredient/garlic"),
+            Facet::from("/ingredient/mushroom"),
+        ];
+        let query = BooleanQuery::new_multiterms_query(
+            facets
+                .iter()
+                .map(|key| Term::from_facet(ingredient, &key))
+                .collect(),
+        );
+        let top_docs_by_custom_score =
+            TopDocs::with_limit(2).tweak_score(move |segment_reader: &SegmentReader| {
+                let ingredient_reader = segment_reader.facet_reader(ingredient).unwrap();
+                let facet_dict = ingredient_reader.facet_dict();
+
+                let query_ords: HashSet<u64> = facets
+                    .iter()
+                    .filter_map(|key| facet_dict.term_ord(key.encoded_str()).unwrap())
+                    .collect();
+
+                let mut facet_ords_buffer: Vec<u64> = Vec::with_capacity(20);
+
+                move |doc: DocId, original_score: Score| {
+                    ingredient_reader.facet_ords(doc, &mut facet_ords_buffer);
+                    let missing_ingredients = facet_ords_buffer
+                        .iter()
+                        .filter(|ord| !query_ords.contains(ord))
+                        .count();
+                    let tweak = 1.0 / 4_f32.powi(missing_ingredients as i32);
+
+                    original_score * tweak
+                }
+            });
+        let top_docs = searcher.search(&query, &top_docs_by_custom_score)?;
+
+        let titles: Vec<String> = top_docs
+            .iter()
+            .map(|(_, doc_id)| {
+                searcher
+                    .doc(*doc_id)
+                    .unwrap()
+                    .get_first(title)
+                    .unwrap()
+                    .text()
+                    .unwrap()
+                    .to_owned()
+            })
+            .collect();
+        assert_eq!(titles, vec!["Fried egg", "Egg rolls"]);
+    }
+    Ok(())
+}

examples/generate_html.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-docco simple_search.rs -o html

examples/html/docco.css

@@ -1,518 +0,0 @@
-/*--------------------- Typography ----------------------------*/
-
-@font-face {
-    font-family: 'aller-light';
-    src: url('public/fonts/aller-light.eot');
-    src: url('public/fonts/aller-light.eot?#iefix') format('embedded-opentype'),
-         url('public/fonts/aller-light.woff') format('woff'),
-         url('public/fonts/aller-light.ttf') format('truetype');
-    font-weight: normal;
-    font-style: normal;
-}
-
-@font-face {
-    font-family: 'aller-bold';
-    src: url('public/fonts/aller-bold.eot');
-    src: url('public/fonts/aller-bold.eot?#iefix') format('embedded-opentype'),
-         url('public/fonts/aller-bold.woff') format('woff'),
-         url('public/fonts/aller-bold.ttf') format('truetype');
-    font-weight: normal;
-    font-style: normal;
-}
-
-@font-face {
-    font-family: 'roboto-black';
-    src: url('public/fonts/roboto-black.eot');
-    src: url('public/fonts/roboto-black.eot?#iefix') format('embedded-opentype'),
-         url('public/fonts/roboto-black.woff') format('woff'),
-         url('public/fonts/roboto-black.ttf') format('truetype');
-    font-weight: normal;
-    font-style: normal;
-}
-
-/*--------------------- Layout ----------------------------*/
-html { height: 100%; }
-body {
-  font-family: "aller-light";
-  font-size: 14px;
-  line-height: 18px;
-  color: #30404f;
-  margin: 0; padding: 0;
-  height:100%;
-}
-#container { min-height: 100%; }
-
-a {
-  color: #000;
-}
-
-b, strong {
-  font-weight: normal;
-  font-family: "aller-bold";
-}
-
-p {
-  margin: 15px 0 0px;
-}
-  .annotation ul, .annotation ol {
-    margin: 25px 0;
-  }
-    .annotation ul li, .annotation ol li {
-      font-size: 14px;
-      line-height: 18px;
-      margin: 10px 0;
-    }
-
-h1, h2, h3, h4, h5, h6 {
-  color: #112233;
-  line-height: 1em;
-  font-weight: normal;
-  font-family: "roboto-black";
-  text-transform: uppercase;
-  margin: 30px 0 15px 0;
-}
-
-h1 {
-  margin-top: 40px;
-}
-h2 {
-  font-size: 1.26em;
-}
-
-hr {
-  border: 0;
-  background: 1px #ddd;
-  height: 1px;
-  margin: 20px 0;
-}
-
-pre, tt, code {
-  font-size: 12px; line-height: 16px;
-  font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace;
-  margin: 0; padding: 0;
-}
-  .annotation pre {
-    display: block;
-    margin: 0;
-    padding: 7px 10px;
-    background: #fcfcfc;
-    -moz-box-shadow:    inset 0 0 10px rgba(0,0,0,0.1);
-    -webkit-box-shadow: inset 0 0 10px rgba(0,0,0,0.1);
-    box-shadow:         inset 0 0 10px rgba(0,0,0,0.1);
-    overflow-x: auto;
-  }
-    .annotation pre code {
-      border: 0;
-      padding: 0;
-      background: transparent;
-    }
-
-
-blockquote {
-  border-left: 5px solid #ccc;
-  margin: 0;
-  padding: 1px 0 1px 1em;
-}
-  .sections blockquote p {
-    font-family: Menlo, Consolas, Monaco, monospace;
-    font-size: 12px; line-height: 16px;
-    color: #999;
-    margin: 10px 0 0;
-    white-space: pre-wrap;
-  }
-
-ul.sections {
-  list-style: none;
-  padding:0 0 5px 0;;
-  margin:0;
-}
-
-/*
-  Force border-box so that % widths fit the parent
-  container without overlap because of margin/padding.
-
-  More Info : http://www.quirksmode.org/css/box.html
-*/
-ul.sections > li > div {
-  -moz-box-sizing: border-box;    /* firefox */
-  -ms-box-sizing: border-box;     /* ie */
-  -webkit-box-sizing: border-box; /* webkit */
-  -khtml-box-sizing: border-box;  /* konqueror */
-  box-sizing: border-box;         /* css3 */
-}
-
-
-/*---------------------- Jump Page -----------------------------*/
-#jump_to, #jump_page {
-  margin: 0;
-  background: white;
-  -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
-  -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
-  font: 16px Arial;
-  cursor: pointer;
-  text-align: right;
-  list-style: none;
-}
-
-#jump_to a {
-  text-decoration: none;
-}
-
-#jump_to a.large {
-  display: none;
-}
-#jump_to a.small {
-  font-size: 22px;
-  font-weight: bold;
-  color: #676767;
-}
-
-#jump_to, #jump_wrapper {
-  position: fixed;
-  right: 0; top: 0;
-  padding: 10px 15px;
-  margin:0;
-}
-
-#jump_wrapper {
-  display: none;
-  padding:0;
-}
-
-#jump_to:hover #jump_wrapper {
-  display: block;
-}
-
-#jump_page_wrapper{
-  position: fixed;
-  right: 0;
-  top: 0;
-  bottom: 0;
-}
-
-#jump_page {
-  padding: 5px 0 3px;
-  margin: 0 0 25px 25px;
-  max-height: 100%;
-  overflow: auto;
-}
-
-#jump_page .source {
-  display: block;
-  padding: 15px;
-  text-decoration: none;
-  border-top: 1px solid #eee;
-}
-
-#jump_page .source:hover {
-  background: #f5f5ff;
-}
-
-#jump_page .source:first-child {
-}
-
-/*---------------------- Low resolutions (> 320px) ---------------------*/
-@media only screen and (min-width: 320px) {
-  .pilwrap { display: none; }
-
-  ul.sections > li > div {
-    display: block;
-    padding:5px 10px 0 10px;
-  }
-
-  ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol {
-    padding-left: 30px;
-  }
-
-  ul.sections > li > div.content {
-    overflow-x:auto;
-    -webkit-box-shadow: inset 0 0 5px #e5e5ee;
-    box-shadow: inset 0 0 5px #e5e5ee;
-    border: 1px solid #dedede;
-    margin:5px 10px 5px 10px;
-    padding-bottom: 5px;
-  }
-
-  ul.sections > li > div.annotation pre {
-    margin: 7px 0 7px;
-    padding-left: 15px;
-  }
-
-  ul.sections > li > div.annotation p tt, .annotation code {
-    background: #f8f8ff;
-    border: 1px solid #dedede;
-    font-size: 12px;
-    padding: 0 0.2em;
-  }
-}
-
-/*----------------------  (> 481px) ---------------------*/
-@media only screen and (min-width: 481px) {
-  #container {
-    position: relative;
-  }
-  body {
-    background-color: #F5F5FF;
-    font-size: 15px;
-    line-height: 21px;
-  }
-  pre, tt, code {
-    line-height: 18px;
-  }
-  p, ul, ol {
-    margin: 0 0 15px;
-  }
-
-
-  #jump_to {
-    padding: 5px 10px;
-  }
-  #jump_wrapper {
-    padding: 0;
-  }
-  #jump_to, #jump_page {
-    font: 10px Arial;
-    text-transform: uppercase;
-  }
-  #jump_page .source {
-    padding: 5px 10px;
-  }
-  #jump_to a.large {
-    display: inline-block;
-  }
-  #jump_to a.small {
-    display: none;
-  }
-
-
-
-  #background {
-    position: absolute;
-    top: 0; bottom: 0;
-    width: 350px;
-    background: #fff;
-    border-right: 1px solid #e5e5ee;
-    z-index: -1;
-  }
-
-  ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol {
-    padding-left: 40px;
-  }
-
-  ul.sections > li {
-    white-space: nowrap;
-  }
-
-  ul.sections > li > div {
-    display: inline-block;
-  }
-
-  ul.sections > li > div.annotation {
-    max-width: 350px;
-    min-width: 350px;
-    min-height: 5px;
-    padding: 13px;
-    overflow-x: hidden;
-    white-space: normal;
-    vertical-align: top;
-    text-align: left;
-  }
-  ul.sections > li > div.annotation pre {
-    margin: 15px 0 15px;
-    padding-left: 15px;
-  }
-
-  ul.sections > li > div.content {
-    padding: 13px;
-    vertical-align: top;
-    border: none;
-    -webkit-box-shadow: none;
-    box-shadow: none;
-  }
-
-  .pilwrap {
-    position: relative;
-    display: inline;
-  }
-
-  .pilcrow {
-    font: 12px Arial;
-    text-decoration: none;
-    color: #454545;
-    position: absolute;
-    top: 3px; left: -20px;
-    padding: 1px 2px;
-    opacity: 0;
-    -webkit-transition: opacity 0.2s linear;
-  }
-    .for-h1 .pilcrow {
-      top: 47px;
-    }
-    .for-h2 .pilcrow, .for-h3 .pilcrow, .for-h4 .pilcrow {
-      top: 35px;
-    }
-
-  ul.sections > li > div.annotation:hover .pilcrow {
-    opacity: 1;
-  }
-}
-
-/*---------------------- (> 1025px) ---------------------*/
-@media only screen and (min-width: 1025px) {
-
-  body {
-    font-size: 16px;
-    line-height: 24px;
-  }
-
-  #background {
-    width: 525px;
-  }
-  ul.sections > li > div.annotation {
-    max-width: 525px;
-    min-width: 525px;
-    padding: 10px 25px 1px 50px;
-  }
-  ul.sections > li > div.content {
-    padding: 9px 15px 16px 25px;
-  }
-}
-
-/*---------------------- Syntax Highlighting -----------------------------*/
-
-td.linenos { background-color: #f0f0f0; padding-right: 10px; }
-span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
-/*
-
-github.com style (c) Vasily Polovnyov <vast@whiteants.net>
-
-*/
-
-pre code {
-  display: block; padding: 0.5em;
-  color: #000;
-  background: #f8f8ff
-}
-
-pre .hljs-comment,
-pre .hljs-template_comment,
-pre .hljs-diff .hljs-header,
-pre .hljs-javadoc {
-  color: #408080;
-  font-style: italic
-}
-
-pre .hljs-keyword,
-pre .hljs-assignment,
-pre .hljs-literal,
-pre .hljs-css .hljs-rule .hljs-keyword,
-pre .hljs-winutils,
-pre .hljs-javascript .hljs-title,
-pre .hljs-lisp .hljs-title,
-pre .hljs-subst {
-  color: #954121;
-  /*font-weight: bold*/
-}
-
-pre .hljs-number,
-pre .hljs-hexcolor {
-  color: #40a070
-}
-
-pre .hljs-string,
-pre .hljs-tag .hljs-value,
-pre .hljs-phpdoc,
-pre .hljs-tex .hljs-formula {
-  color: #219161;
-}
-
-pre .hljs-title,
-pre .hljs-id {
-  color: #19469D;
-}
-pre .hljs-params {
-  color: #00F;
-}
-
-pre .hljs-javascript .hljs-title,
-pre .hljs-lisp .hljs-title,
-pre .hljs-subst {
-  font-weight: normal
-}
-
-pre .hljs-class .hljs-title,
-pre .hljs-haskell .hljs-label,
-pre .hljs-tex .hljs-command {
-  color: #458;
-  font-weight: bold
-}
-
-pre .hljs-tag,
-pre .hljs-tag .hljs-title,
-pre .hljs-rules .hljs-property,
-pre .hljs-django .hljs-tag .hljs-keyword {
-  color: #000080;
-  font-weight: normal
-}
-
-pre .hljs-attribute,
-pre .hljs-variable,
-pre .hljs-instancevar,
-pre .hljs-lisp .hljs-body {
-  color: #008080
-}
-
-pre .hljs-regexp {
-  color: #B68
-}
-
-pre .hljs-class {
-  color: #458;
-  font-weight: bold
-}
-
-pre .hljs-symbol,
-pre .hljs-ruby .hljs-symbol .hljs-string,
-pre .hljs-ruby .hljs-symbol .hljs-keyword,
-pre .hljs-ruby .hljs-symbol .hljs-keymethods,
-pre .hljs-lisp .hljs-keyword,
-pre .hljs-tex .hljs-special,
-pre .hljs-input_number {
-  color: #990073
-}
-
-pre .hljs-builtin,
-pre .hljs-constructor,
-pre .hljs-built_in,
-pre .hljs-lisp .hljs-title {
-  color: #0086b3
-}
-
-pre .hljs-preprocessor,
-pre .hljs-pi,
-pre .hljs-doctype,
-pre .hljs-shebang,
-pre .hljs-cdata {
-  color: #999;
-  font-weight: bold
-}
-
-pre .hljs-deletion {
-  background: #fdd
-}
-
-pre .hljs-addition {
-  background: #dfd
-}
-
-pre .hljs-diff .hljs-change {
-  background: #0086b3
-}
-
-pre .hljs-chunk {
-  color: #aaa
-}
-
-pre .hljs-tex .hljs-formula {
-  opacity: 0.5;
-}

examples/html/public/stylesheets/normalize.css

@@ -1,375 +0,0 @@
-/*! normalize.css v2.0.1 | MIT License | git.io/normalize */
-
-/* ==========================================================================
-   HTML5 display definitions
-   ========================================================================== */
-
-/*
- * Corrects `block` display not defined in IE 8/9.
- */
-
-article,
-aside,
-details,
-figcaption,
-figure,
-footer,
-header,
-hgroup,
-nav,
-section,
-summary {
-    display: block;
-}
-
-/*
- * Corrects `inline-block` display not defined in IE 8/9.
- */
-
-audio,
-canvas,
-video {
-    display: inline-block;
-}
-
-/*
- * Prevents modern browsers from displaying `audio` without controls.
- * Remove excess height in iOS 5 devices.
- */
-
-audio:not([controls]) {
-    display: none;
-    height: 0;
-}
-
-/*
- * Addresses styling for `hidden` attribute not present in IE 8/9.
- */
-
-[hidden] {
-    display: none;
-}
-
-/* ==========================================================================
-   Base
-   ========================================================================== */
-
-/*
- * 1. Sets default font family to sans-serif.
- * 2. Prevents iOS text size adjust after orientation change, without disabling
- *    user zoom.
- */
-
-html {
-    font-family: sans-serif; /* 1 */
-    -webkit-text-size-adjust: 100%; /* 2 */
-    -ms-text-size-adjust: 100%; /* 2 */
-}
-
-/*
- * Removes default margin.
- */
-
-body {
-    margin: 0;
-}
-
-/* ==========================================================================
-   Links
-   ========================================================================== */
-
-/*
- * Addresses `outline` inconsistency between Chrome and other browsers.
- */
-
-a:focus {
-    outline: thin dotted;
-}
-
-/*
- * Improves readability when focused and also mouse hovered in all browsers.
- */
-
-a:active,
-a:hover {
-    outline: 0;
-}
-
-/* ==========================================================================
-   Typography
-   ========================================================================== */
-
-/*
- * Addresses `h1` font sizes within `section` and `article` in Firefox 4+,
- * Safari 5, and Chrome.
- */
-
-h1 {
-    font-size: 2em;
-}
-
-/*
- * Addresses styling not present in IE 8/9, Safari 5, and Chrome.
- */
-
-abbr[title] {
-    border-bottom: 1px dotted;
-}
-
-/*
- * Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
- */
-
-b,
-strong {
-    font-weight: bold;
-}
-
-/*
- * Addresses styling not present in Safari 5 and Chrome.
- */
-
-dfn {
-    font-style: italic;
-}
-
-/*
- * Addresses styling not present in IE 8/9.
- */
-
-mark {
-    background: #ff0;
-    color: #000;
-}
-
-
-/*
- * Corrects font family set oddly in Safari 5 and Chrome.
- */
-
-code,
-kbd,
-pre,
-samp {
-    font-family: monospace, serif;
-    font-size: 1em;
-}
-
-/*
- * Improves readability of pre-formatted text in all browsers.
- */
-
-pre {
-    white-space: pre;
-    white-space: pre-wrap;
-    word-wrap: break-word;
-}
-
-/*
- * Sets consistent quote types.
- */
-
-q {
-    quotes: "\201C" "\201D" "\2018" "\2019";
-}
-
-/*
- * Addresses inconsistent and variable font size in all browsers.
- */
-
-small {
-    font-size: 80%;
-}
-
-/*
- * Prevents `sub` and `sup` affecting `line-height` in all browsers.
- */
-
-sub,
-sup {
-    font-size: 75%;
-    line-height: 0;
-    position: relative;
-    vertical-align: baseline;
-}
-
-sup {
-    top: -0.5em;
-}
-
-sub {
-    bottom: -0.25em;
-}
-
-/* ==========================================================================
-   Embedded content
-   ========================================================================== */
-
-/*
- * Removes border when inside `a` element in IE 8/9.
- */
-
-img {
-    border: 0;
-}
-
-/*
- * Corrects overflow displayed oddly in IE 9.
- */
-
-svg:not(:root) {
-    overflow: hidden;
-}
-
-/* ==========================================================================
-   Figures
-   ========================================================================== */
-
-/*
- * Addresses margin not present in IE 8/9 and Safari 5.
- */
-
-figure {
-    margin: 0;
-}
-
-/* ==========================================================================
-   Forms
-   ========================================================================== */
-
-/*
- * Define consistent border, margin, and padding.
- */
-
-fieldset {
-    border: 1px solid #c0c0c0;
-    margin: 0 2px;
-    padding: 0.35em 0.625em 0.75em;
-}
-
-/*
- * 1. Corrects color not being inherited in IE 8/9.
- * 2. Remove padding so people aren't caught out if they zero out fieldsets.
- */
-
-legend {
-    border: 0; /* 1 */
-    padding: 0; /* 2 */
-}
-
-/*
- * 1. Corrects font family not being inherited in all browsers.
- * 2. Corrects font size not being inherited in all browsers.
- * 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome
- */
-
-button,
-input,
-select,
-textarea {
-    font-family: inherit; /* 1 */
-    font-size: 100%; /* 2 */
-    margin: 0; /* 3 */
-}
-
-/*
- * Addresses Firefox 4+ setting `line-height` on `input` using `!important` in
- * the UA stylesheet.
- */
-
-button,
-input {
-    line-height: normal;
-}
-
-/*
- * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
- *    and `video` controls.
- * 2. Corrects inability to style clickable `input` types in iOS.
- * 3. Improves usability and consistency of cursor style between image-type
- *    `input` and others.
- */
-
-button,
-html input[type="button"], /* 1 */
-input[type="reset"],
-input[type="submit"] {
-    -webkit-appearance: button; /* 2 */
-    cursor: pointer; /* 3 */
-}
-
-/*
- * Re-set default cursor for disabled elements.
- */
-
-button[disabled],
-input[disabled] {
-    cursor: default;
-}
-
-/*
- * 1. Addresses box sizing set to `content-box` in IE 8/9.
- * 2. Removes excess padding in IE 8/9.
- */
-
-input[type="checkbox"],
-input[type="radio"] {
-    box-sizing: border-box; /* 1 */
-    padding: 0; /* 2 */
-}
-
-/*
- * 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome.
- * 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome
- *    (include `-moz` to future-proof).
- */
-
-input[type="search"] {
-    -webkit-appearance: textfield; /* 1 */
-    -moz-box-sizing: content-box;
-    -webkit-box-sizing: content-box; /* 2 */
-    box-sizing: content-box;
-}
-
-/*
- * Removes inner padding and search cancel button in Safari 5 and Chrome
- * on OS X.
- */
-
-input[type="search"]::-webkit-search-cancel-button,
-input[type="search"]::-webkit-search-decoration {
-    -webkit-appearance: none;
-}
-
-/*
- * Removes inner padding and border in Firefox 4+.
- */
-
-button::-moz-focus-inner,
-input::-moz-focus-inner {
-    border: 0;
-    padding: 0;
-}
-
-/*
- * 1. Removes default vertical scrollbar in IE 8/9.
- * 2. Improves readability and alignment in all browsers.
- */
-
-textarea {
-    overflow: auto; /* 1 */
-    vertical-align: top; /* 2 */
-}
-
-/* ==========================================================================
-   Tables
-   ========================================================================== */
-
-/*
- * Remove most spacing between table cells.
- */
-
-table {
-    border-collapse: collapse;
-    border-spacing: 0;
-}