Kmer.cpp 13.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
#include "Kmer.hpp"
#include <bitset>
#include <string>
#include <iostream>

using namespace std;

/*// use:  int2bin(a, buffer, buf_size);
// pre:  buf_size >= 8 and buffer has space for buf_size elements
// post: buffer[0,...,7] is the binary representation of a
void int2bin(uint32_t a, char *buffer, int buf_size) {
  //buffer += (buf_size - 1);

  for (int i = 7; i >= 0; i--) {
      *buffer++ = (a & 1) + '0';
      a >>= 1;
  }
}
*/

static const uint64_t twin_table[256] = {
0xFF, 0xBF, 0x7F, 0x3F, 0xEF, 0xAF, 0x6F, 0x2F,
0xDF, 0x9F, 0x5F, 0x1F, 0xCF, 0x8F, 0x4F, 0x0F,
0xFB, 0xBB, 0x7B, 0x3B, 0xEB, 0xAB, 0x6B, 0x2B,
0xDB, 0x9B, 0x5B, 0x1B, 0xCB, 0x8B, 0x4B, 0x0B,
0xF7, 0xB7, 0x77, 0x37, 0xE7, 0xA7, 0x67, 0x27,
0xD7, 0x97, 0x57, 0x17, 0xC7, 0x87, 0x47, 0x07,
0xF3, 0xB3, 0x73, 0x33, 0xE3, 0xA3, 0x63, 0x23,
0xD3, 0x93, 0x53, 0x13, 0xC3, 0x83, 0x43, 0x03,
0xFE, 0xBE, 0x7E, 0x3E, 0xEE, 0xAE, 0x6E, 0x2E,
0xDE, 0x9E, 0x5E, 0x1E, 0xCE, 0x8E, 0x4E, 0x0E,
0xFA, 0xBA, 0x7A, 0x3A, 0xEA, 0xAA, 0x6A, 0x2A,
0xDA, 0x9A, 0x5A, 0x1A, 0xCA, 0x8A, 0x4A, 0x0A,
0xF6, 0xB6, 0x76, 0x36, 0xE6, 0xA6, 0x66, 0x26,
0xD6, 0x96, 0x56, 0x16, 0xC6, 0x86, 0x46, 0x06,
0xF2, 0xB2, 0x72, 0x32, 0xE2, 0xA2, 0x62, 0x22,
0xD2, 0x92, 0x52, 0x12, 0xC2, 0x82, 0x42, 0x02,
0xFD, 0xBD, 0x7D, 0x3D, 0xED, 0xAD, 0x6D, 0x2D,
0xDD, 0x9D, 0x5D, 0x1D, 0xCD, 0x8D, 0x4D, 0x0D,
0xF9, 0xB9, 0x79, 0x39, 0xE9, 0xA9, 0x69, 0x29,
0xD9, 0x99, 0x59, 0x19, 0xC9, 0x89, 0x49, 0x09,
0xF5, 0xB5, 0x75, 0x35, 0xE5, 0xA5, 0x65, 0x25,
0xD5, 0x95, 0x55, 0x15, 0xC5, 0x85, 0x45, 0x05,
0xF1, 0xB1, 0x71, 0x31, 0xE1, 0xA1, 0x61, 0x21,
0xD1, 0x91, 0x51, 0x11, 0xC1, 0x81, 0x41, 0x01,
0xFC, 0xBC, 0x7C, 0x3C, 0xEC, 0xAC, 0x6C, 0x2C,
0xDC, 0x9C, 0x5C, 0x1C, 0xCC, 0x8C, 0x4C, 0x0C,
0xF8, 0xB8, 0x78, 0x38, 0xE8, 0xA8, 0x68, 0x28,
0xD8, 0x98, 0x58, 0x18, 0xC8, 0x88, 0x48, 0x08,
0xF4, 0xB4, 0x74, 0x34, 0xE4, 0xA4, 0x64, 0x24,
0xD4, 0x94, 0x54, 0x14, 0xC4, 0x84, 0x44, 0x04,
0xF0, 0xB0, 0x70, 0x30, 0xE0, 0xA0, 0x60, 0x20,
0xD0, 0x90, 0x50, 0x10, 0xC0, 0x80, 0x40, 0x00
};


