kmerstore.h 16 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1 2 3 4 5 6 7 8
#ifndef KMERSTORE_H
#define KMERSTORE_H

#include <map>
#include <string>
#include <list>
#include <stdexcept>
#include <stdint.h>
9
#include <math.h>
Mikaël Salson's avatar
Mikaël Salson committed
10 11 12 13 14 15 16 17 18 19
#include "fasta.h"
#include "tools.h"

using namespace std;

class Kmer {
public:
  unsigned int count;

  Kmer();
20 21 22 23

  /**
   * This constructor is used via a IKmerStore<Kmer> index (hence the argument list)       
   */
24
  Kmer(const string &label, int strand=1, size_t length=0);
25

Mikaël Salson's avatar
Mikaël Salson committed
26
  Kmer &operator+=(const Kmer &);
27

28 29 30 31 32
  /**
   * @return the length of the kmer (only there for compatibility with KmerAffect)
   */
  size_t getLength() const;

33 34 35 36
  /**
   * When indexing revcomp, should the value be the same or not?
   * In other words, does the information stored by the class is strand-dependent?
   */
Mikaël Salson's avatar
Mikaël Salson committed
37
  static bool hasRevcompSymetry();
38 39 40 41

  /**
   * @return true if the element is the same as when initialised with default constructor.
   */
42 43 44 45 46 47 48
  bool isNull() const;

  /**
   * @return true iff the kmer is unknown (which doesn't make sense here but
   * it only there for a reason of compatibility with KmerAffect)
   */
  bool isUnknown() const;
Mikaël Salson's avatar
Mikaël Salson committed
49 50
} ;
ostream &operator<<(ostream &os, const Kmer &kmer);
51 52 53 54 55 56 57
bool operator==(const Kmer &k1, const Kmer &k2);
bool operator<(const Kmer &k1, const Kmer &k2);
bool operator>(const Kmer &k1, const Kmer &k2);
bool operator<=(const Kmer &k1, const Kmer &k2);
bool operator>=(const Kmer &k1, const Kmer &k2);
bool operator!=(const Kmer &k1, const Kmer &k2);

Mikaël Salson's avatar
Mikaël Salson committed
58 59 60 61 62 63 64 65 66 67 68


/* K-mer indexing */

