folly/experimental/Select64.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_EXPERIMENTAL_SELECT64_H
  18 #define FOLLY_EXPERIMENTAL_SELECT64_H
  19
  20 #include <glog/logging.h>
  21
  22 namespace folly {
  23
  24 namespace detail {
  25 extern const uint8_t kSelectInByte[2048];
  26 }
  27
  28 /**
  29  * Returns the position of the k-th 1 in the 64-bit word x.
  30  * k is 0-based, so k=0 returns the position of the first 1.
  31  *
  32  * Uses the broadword selection algorithm by Vigna [1], improved by Gog
  33  * and Petri [2] and Vigna [3].
  34  *
  35  * [1] Sebastiano Vigna. Broadword Implementation of Rank/Select
  36  *     Queries. WEA, 2008
  37  *
  38  * [2] Simon Gog, Matthias Petri. Optimized succinct data structures
  39  *     for massive data. Softw. Pract. Exper., 2014
  40  *
  41  * [3] Sebastiano Vigna. MG4J 5.2.1. http://mg4j.di.unimi.it/
  42 */
  43 template <class Instructions>
  44 inline uint64_t select64(uint64_t x, uint64_t k) {
  45   DCHECK_LT(k, Instructions::popcount(x));
  46
  47   constexpr uint64_t kOnesStep4  = 0x1111111111111111ULL;
  48   constexpr uint64_t kOnesStep8  = 0x0101010101010101ULL;
  49   constexpr uint64_t kMSBsStep8  = 0x80ULL * kOnesStep8;
  50
  51   auto s = x;
  52   s = s - ((s & 0xA * kOnesStep4) >> 1);
  53   s = (s & 0x3 * kOnesStep4) + ((s >> 2) & 0x3 * kOnesStep4);
  54   s = (s + (s >> 4)) & 0xF * kOnesStep8;
  55   uint64_t byteSums = s * kOnesStep8;
  56
  57   uint64_t kStep8 = k * kOnesStep8;
  58   uint64_t geqKStep8 = (((kStep8 | kMSBsStep8) - byteSums) & kMSBsStep8);
  59   uint64_t place = Instructions::popcount(geqKStep8) * 8;
  60   uint64_t byteRank = k - (((byteSums << 8) >> place) & uint64_t(0xFF));
  61   return place + detail::kSelectInByte[((x >> place) & 0xFF) | (byteRank << 8)];
  62 }
  63
  64 }
  65 #endif