/*static const uint8_t base_swap[256] = {
	0x00, 0x40, 0x80, 0xc0, 0x10, 0x50, 0x90, 0xd0,
	0x20, 0x60, 0xa0, 0xe0, 0x30, 0x70, 0xb0, 0xf0,
	0x04, 0x44, 0x84, 0xc4, 0x14, 0x54, 0x94, 0xd4,
	0x24, 0x64, 0xa4, 0xe4, 0x34, 0x74, 0xb4, 0xf4,
	0x08, 0x48, 0x88, 0xc8, 0x18, 0x58, 0x98, 0xd8,
	0x28, 0x68, 0xa8, 0xe8, 0x38, 0x78, 0xb8, 0xf8,
	0x0c, 0x4c, 0x8c, 0xcc, 0x1c, 0x5c, 0x9c, 0xdc,
	0x2c, 0x6c, 0xac, 0xec, 0x3c, 0x7c, 0xbc, 0xfc,
	0x01, 0x41, 0x81, 0xc1, 0x11, 0x51, 0x91, 0xd1,
	0x21, 0x61, 0xa1, 0xe1, 0x31, 0x71, 0xb1, 0xf1,
	0x05, 0x45, 0x85, 0xc5, 0x15, 0x55, 0x95, 0xd5,
	0x25, 0x65, 0xa5, 0xe5, 0x35, 0x75, 0xb5, 0xf5,
	0x09, 0x49, 0x89, 0xc9, 0x19, 0x59, 0x99, 0xd9,
	0x29, 0x69, 0xa9, 0xe9, 0x39, 0x79, 0xb9, 0xf9,
	0x0d, 0x4d, 0x8d, 0xcd, 0x1d, 0x5d, 0x9d, 0xdd,
	0x2d, 0x6d, 0xad, 0xed, 0x3d, 0x7d, 0xbd, 0xfd,
	0x02, 0x42, 0x82, 0xc2, 0x12, 0x52, 0x92, 0xd2,
	0x22, 0x62, 0xa2, 0xe2, 0x32, 0x72, 0xb2, 0xf2,
	0x06, 0x46, 0x86, 0xc6, 0x16, 0x56, 0x96, 0xd6,
	0x26, 0x66, 0xa6, 0xe6, 0x36, 0x76, 0xb6, 0xf6,
	0x0a, 0x4a, 0x8a, 0xca, 0x1a, 0x5a, 0x9a, 0xda,
	0x2a, 0x6a, 0xaa, 0xea, 0x3a, 0x7a, 0xba, 0xfa,
	0x0e, 0x4e, 0x8e, 0xce, 0x1e, 0x5e, 0x9e, 0xde,
	0x2e, 0x6e, 0xae, 0xee, 0x3e, 0x7e, 0xbe, 0xfe,
	0x03, 0x43, 0x83, 0xc3, 0x13, 0x53, 0x93, 0xd3,
	0x23, 0x63, 0xa3, 0xe3, 0x33, 0x73, 0xb3, 0xf3,
	0x07, 0x47, 0x87, 0xc7, 0x17, 0x57, 0x97, 0xd7,
	0x27, 0x67, 0xa7, 0xe7, 0x37, 0x77, 0xb7, 0xf7,
	0x0b, 0x4b, 0x8b, 0xcb, 0x1b, 0x5b, 0x9b, 0xdb,
	0x2b, 0x6b, 0xab, 0xeb, 0x3b, 0x7b, 0xbb, 0xfb,
	0x0f, 0x4f, 0x8f, 0xcf, 0x1f, 0x5f, 0x9f, 0xdf,
	0x2f, 0x6f, 0xaf, 0xef, 0x3f, 0x7f, 0xbf, 0xff
};

*/
// use:  km = Kmer();
// pre:  
// post: the DNA string in km is AA....AAA (k times A) 
Kmer::Kmer() {
  //memset(bytes,0,MAX_K/4);
  for (size_t i = 0; i < MAX_K/32; i++) {
    longs[i] = 0;
  }
}


// use:  _km = Kmer(km);
// pre:  s[0],...,s[k] are all equal to 'A','C','G' or 'T'
// post: the DNA string in _km and is the same as in km 
Kmer::Kmer(const Kmer& o) {
  //memcpy(bytes,o.bytes,MAX_K/4);
  for (size_t i = 0; i < MAX_K/32; i++) {
    longs[i] = o.longs[i];
  }
}