template <class T> class IKmerStore
{
protected:
  bool revcomp_indexed;
  int k; // weight of the seed
  int s; // span of the seed (s >= k)
  string seed ;
69
  size_t nb_kmers_inserted;
70
  size_t max_size_indexing;
71
  bool finished_building;
Mikaël Salson's avatar
Mikaël Salson committed
72 73 74 75 76

public:

  virtual ~IKmerStore();

77 78
  static int last_id;
  int id; // id of this index
79
  int refs; // number of germlines using this index
80

81
  list< pair <T, Fasta> > labels;
82

83 84
  IKmerStore();

Mikaël Salson's avatar
Mikaël Salson committed
85 86 87
  /**
   * @param input: A single FASTA file
   * @param label: label that must be associated to the given files
88
   * @param seed: the seed to use for indexing. By default it will be the seed of the index
89
   * @post All the sequences in the FASTA files have been indexed, and the label is stored in the list of labels
Mikaël Salson's avatar
Mikaël Salson committed
90
   */
91
  void insert(Fasta& input, const string& label="", int keep_only = 0, string seed = "");
Mikaël Salson's avatar
Mikaël Salson committed
92 93 94 95

  /**
   * @param input: A list of FASTA files
   * @param label: label that must be associated to the given files
96
   * @param seed: the seed to use for indexing. By default it will be the seed of the index
97
   * @post All the sequences in the FASTA files have been indexed, and the label is stored in the list of labels
Mikaël Salson's avatar
Mikaël Salson committed
98
   */
99
  void insert(list<Fasta>& input, const string& label="", int keep_only = 0, string seed = "");
Mikaël Salson's avatar
Mikaël Salson committed
100 101 102 103
  
  /**
   * @param input: A sequence to be cut in k-mers
   * @param label: label that must be associated to the given files
104 105 106 107
   * @param keep_only: if > 0 will keep at most the last keep_only nucleotides
   *                   of the sequence. if < 0 will keep at most the first
   *                   keep_only nucleotides of the sequence. if == 0,
   *                   will keep all the sequence.
108
   * @param seed: the seed to use for indexing. By default it will be the seed of the index
Mikaël Salson's avatar
Mikaël Salson committed
109 110
   * @post All the k-mers in the sequence have been indexed.
   */
111 112 113 114 115 116 117 118 119 120
  virtual void insert(const seqtype &sequence,
                      const string &label,
                      bool ignore_extended_nucleotides=true, int keep_only = 0,
                      string seed="");

  /**
   * Perform extra steps to finish the building of the index. After using
   * that function, we are not supposed to insert any other sequence.
   * No query function should be called before calling that function.
   */
121
  virtual void finish_building();
Mikaël Salson's avatar
Mikaël Salson committed
122 123 124 125 126

  /**
   * @param word: a k-mer
   * @return the value for the kmer as stored in the structure (don't do revcomp)
   */ 
127
  virtual T& get(seqtype &word) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
128

129
  /**
130 131 132 133
   * @return the percentage of kmers that are set in the index.
   *         When ! hasDifferentKmerTypes(), the index load is always the same
   *         (apart for the unknown kmer).
   *         When kmer.isUnknown(), we return the load of all th other kmers.
134
   */
135
  virtual float getIndexLoad(T kmer) const;
136

137 138 139 140 141 142
  /**
   * @return the given integer (size of a read),
   *         but limit this size to max_size_indexing if it was defined
   */
  int atMostMaxSizeIndexing(int n) const;

143 144 145
  /**
   * @return probability that the number of kmers is 'at_least' or more in a sequence of length 'length'
   */
146
  double getProbabilityAtLeastOrAbove(T kmer, int at_least, int length) const;
147

Mikaël Salson's avatar
Mikaël Salson committed
148 149 150 151 152 153 154 155 156 157
  /**
   * @return the value of k
   */
  int getK() const;

  /**
   * @return the value of s
   */
  int getS() const;

158 159 160 161 162
  /**
   * @return the seed used
   */
  string getSeed() const;

163 164 165 166
  /**
   * @param kmer: a kmer
   * @return one label associated with the kmer
   */
167
  Fasta getLabel(T kmer) const;
168

169 170 171 172 173
  /**
   * @return whether the index differentiate kmer types
   */
  virtual bool hasDifferentKmerTypes() const;

Mikaël Salson's avatar
Mikaël Salson committed
174 175 176 177
  /**
   * @param seq: a sequence
   * @param no_revcomp: force not to revcomp the sequence, even if
   *                    the index was built with revcomp.
178 179
   * @return a vector of length seq.length() - d, where d is the span
   *         of the seed (minus one) or is 0 when it doesn't apply.
180
   * containing for each position the corresponding value in the index.
Mikaël Salson's avatar
Mikaël Salson committed
181
   */
182
  virtual vector<T> getResults(const seqtype &seq, bool no_revcomp=false, string seed="") = 0;
Mikaël Salson's avatar
Mikaël Salson committed
183 184 185 186 187 188 189 190 191 192 193 194

  /**
   * @return true iff the revcomp is indexed
   */
  bool isRevcomp() const;

  /**
   * @param string: a k-mer
   * @return the value in the index associated to the given k-mer.
   *         isRevcomp() ==> the revcomp of the k-mer may be considered
   * @pre word.length() == this->k
   */
195
  virtual T& operator[](seqtype& word) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
196 197
};

198 199 200
template<class T>
IKmerStore<T>::IKmerStore() {
  id = ++last_id;
Mikaël Salson's avatar
Mikaël Salson committed
201
  refs = 0;
202
  finished_building = false;
203 204
}

205
template<class T> int IKmerStore<T>::last_id = 0;
Mikaël Salson's avatar
Mikaël Salson committed
206 207 208 209 210

