Reorganize the directory structure

AUTHORS

@@ -0,0 +1,2 @@
+Juha Karkkainen <juha.karkkainen (at) cs.helsinki.fi>
+Dominik Kempa (contact person) <dominik.kempa (at) gmail.com>

LICENCE

@@ -0,0 +1,20 @@
+Copyright 2015-2021 Dominik Kempa, Juha Karkkainen
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,65 @@
+Faster-Minuter index
+====================
+
+
+Description
+-----------
+
+This repository contains the implementation of a wavelet tree data
+structure using the fixed block boosting (FBB) technique. The result
+of plugging this wavelet tree into an FM-index is called the Faster
+Minuter index.
+
+For the description of the new wavelet tree, the Faster Minuter
+index, and reports of experimental evaluation, refer to the following
+paper.
+
+    @article{fasterminuter,
+      author    = {Simon Gog and Juha K{\"{a}}rkk{\"{a}}inen and
+                   Dominik Kempa and Matthias Petri and Simon J. Puglisi},
+      title     = {Fixed Block Compression Boosting in FM-Indexes:
+                   Theory and Practice},
+      journal   = {Algorithmica},
+      volume    = {81},
+      number    = {4},
+      pages     = {1370--1391},
+      year      = {2019},
+      doi       = {10.1007/s00453-018-0475-9},
+    }
+
+The latest version of the wavelet tree based on FBB is available from
+https://github.com/dominikkempa/faster-minuter.
+
+
+
+Usage
+-----
+
+The wavelet tree is implemented as a C++ class wt_fbb. The class is
+compatible with the sdsl library (https://github.com/simongog/sdsl-lite).
+The current version has been tested on Linux/PC.
+
+The class comes with default parameters chosen for good overall
+performance and in nearly all practical scenarios should be used as
+is. The key customization of the class is in plugging in different
+bitvector implementations. The default is the hybrid bitvector, but
+faster (and larger) alternatives are available in the sdsl library.
+Refer to the paper above for details and experimental comparisons.
+
+
+
+Terms of use
+------------
+
+wt_fbb is released under the MIT/X11 license. See the file LICENCE for
+more details. If you use this code, please cite the paper mentioned
+above.
+
+
+
+Authors
+-------
+
+wt_fbb was implemented by:
+- [Dominik Kempa](https://scholar.google.com/citations?user=r0Kn9IUAAAAJ)
+- [Juha Karkkainen](https://scholar.google.com/citations?user=oZepo1cAAAAJ)

release/wt-fbb-0.1.0/wt_fbb.hpp → include/wt_fbb.hpp

@@ -2,7 +2,10 @@
  * @file    wt_fbb.cpp
  * @section LICENCE
  *
- * Copyright (C) 2015-2019
+ * This file is part of the "Faster Minuter" index v0.1.0
+ * See: https://github.com/dominikkempa/faster-minuter
+ *
+ * Copyright (C) 2015-2021
  *   Juha Karkkainen <juha.karkkainen (at) cs.helsinki.fi>
  *   Dominik Kempa <dominik.kempa (at) gmail.com>
  *
@@ -56,11 +59,16 @@
  *
  *  @ingroup wt
  *
- * \par Reference:
+ *  \par References:
  *     [1] Simon Gog, Juha Karkkainen, Dominik Kempa,
-           Matthias Petri, Simon J. Puglisi:
+ *         Matthias Petri, Simon J. Puglisi:
  *         Faster, Minuter.
  *         DCC 2016: 53-62
+ *     [2] Simon Gog, Juha Kärkkäinen, Dominik Kempa,
+ *         Matthias Petri, Simon J. Puglisi:
+ *         Fixed Block Compression Boosting in FM-Indexes: Theory
+ *         and Practice.
+ *         Algorithmica 81(4): 1370-1391 (2019)
  */
 template<class t_bitvector       = sdsl::hyb_vector<>,
          class t_rank            = typename t_bitvector::rank_1_type,