// use:  km = Kmer(s);
// pre:  s[0],...,s[k] are all equal to 'A','C','G' or 'T'
// post: the DNA string in km is now the same as s
Kmer::Kmer(const char *s) {
  set_kmer(s);
}


// use:  _km = km;
// pre:  
// post: the DNA string in _km and is the same as in km 
Kmer& Kmer::operator=(const Kmer& o) {
  if (this != &o) {
    for (size_t i = 0; i < MAX_K/32; i++) {
      longs[i] = o.longs[i];
    }
    //memcpy(bytes, o.bytes, MAX_K/4);
  }
  return *this;
}


// use:  km = Kmer();
// pre:  
// post: The last bit in the bit array which stores the DNA string has been set to 1
//       which indicates that the km is invalid
void Kmer::set_deleted() {
  memset(bytes,0xff,MAX_K/4);
}


// use:  b = (km1 < km2);
// pre:  
// post: b is true <==> the DNA strings in km1 is alphabetically smaller than
//                      the DNA string in km2 
bool Kmer::operator<(const Kmer& o) const {

  bool r = false;
  for (size_t i = 0; i < MAX_K/32; ++i) {
    if (longs[i] < o.longs[i])
      return true;
    if (longs[i] > o.longs[i])
      return false;
  }
  return false;

  /*
  for (size_t i = 0; i < k_bytes-1; ++i) {
    if (base_swap[bytes[i]] > base_swap[o.bytes[i]]) {
      return false;
    } else if (base_swap[bytes[i]] < base_swap[o.bytes[i]]) {
      return true;
    }
  }

  if (base_swap[bytes[k_bytes-1] & k_modmask] >= base_swap[o.bytes[k_bytes-1] & k_modmask]) {
    return false;
  }
  return true;
  */
}


// use:  b = (km1 == km2);
// pre:  
// post: b is true <==> the DNA strings in km1 and km2 are equal
bool Kmer::operator==(const Kmer& o) const {
  for (size_t i = 0; i < MAX_K/32; i++) {
    if (longs[i] != o.longs[i]) {
      return false;
    }
  }
  return true;
  //  return memcmp(bytes,o.bytes,MAX_K/4)==0;
}


// use:  km.set_kmer(s);
// pre:  s[0],...,s[k-1] are all 'A','C','G' or 'T'
// post: The DNA string in km is now equal to s 
void Kmer::set_kmer(const char *s)  {
  size_t i,j,l;
  memset(bytes,0,MAX_K/4);
    
  for (i = 0; i < k; ++i) {
    j = i % 32;
    l = i/32;
    assert(*s != '\0');
    
    size_t x = ((*s) & 4) >> 1;
    longs[l] |= ((x + ((x ^ (*s & 2)) >>1)) << (2*(31-j)));
    /*
    switch(*s) {
      case 'A': break;
      case 'C': longs[l] |= (0x01 << (2*j)); break;
      case 'G': longs[l] |= (0x02 << (2*j)); break;
      case 'T': longs[l] |= (0x03 << (2*j)); break;
      }*/
    
    s++; 
  }
}


// use:  i = km.hash();
// pre:   
// post: i is the hash value of km 
uint64_t Kmer::hash() const {
  uint64_t ret;
  MurmurHash3_x64_64((const void*)bytes,k_bytes,0,&ret);
  return ret;
}


// use:  rep = km.rep();
// pre:   
// post: rep is km.twin() if the DNA string in km.twin() is alphabetically smaller than
//       the DNA string in km, else rep is km
Kmer Kmer::rep() const {
  Kmer tw = twin();
  return (tw < *this) ? tw : *this;
}