template <class T> 
class MapKmerStore : public IKmerStore<T>
{
public:	
211
  map<seqtype, T> store;
Mikaël Salson's avatar
Mikaël Salson committed
212 213 214 215 216 217 218

  /**
   * @param bool: if true, will also index revcomp
   * @param seed: the seed
   */
  MapKmerStore(string seed, bool=false);
  MapKmerStore(int k, bool=false);
219

220
  vector<T> getResults(const seqtype &seq, bool no_revcomp=false, string seed="");
221 222
  T& get(seqtype &word);
  T& operator[](seqtype & word);
223 224 225

 private:
  void init();
Mikaël Salson's avatar
Mikaël Salson committed
226 227 228 229 230 231 232
};

template <class T> 
class ArrayKmerStore : public IKmerStore<T>
{
  T* store;
	
233
  int index(const seqtype& word) const;
234 235 236 237 238 239 240 241

  /**
   * Allocates memory for store
   * @throws bad_alloc: when there is not enough memory or when the
   *                    the total number of kmers cannot be stored in an 
   *                    unsigned int
   */
  void init();
Mikaël Salson's avatar
Mikaël Salson committed
242 243 244 245 246 247 248 249
public:
  /**
   * @param bool: if true, will also index revcomp
   * @param seed: the seed
   */
  ArrayKmerStore(string seed, bool=false);
  ArrayKmerStore(int k, bool=false);
  ~ArrayKmerStore();
250

251
  vector<T> getResults(const seqtype &seq, bool no_revcomp=false, const string seed="");
252 253
  T& get(seqtype &word);
  T& operator[](seqtype & word);
254
  T& operator[](int word);
Mikaël Salson's avatar
Mikaël Salson committed
255 256 257 258 259 260 261 262 263 264
};


// IKmerStore

template<class T>
IKmerStore<T>::~IKmerStore(){}

template<class T> 
void IKmerStore<T>::insert(list<Fasta>& input,
265
                           const string &label,
266 267
                           int keep_only,
                           string seed){
Mikaël Salson's avatar
Mikaël Salson committed
268
  for(list<Fasta>::iterator it = input.begin() ; it != input.end() ; it++){
269
    insert(*it, label, keep_only, seed);
Mikaël Salson's avatar
Mikaël Salson committed
270 271 272 273 274
  }
}

template<class T> 
void IKmerStore<T>::insert(Fasta& input,
275
                           const string &label,
276 277
                           int keep_only,
                           string seed){
Mikaël Salson's avatar
Mikaël Salson committed
278
  for (int r = 0; r < input.size(); r++) {
279
    insert(input.sequence(r), label, true, keep_only, seed);
Mikaël Salson's avatar
Mikaël Salson committed
280
  }
281

282
  labels.push_back(make_pair(T(label, 1, seed.size()), input)) ;
283 284

  if (revcomp_indexed  && ! T::hasRevcompSymetry()) {
285
    labels.push_back(make_pair(T(label, -1, seed.size()), input)) ;
286
  }
Mikaël Salson's avatar
Mikaël Salson committed
287 288 289
}

