Initial commit

LICENSE

@@ -0,0 +1,191 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+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
+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.

README.md

@@ -1,4 +1,69 @@
 SIMDCompressionAndIntersection
-==============================
+======================
 
-A C++ library to compress and intersect sorted lists of integers using SIMD instructions 
+As the name suggests, this is a C/C++ library for fast
+compression and intersection of lists of sorted integers using
+SIMD instructions. The library focuses on innovative techniques
+and very fast schemes, with particular attention to differential
+coding. It introduces new SIMD intersections schemes such as
+SIMD Galloping.
+
+Authors: Leonid Boystov, Nathan Kurz and Daniel Lemire
+With some contributions from Owen Kaser and others.
+
+Simple demo
+------------------------
+
+Check out example.cpp
+
+You can run it like so:
+
+make example
+./example
+
+Usage
+------------------------
+
+make
+./unit
+
+To run tests, you can do 
+
+./testcodecs
+
+(follow the instructions)
+
+
+
+Comparison with the FastPFOR C++ library
+-----------------------------------------
+
+The FastPFOR C++ Library available at https://github.com/lemire/FastPFor
+implements some of the same compression schemes except that
+it is not optimized for the compression of sorted lists of integers.
+
+
+Licensing
+------------------------
+
+Apache License, Version 2.0
+
+As far as the authors know, this work is patent-free.
+
+Requirements
+------------------------
+
+A recent GCC (4.7 or better), Clang or Intel compiler.
+
+A processor support AVX (Intel or AMD).
+
+Tested on Linux and MacOS. It should be portable to Windows and other platforms.
+
+
+
+
+For advanced benchmarking, please see
+
+advancedbenchmarking/README.md
+
+where there is additional information.

advancedbenchmarking/README.md

@@ -0,0 +1,74 @@
+Advanced benchmarking
+=====================
+
+
+The goal of this subdirectory is to provide some utilities that are 
+useful for "advanced benchmarking".
+
+
+* simplesynth is a utility that generates a file containing randomly generated arrays.
+* compress is a utility that takes a file containing uncompressed (regular) arrays and generates compressed arrays. 
+* uncompress is a utility that takes a file containing compressed arrays and generates uncompressed arrays.
+* budgetedtest intersect is a program to benchmark decompression speed together with fast intersections
+* entropy can be used to compute the entropy of the deltas given a set of (uncompressed) posting lists
+
+Sample usage
+-------------
+
+go to root directory in the project
+$ make compress uncompress simplesynth
+$ ./simplesynth -m 100 -N 10000 -R 20 test.bin
+$ ./compress -s varint test.bin ctest.bin
+$ ./uncompress ctest.bin recovered.bin
+
+
+Working with intersections
+--------------------------
+
+First, you must get the clueweb09 dataset (or a similar data set). You can get
+the clueweb09 data we use from http://boytsov.info/datasets/clueweb09gap/
+
+You need a posting list file in a flat format: a sequence of arrays stored as a 32-bit unsigned integer
+indicating length followed by a corresponding sequence of 32-bit unsigned integers.
+
+You can quickly generate a test file from a synthetic model:
+
+./simplesynth  -N 100000 -m 100 test.bin
+
+You can construct such a data file from the clueweb09 dataset made available by Leonid
+Boystov (http://boytsov.info/datasets/clueweb09gap/). For Nathan and Leo, this 
+is available on the test machine at /home/data/clueweb/Uncompressed/flat.bin (October 2013).
+
+You also need a query log file. It needs to be a text file where each row contains
+a sequence of integers (separated by white space). Each row corresponds to a query: each
+integer is a the index of the corresponding posting list. For example, the row "0 1 2" corresponds
+to the first 3 posting lists. Leonid Boytsov prepared such a query log from the infamous
+AOL web query log file, matching the clueweb09 data set. (By convention, the number "1000000"
+corresponds to an "unknown" posting list because there are 1000000 different terms in the
+clueweb09 data set that Leo indexed: a more general convention is that an out-of-range
+index can be ignored.) For Nathan and Leo, these files
+are available under /home/data/AOL/ in the test machine (October 2013).
+
+If you want, you can just make one up by creating a text file and entering, on each line, a series of distinct integers (say between 0 and 100) separated by spaces.
+
+You can run a test as follows: 
+
+./budgetedtest /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id 
+ -i simd -b 24  -s varint 
+-s specify the compression scheme (if none: default  on uncompressed)
+-b is is the memory budget in gigabytes. 
+-i allows you to specify an intersection routine  (default on a fast SIMD-based intersection routine).
+-o is to include one-word queries (they don't participate in intersections, only in decoding)
+-q allows you to specify that you just want the final report (warning:  the program can take a long time to complete)
+-l allows you to limit the number of queries (e.g., -l 1000)
+-p allows you to partition the postings during compression and decompression (param: number of partitions)
+-k   to test Skipping (must provide a gap size param between 1 and 31)
+-B   to activate bitmap mode (recommended values are in the range 8 to  32), when set to 0 in conjunction with compression, it means 'automatic'
+-d   to dump complete statistics
+
+
+Similarly, if you want the corresponding entropy, you can run
+
+./entropy  /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id
+
+It has similar flags as budgetedtest.

advancedbenchmarking/extra/scriptbudget.sh

@@ -0,0 +1,14 @@
+
+for inter in simd galloping scalar; do
+echo "%%%% Trying out uncompressed first" $inter
+./budgetedtest /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id -i $inter -q -b 12 -l 5000 
+for scheme in bp copy ibp ironpeter kurzbp simdbp2 simdbp4 simdbpm simdbpr simdfastpfor2 simdfastpfor4 simdfastpform simdfastpforr simdibp2 simdibp4 simdibpm simdibpr simdifastpfor2 simdifastpfor4 simdifastpform simdifastpforr simdvarintgb4 simdvarintgbr simdvarintgbr2 simdvarintgbrm varintgbr varintr; do
+echo "######## testing" $inter $scheme
+./budgetedtest /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id -i $inter -s $scheme -q -b 12 -l 5000
+for p in 8 16 32; do
+echo "##### number of partitions = " $p
+./budgetedtest /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id -i $inter -s $scheme -q -b 12 -l 5000 -p $p
+echo
+done
+done
+done

advancedbenchmarking/extra/scriptbudget_bitmap.sh

@@ -0,0 +1,13 @@
+make entropy budgetedtest
+./entropy /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id -b 12 -l 1000
+for inter in simd galloping; do
+for scheme in kurzbp  simdfastpforr fastpfor varintr ; do
+echo "######## testing" $inter $scheme
+for B in  8 32 ; do
+echo "# B = " $B
+./budgetedtest /home/data/clueweb/Uncompressed/flat.bin /home/data/AOL/user-ct-test-collection-01.id -i $inter -s $scheme -q -b 12 -l 1000 -B $B
+echo
+done
+done
+done
+./email.sh