// use:  tw = km.twin();
// pre:   
// post: tw is the twin kmer with respect to km,
//       i.e. if the DNA string in km is 'GTCA'
//          then the DNA string in tw is 'TGAC'
Kmer Kmer::twin() const {
  Kmer km(*this);

  size_t nlongs = (k+31)/32;
  
  for (size_t i = 0; i < nlongs; i++) {
    uint64_t v = longs[i];
    km.longs[nlongs-1-i] =  
      (twin_table[v & 0xFF] << 56) | 
      (twin_table[(v>>8) & 0xFF] << 48) | 
      (twin_table[(v>>16) & 0xFF] << 40) | 
      (twin_table[(v>>24) & 0xFF] << 32) |
      (twin_table[(v>>32) & 0xFF] << 24) | 
      (twin_table[(v>>40) & 0xFF] << 16) | 
      (twin_table[(v>>48) & 0xFF] << 8)  |
      (twin_table[(v>>56)]);
  }

  size_t shift = (k%32) ? 2*(32-(k%32)) : 0 ;
  //  uint64_t shiftmask = (k%32) ? (((1ULL << (2 * (k%32)))-1)<< shift) : ~0x0ULL;
  uint64_t shiftmask = (k%32) ? (((1ULL<< shift)-1) << (64-shift)) : 0ULL;

  
  km.longs[0] = km.longs[0] << shift;
  for (size_t i = 1; i < nlongs; i++) {
    km.longs[i-1] |= (km.longs[i] & shiftmask) >> (64-shift);
    km.longs[i] = km.longs[i] << shift;    
  }
  
  return km;
}


// use:  link = km.getLink(index);
// pre:  0 <= index < 8
// post: gives the forward kmer with the (index % 4) character in 'A','C','G' or 'T' if index < 4
//       else the backward kmer with the (index % 4) character in 'A','C','G' or 'T'
Kmer Kmer::getLink(const size_t index) const {
  assert(index >= 0 && index < 8);
  char c;

  switch (index % 4) {
    case 0: c = 'A'; break;
    case 1: c = 'C'; break;
    case 2: c = 'G'; break;
    case 3: c = 'T'; break;
  }
  
  return (index < 4) ? forwardBase(c) : backwardBase(c);
}


// use:  fw = km.forwardBase(c)
// pre:  
// post: fw is the forward kmer from km with last character c,
//       i.e. if the DNA string in km is 'ACGT' and c equals 'T' then
//       the DNA string in fw is 'CGTT'
Kmer Kmer::forwardBase(const char b) const {
  Kmer km(*this);

  km.longs[0] = km.longs[0] << 2;
  size_t nlongs = (k+31)/32;
  for (size_t i = 1; i < nlongs; i++) {
    km.longs[i-1] |= (km.longs[i] & (3ULL<<62)) >> 62;
    km.longs[i]  = km.longs[i] << 2;
  }
  uint64_t x = (b & 4) >>1;
  km.longs[nlongs-1] |= (x + ((x ^ (b & 2)) >>1 )) << (2*(31-((k-1)%32)));

  return km;
/********
  km.shiftBackward(2);
  km.bytes[k_bytes-1] &= Kmer::k_modmask;

  switch(b) {
    case 'A': km.bytes[k_bytes-1] |= 0x00 << s; break;
    case 'C': km.bytes[k_bytes-1] |= 0x01 << s; break;
    case 'G': km.bytes[k_bytes-1] |= 0x02 << s; break;
    case 'T': km.bytes[k_bytes-1] |= 0x03 << s; break;
  }

  return km;
*/
}


bool Kmer::equalUpToLastBase(const Kmer & rhs)
{
	Kmer Ashifted = rhs.backwardBase('A');
	Kmer Bshifted = backwardBase('A');
	return (Ashifted == Bshifted);
}


	

// use:  bw = km.backwardBase(c)
// pre:  
// post: bw is the backward kmer from km with first character c,
//       i.e. if the DNA string in km is 'ACGT' and c equals 'T' then
//       the DNA string in bw is 'TACG'
Kmer Kmer::backwardBase(const char b) const {
  Kmer km(*this);
  
  size_t nlongs = (k+31)/32;
  km.longs[nlongs-1] = km.longs[nlongs-1] >>2;
  km.longs[nlongs-1] &= (k%32) ? (((1ULL << (2*(k%32)))-1) << 2*(32-(k%32))) : ~0ULL;

  for (size_t i = 1; i < nlongs; i++) {
    km.longs[nlongs-i] |= (km.longs[nlongs-i-1] & 3ULL) << 62;
    km.longs[nlongs-i-1] = km.longs[nlongs-i-1] >>2;
  }
  uint64_t x = (b & 4) >> 1;
  km.longs[0] |= (x + ((x ^ (b & 2)) >> 1)) << 62;

  return km;

  /*
  km.shiftForward(2);
  km.bytes[k_bytes-1] &= Kmer::k_modmask;

  if (k%4 == 0 and k_bytes < MAX_K/4) {
    km.bytes[k_bytes] = 0x00;
  }

  switch(b) {
    case 'A': km.bytes[0] |= 0x00; break;
    case 'C': km.bytes[0] |= 0x01; break;
    case 'G': km.bytes[0] |= 0x02; break;
    case 'T': km.bytes[0] |= 0x03; break;
  }

  return km;
  */
}