template<class T> 
290
void IKmerStore<T>::insert(const seqtype &sequence,
291
                           const string &label,
292
                           bool ignore_extended_nucleotides,
293 294
                           int keep_only,
                           string seed){
295 296 297 298 299 300 301
  size_t start_indexing = 0;
  size_t end_indexing = sequence.length();
  if (keep_only > 0 && sequence.length() > (size_t)keep_only) {
    start_indexing = sequence.length() - keep_only;
  } else if (keep_only < 0 && sequence.length() > (size_t) -keep_only) {
    end_indexing = -keep_only;
  }
302

303 304 305 306
  if (seed.empty())
    seed = this->seed;

  size_t seed_span = seed.length();
307 308 309 310 311
  size_t size_indexing = end_indexing - start_indexing;
  if (size_indexing > max_size_indexing) {
    max_size_indexing = size_indexing;
  }

312 313
  for(size_t i = start_indexing ; i + seed_span < end_indexing + 1 ; i++) {
    seqtype substr = sequence.substr(i, seed_span);
314
    seqtype kmer = spaced(substr, seed);
315

316
    if (ignore_extended_nucleotides && has_extended_nucleotides(kmer))
317 318
      continue;

Mikaël Salson's avatar
Mikaël Salson committed
319 320
    int strand = 1;
    if (revcomp_indexed && T::hasRevcompSymetry()) {
321
      seqtype rc_kmer = revcomp(kmer);
Mikaël Salson's avatar
Mikaël Salson committed
322 323 324 325 326
      if (rc_kmer.compare(kmer) < 0) {
        strand = -1;
        kmer = rc_kmer;
      }
    }
327 328 329 330
    T &this_kmer = this->get(kmer);
    if (this_kmer.isNull()) {
      nb_kmers_inserted++;
    }
331
    this_kmer += T(label, strand, seed.size());
Mikaël Salson's avatar
Mikaël Salson committed
332
    if (revcomp_indexed && ! T::hasRevcompSymetry()) {
333
      seqtype rc_kmer = spaced(revcomp(substr), seed);
334 335 336
      T &this_rc_kmer = this->get(rc_kmer);
      if (this_rc_kmer.isNull())
        nb_kmers_inserted++;
337
      this_rc_kmer += T(label, -1, seed.size());
Mikaël Salson's avatar
Mikaël Salson committed
338 339 340
    }
  }
}
341

342
template<class T>
343 344 345
void IKmerStore<T>::finish_building() {
  finished_building = true;
}
346

347 348
template<class T>
float IKmerStore<T>::getIndexLoad(const T kmer) const {
349
  float index_load = nb_kmers_inserted / pow(4.0, k);
350
  return (kmer.isUnknown()) ? 1 - index_load : index_load;
351
}
Mikaël Salson's avatar
Mikaël Salson committed
352

353 354 355 356 357 358 359
template<class T>
int IKmerStore<T>::atMostMaxSizeIndexing(int n) const {
  if (!max_size_indexing || n < max_size_indexing)
    return n ;

  return max_size_indexing ;
}
360 361

template<class T>
362
double IKmerStore<T>::getProbabilityAtLeastOrAbove(const T kmer, int at_least, int length) const {
363 364 365

  // n: number of kmers in the sequence
  int n = length - getS() + 1;
366
  float index_load = getIndexLoad(kmer) ;
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

  double proba = 0;
  double probability_having_system = pow(index_load, at_least);
  double probability_not_having_system = pow(1 - index_load, n - at_least);
  for (int i=at_least; i<=n; i++) {
    proba += nChoosek(n, i) * probability_having_system * probability_not_having_system;
    probability_having_system *= index_load;
    probability_not_having_system /= (1 - index_load);
  }

  return proba;
}



Mikaël Salson's avatar
Mikaël Salson committed
382 383 384 385 386 387 388 389 390 391
template<class T>
int IKmerStore<T>::getK() const {
  return k;
}

template<class T>
int IKmerStore<T>::getS() const {
  return s;
}

392 393 394 395 396
template<class T>
string IKmerStore<T>::getSeed() const {
  return seed;
}

397
template<class T>
398 399
Fasta IKmerStore<T>::getLabel(T kmer) const {
  for (typename list< pair<T, Fasta> >::const_iterator it = labels.begin(); it != labels.end(); ++it)
400 401
    if (it->first == kmer)
      return it->second ;
402
  return FASTA_AMBIGUOUS ;
403
}
404

405 406 407 408 409
template<class T>
bool IKmerStore<T>::hasDifferentKmerTypes() const {
  return false;
}

