bin64.h

   1 #ifndef BIN64_H
   2 #define BIN64_H
   3 #include <assert.h>
   4 #ifdef _MSC_VER
   5     #include "compat/stdint.h"
   6 #else
   7     #include <stdint.h>
   8 #endif
   9
  10
  11 /** Numbering for (aligned) logarithmical bins.
  12     Each number stands for an interval
  13     [o*2^l,(o+1)*2^l), where l is the layer and o
  14     is the offset.
  15     Bin numbers in the tail111 encoding: meaningless
  16     bits in the tail are set to 0111...11, while the
  17     head denotes the offset. Thus, 1101 is the bin
  18     at layer 1, offset 3 (i.e. fourth). */
  19 struct bin64_t {
  20     uint64_t v;
  21     static const uint64_t NONE;
  22     static const uint64_t ALL;
  23     static const uint32_t NONE32;
  24     static const uint32_t ALL32;
  25
  26     bin64_t() : v(NONE) {}
  27     bin64_t(const bin64_t&b) : v(b.v) {}
  28     bin64_t(const uint64_t val) : v(val) {}
  29     bin64_t(uint8_t layer, uint64_t offset) :
  30         v( (offset<<(layer+1)) | ((1ULL<<layer)-1) ) {}
  31     operator uint64_t () const { return v; }
  32     uint32_t to32() const ;
  33     bool operator == (bin64_t& b) const { return v==b.v; }
  34
  35     static bin64_t none () { return NONE; }
  36     static bin64_t all () { return ALL; }
  37
  38     uint64_t tail_bits () const {
  39         return v ^ (v+1);
  40     }
  41
  42     uint64_t tail_bit () const {
  43         return (tail_bits()+1)>>1;
  44     }
  45
  46     bin64_t sibling () const {
  47         // if (v==ALL) return NONE;
  48         return bin64_t(v^(tail_bit()<<1));
  49     }
  50
  51     int layer () const {
  52         int r = 0;
  53         uint64_t tail = ((v^(v+1))+1)>>1;
  54         if (tail>0xffffffffULL) {
  55             r = 32;
  56             tail>>=32;
  57         }
  58         // courtesy of Sean Eron Anderson
  59         // http://graphics.stanford.edu/~seander/bithacks.html
  60         static const int DeBRUIJN[32] = {
  61           0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8,
  62           31, 27, 13, 23, 21, 19, 16, 7, 26, 12, 18, 6, 11, 5, 10, 9
  63         };
  64         r += DeBRUIJN[((uint32_t)(tail*0x077CB531U))>>27];
  65         return r;
  66     }
  67
  68     uint64_t base_offset () const {
  69         return (v&~(tail_bits()))>>1;
  70     }
  71
  72     uint64_t offset () const {
  73         return v >> (layer()+1);
  74     }
  75
  76     bin64_t to (bool right) const {
  77         if (!(v&1))
  78             return NONE;
  79         uint64_t tb = tail_bit()>>1;
  80         if (right)
  81             tb |= (tb<<1);
  82         return bin64_t(v^tb);
  83     }
  84
  85     bin64_t left () const {
  86         return to(false);
  87     }
  88
  89     bin64_t right () const {
  90         return to(true);
  91     }
  92
  93     bool    within (bin64_t maybe_asc) {
  94         if (maybe_asc==bin64_t::NONE)
  95             return false;
  96         uint64_t short_tail = maybe_asc.tail_bits();
  97         if (tail_bits()>short_tail)
  98             return false;
  99         return (v&~short_tail) == (maybe_asc.v&~short_tail) ;
 100     }
 101
 102     /** Left or right, depending whether the destination is. */
 103     bin64_t towards (bin64_t dest) const {
 104         if (!dest.within(*this))
 105             return NONE;
 106         if (dest.within(left()))
 107             return left();
 108         else
 109             return right();
 110     }
 111
 112     bin64_t twisted (uint64_t mask) const {
 113         return bin64_t( v ^ ((mask<<1)&~tail_bits()) );
 114     }
 115
 116     bin64_t parent () const {
 117         uint64_t tbs = tail_bits(), ntbs = (tbs+1)|tbs;
 118         return bin64_t( (v&~ntbs) | tbs );
 119     }
 120
 121     bool is_left () const {
 122         uint64_t tb = tail_bit();
 123         return !(v&(tb<<1));
 124     }
 125     bool is_right() const { return !is_left(); }
 126
 127     bin64_t left_foot () const {
 128         if (v==NONE)
 129             return NONE;
 130         return bin64_t(0,base_offset());
 131     }
 132
 133     /** Whether layer is 0. */
 134     bool    is_base () const {
 135         return !(v & 1);
 136     }
 137
 138     /** Depth-first in-order binary tree traversal. */
 139     bin64_t next_dfsio (uint8_t floor);
 140
 141     bin64_t width () const {
 142         return (tail_bits()+1)>>1;
 143     }
 144
 145     /** The array must have 64 cells, as it is the max
 146      number of peaks possible +1 (and there are no reason
 147      to assume there will be less in any given case. */
 148     static int peaks (uint64_t length, bin64_t* peaks) ;
 149
 150 };
 151
 152
 153 #endif
 154
 155 /**
 156                  00111
 157        0011                    1011
 158   001      101         1001          1101
 159 0   10  100  110    1000  1010   1100   1110
 160
 161                   7
 162       3                         11
 163   1        5             9             13
 164 0   2    4    6       8    10      12     14
 165
 166 once we have peak hashes, this struture is more natural than bin-v1
 167
 168 */