// use:  km.printBinary();
// pre:   
// post: The bits in the binary representation of the 
//       DNA string for km has been printed to stdout
std::string Kmer::getBinary() const {
  
  size_t nlongs = MAX_K/32;
  std::string r;
  r.reserve(64*nlongs);
  for (size_t i = 0; i < nlongs; i++) {
    r.append(std::bitset<64>(longs[i]).to_string<char,std::char_traits<char>,std::allocator<char> >());
  }
  return r;
  /*
  for (size_t i = 0; i < Kmer::k_bytes; i++) {
    int2bin(bytes[i],buff,8);
    printf("%s",buff);
  }
  
  printf("\n");
  */
}


// use:  km.toString(s);
// pre:  s has space for k+1 elements
// post: s[0,...,k-1] is the DNA string for the Kmer km and s[k] = '\0'
void Kmer::toString(char * s) const {
  size_t i,j,l;
  
  for (i = 0; i < k; i++) {
    j = i % 32;
    l = i / 32;

    switch(((longs[l]) >> (2*(31-j)) )& 0x03 ) {
      case 0x00: *s = 'A'; ++s; break;
      case 0x01: *s = 'C'; ++s; break;
      case 0x02: *s = 'G'; ++s; break;
      case 0x03: *s = 'T'; ++s; break;  
    }
  }

  *s = '\0';
}

std::string Kmer::toString() const {
  char buf[MAX_K];
  toString(buf);
  return std::string(buf);
}



// use:  km.shiftForward(i);
// pre:  i = 0,..,31
// post: The DNA string in km has been shifted  positions forward i.e.
//       if i=2 then ACGT becomes XACG and X is A,C,G or T
/*
void Kmer::shiftForward(int shift) {
  
  size_t shiftmask = 


  if (shift>0) {
    if (shift < 8 ) {
      for (size_t i = Kmer::k_bytes-1; i > 0; i--) {
        bytes[i] <<= shift;
        bytes[i] |= (uint8_t) (bytes[i-1] >> (8-shift));
      }

      bytes[0] <<= shift;
    } else {
      assert(0); // we should never need this!
    }
  }
}
*/

// use:  km.shiftBackward(i);
// pre:  i = 2,4,6 
// post: The DNA string in km has been shifted i/2 positions backward i.e.
//       if i=2 then ACGT becomes CGTX and X is A,C,G or T
/*
void Kmer::shiftBackward(int shift) {
  if (shift > 0) {
    if (shift < 8) {
      for (size_t i = 0; i < Kmer::k_bytes-1; i++) {
        bytes[i] >>= shift;
        bytes[i] |= (uint8_t) ( bytes[i+1] << (8-shift));
      }
      
      bytes[Kmer::k_bytes-1] >>= shift;
    } else {
      assert(0); // bad
    }
  }
}
*/


// use:  set_k(k);
// pre:  this method has not been called before and 0 < k < MAX_K
// post: The Kmer size has been set to k
void Kmer::set_k(unsigned int _k) {
  if(_k == k) {
    return; // ok to call more than once
  }
  assert(_k < MAX_K);
  assert(_k > 0);
  assert(k_bytes == 0); // we can only call this once
  k = _k;
  k_bytes = (_k+3)/4;
  //  k_longs = (_k+15)/16;
  k_modmask = (1 << (2*((k%4)?k%4:4)) )-1;
}


unsigned int Kmer::k = 0;
unsigned int Kmer::k_bytes = 0;
//unsigned int Kmer::k_longs = 0;
unsigned int Kmer::k_modmask = 0;