410
// .getResults()
Mikaël Salson's avatar
Mikaël Salson committed
411
template<class T>
412
vector<T> MapKmerStore<T>::getResults(const seqtype &seq, bool no_revcomp, string seed) {
413

Mikaël Salson's avatar
Mikaël Salson committed
414
  string local_seed = seed;
415
  if (! seed.size())
Mikaël Salson's avatar
Mikaël Salson committed
416 417
    local_seed = IKmerStore<T>::seed;
  int s = local_seed.size();
418

Mikaël Salson's avatar
Mikaël Salson committed
419 420 421 422 423
  if ((int)seq.length() < s - 1) {
    return vector<T>(0);
  }
  vector<T> result(seq.length() - s + 1);
  for (size_t i=0; i + s < seq.length() + 1; i++) {
Mikaël Salson's avatar
Mikaël Salson committed
424
    seqtype kmer = spaced(seq.substr(i, s), local_seed);
425
    //    seqtype kmer = seq.substr(i, s);
Mikaël Salson's avatar
Mikaël Salson committed
426
    // cout << kmer << endl << kmer0 << endl << endl ;
427
    if (IKmerStore<T>::revcomp_indexed && no_revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
428 429 430 431 432 433 434 435
      result[i] = get(kmer);
    } else {
      result[i] = (*this)[kmer];
    }
  }
  return result;
}

436
template<class T>
437
vector<T> ArrayKmerStore<T>::getResults(const seqtype &seq, bool no_revcomp, string seed) {
Mikaël Salson's avatar
Mikaël Salson committed
438 439

  string local_seed = seed;
440
  if (! seed.size())
Mikaël Salson's avatar
Mikaël Salson committed
441 442
    local_seed = IKmerStore<T>::seed;
  int s = local_seed.size();
443 444 445 446 447 448 449 450 451 452 453 454

  int N = (int)seq.length();

  if (N < s - 1) {
    return vector<T>(0);
  }
  vector<T> result(N - s + 1);

  /* Read once the sequence, convert it to int* */
  int* intseq = new int[N];
  for (int i=0; i<N; i++)
    {
455
      intseq[i] = nuc_to_int(seq[i]);
456 457 458 459
    }

  /* Compute results */
  for (size_t i=0; (int) i+s < N+1; i++) {
Mikaël Salson's avatar
Mikaël Salson committed
460
    int kmer = spaced_int(intseq + i, local_seed);
461 462 463 464
    if (IKmerStore<T>::revcomp_indexed && no_revcomp) {
      result[i] = store[kmer]; // getfromint(kmer); // store[kmer];
      // cout << i << "/" << N << "  " << kmer << result[i] << endl ;
    } else {
465
      result[i] = (*this)[kmer]; // Deals with revcomp
466 467 468 469 470 471 472
    }
  }

  delete[] intseq ;
  return result;
}

Mikaël Salson's avatar
Mikaël Salson committed
473 474 475 476 477 478 479 480 481

template<class T>
bool IKmerStore<T>::isRevcomp() const {
  return revcomp_indexed;
}

// MapKmerStore

template <class T>
482
MapKmerStore<T>::MapKmerStore(string seed, bool revcomp):IKmerStore<T>(){
Mikaël Salson's avatar
Mikaël Salson committed
483 484 485 486 487
  this->seed = seed;   
  int k = seed_weight(seed);
  this->k = k;
  this->s = seed.size();
  this->revcomp_indexed = revcomp;
488
  init();
Mikaël Salson's avatar
Mikaël Salson committed
489 490 491
}

template <class T>
492
MapKmerStore<T>::MapKmerStore(int k, bool revcomp):IKmerStore<T>(){
Mikaël Salson's avatar
Mikaël Salson committed
493 494 495 496
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
497 498 499 500 501 502
  init();
}

template <class T>
void MapKmerStore<T>::init() {
  this->nb_kmers_inserted = 0;
503
  this->max_size_indexing = 0;
Mikaël Salson's avatar
Mikaël Salson committed
504 505 506
}

template <class T> 
507
T& MapKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
508 509 510 511
  return store[word];
}

template <class T> 
512
T& MapKmerStore<T>::operator[](seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
513
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
514
    seqtype rc_kmer = revcomp(word);
Mikaël Salson's avatar
Mikaël Salson committed
515 516 517 518 519 520 521 522 523
    if (rc_kmer.compare(word) < 0)
      word = rc_kmer;
  }
  return store[word];
}

// ArrayKmerStore

template <class T> 
524
ArrayKmerStore<T>::ArrayKmerStore(int k, bool revcomp):IKmerStore<T>() {
Mikaël Salson's avatar
Mikaël Salson committed
525 526 527 528
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
529
  init();
Mikaël Salson's avatar
Mikaël Salson committed
530 531 532 533
}


template <class T> 
534
ArrayKmerStore<T>::ArrayKmerStore(string seed, bool revcomp):IKmerStore<T>(){
Mikaël Salson's avatar
Mikaël Salson committed
535 536 537 538 539
  this->seed = seed; 
  int k = seed_weight(seed);
  this->k = k;
  this->s = seed.size();
  this->revcomp_indexed = revcomp;
540 541 542 543 544
  init();
}

template <class T>
void ArrayKmerStore<T>::init() {
545
  this->nb_kmers_inserted = 0;
546
  this->max_size_indexing = 0;
547
  if ((size_t)(this->k << 1) >= sizeof(int) * 8)
Mikaël Salson's avatar
Mikaël Salson committed
548
    throw std::bad_alloc();
549
  store = new T[(unsigned int)1 << (this->k << 1)];
Mikaël Salson's avatar
Mikaël Salson committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563
  if (! store)
    throw std::bad_alloc();
}

template <class T> 
ArrayKmerStore<T>::~ArrayKmerStore(){
  delete [] store;
}

/**	Returns index of word in an array of size 4^k
	Considering B(A) = 0, B(C) = 1, B(T) = 2, B(G) = 3
	index_word = \sum_{i=0}^{k-1}B(word[i])*4^(k-i-1)
**/
template <class T> 
564
int ArrayKmerStore<T>::index(const seqtype& word) const{
Mikaël Salson's avatar
Mikaël Salson committed
565
  return dna_to_int(word, this->k);
Mikaël Salson's avatar
Mikaël Salson committed
566 567 568
}

template <class T> 
569
T& ArrayKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
570 571 572 573
  return store[index(word)];
}

template <class T> 
574
T& ArrayKmerStore<T>::operator[](seqtype& word){
575 576 577 578 579
  return (*this)[index(word)];
}

template <class T> 
T& ArrayKmerStore<T>::operator[](int word){
Mikaël Salson's avatar
Mikaël Salson committed
580
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
581 582
    int rc_kmer = revcomp_int(word, IKmerStore<T>::k);
    if (rc_kmer < word)
Mikaël Salson's avatar
Mikaël Salson committed
583 584
      word = rc_kmer;
  }
585
  return store[word];
Mikaël Salson's avatar
Mikaël Salson committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
}


/**
 * KmerStoreFactory is a factory that allows to create an index that best fits
 * your needs!
 */
class KmerStoreFactory {
 public:
  template<class T>
    static IKmerStore<T> *createIndex(string seed, bool revcomp=false);
  template<class T>
    static IKmerStore<T> *createIndex(int k, bool revcomp=false);
};

template<class T>
IKmerStore<T> *KmerStoreFactory::createIndex(string seed, bool revcomp) {
  IKmerStore<T> *index;
  try{
    index = new ArrayKmerStore<T>(seed, revcomp);
  }catch(exception e){
607
    cout << "  (using a MapKmer to fit into memory)" << endl;
Mikaël Salson's avatar
Mikaël Salson committed
608 609
    index = new MapKmerStore<T>(seed, revcomp);
  }
610

Mikaël Salson's avatar
Mikaël Salson committed
611 612 613 614 615 616 617 618 619
  return index;
}

template<class T>
IKmerStore<T> *KmerStoreFactory::createIndex(int k, bool revcomp) {
  return createIndex<T>(seed_contiguous(k), revcomp);
}

#endif