kmerstore.h 10.4 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
#ifndef KMERSTORE_H
#define KMERSTORE_H

#include <map>
#include <string>
#include <list>
#include <stdexcept>
#include <stdint.h>
#include "fasta.h"
#include "tools.h"

using namespace std;

class Kmer {
public:
  unsigned int count;

  Kmer();
19 20 21 22

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

Mikaël Salson's avatar
Mikaël Salson committed
25 26
  Kmer &operator+=(const Kmer &);
  static bool hasRevcompSymetry();
27 28 29 30 31

  /**
   * @return true if the element is the same as when initialised with default constructor.
   */
  bool isNull();
Mikaël Salson's avatar
Mikaël Salson committed
32 33 34 35 36 37 38 39 40 41 42 43 44
} ;
ostream &operator<<(ostream &os, const Kmer &kmer);


/* 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 ;
45
  size_t nb_kmers_inserted;
Mikaël Salson's avatar
Mikaël Salson committed
46 47 48 49 50

public:

  virtual ~IKmerStore();

51 52
  list< pair <T, string> > labels;

Mikaël Salson's avatar
Mikaël Salson committed
53 54 55
  /**
   * @param input: A single FASTA file
   * @param label: label that must be associated to the given files
56
   * @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
57 58 59 60 61 62
   */
  void insert(Fasta& input, const string& label="");

  /**
   * @param input: A list of FASTA files
   * @param label: label that must be associated to the given files
63
   * @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
64 65 66 67 68 69 70 71
   */
  void insert(list<Fasta>& input, const string& label="");
  
  /**
   * @param input: A sequence to be cut in k-mers
   * @param label: label that must be associated to the given files
   * @post All the k-mers in the sequence have been indexed.
   */
72
  void insert(const seqtype &sequence,
73 74
              const string &label,
              bool ignore_extended_nucleotides=true);
Mikaël Salson's avatar
Mikaël Salson committed
75 76 77 78 79

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

82 83 84 85 86
  /**
   * @return the percentage of kmers that are set in the index
   */
  float getIndexLoad() const;

Mikaël Salson's avatar
Mikaël Salson committed
87 88 89 90 91 92 93 94 95 96
  /**
   * @return the value of k
   */
  int getK() const;

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

97 98 99 100 101
  /**
   * @return the seed used
   */
  string getSeed() const;

Mikaël Salson's avatar
Mikaël Salson committed
102 103 104 105 106 107 108
  /**
   * @param seq: a sequence
   * @param no_revcomp: force not to revcomp the sequence, even if
   *                    the index was built with revcomp.
   * @return a vector of length seq.length() - getK() + 1 containing
   * for each k-mer the corresponding value in the index.
   */
109
  virtual vector<T> getResults(const seqtype &seq, bool no_revcomp=false) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
110 111 112 113 114 115 116 117 118 119 120 121

  /**
   * @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
   */
122
  virtual T& operator[](seqtype& word) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
123 124 125 126 127 128 129
};


template <class T> 
class MapKmerStore : public IKmerStore<T>
{
public:	
130
  map<seqtype, T> store;
Mikaël Salson's avatar
Mikaël Salson committed
131 132 133 134 135 136 137

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

  vector<T> getResults(const seqtype &seq, bool no_revcomp=false);
140 141
  T& get(seqtype &word);
  T& operator[](seqtype & word);
142 143 144

 private:
  void init();
Mikaël Salson's avatar
Mikaël Salson committed
145 146 147 148 149 150 151
};

template <class T> 
class ArrayKmerStore : public IKmerStore<T>
{
  T* store;
	
152
  int index(const seqtype& word) const;
153 154 155 156 157 158 159 160

  /**
   * 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
161 162 163 164 165 166 167 168
public:
  /**
   * @param bool: if true, will also index revcomp
   * @param seed: the seed
   */
  ArrayKmerStore(string seed, bool=false);
  ArrayKmerStore(int k, bool=false);
  ~ArrayKmerStore();
169 170

  vector<T> getResults(const seqtype &seq, bool no_revcomp=false);	
171 172
  T& get(seqtype &word);
  T& operator[](seqtype & word);
173
  T& operator[](int word);
Mikaël Salson's avatar
Mikaël Salson committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
};


// IKmerStore

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

template<class T> 
void IKmerStore<T>::insert(list<Fasta>& input,
                           const string &label){
  for(list<Fasta>::iterator it = input.begin() ; it != input.end() ; it++){
    insert(*it, label);
  }
}

template<class T> 
void IKmerStore<T>::insert(Fasta& input,
                           const string &label){
  for (int r = 0; r < input.size(); r++) {
    insert(input.sequence(r), label);
  }
196

197
  labels.push_back(make_pair(T(label, 1), label)) ;
Mikaël Salson's avatar
Mikaël Salson committed
198 199 200
}

template<class T> 
201
void IKmerStore<T>::insert(const seqtype &sequence,
202 203
                           const string &label,
                           bool ignore_extended_nucleotides){
Mikaël Salson's avatar
Mikaël Salson committed
204
  for(size_t i = 0 ; i + s < sequence.length() + 1 ; i++) {
205
    seqtype kmer = spaced(sequence.substr(i, s), seed);
206

207
    if (ignore_extended_nucleotides && has_extended_nucleotides(kmer))
208 209
      continue;

Mikaël Salson's avatar
Mikaël Salson committed
210 211
    int strand = 1;
    if (revcomp_indexed && T::hasRevcompSymetry()) {
212
      seqtype rc_kmer = revcomp(kmer);
Mikaël Salson's avatar
Mikaël Salson committed
213 214 215 216 217
      if (rc_kmer.compare(kmer) < 0) {
        strand = -1;
        kmer = rc_kmer;
      }
    }
218 219 220 221 222
    T &this_kmer = this->get(kmer);
    if (this_kmer.isNull()) {
      nb_kmers_inserted++;
    }
    this_kmer += T(label, strand);
Mikaël Salson's avatar
Mikaël Salson committed
223
    if (revcomp_indexed && ! T::hasRevcompSymetry()) {
224
      seqtype rc_kmer = revcomp(kmer);
225 226 227 228
      T &this_rc_kmer = this->get(rc_kmer);
      if (this_rc_kmer.isNull())
        nb_kmers_inserted++;
      this_rc_kmer += T(label, -1);
Mikaël Salson's avatar
Mikaël Salson committed
229 230 231
    }
  }
}
232 233 234 235 236

template<class T>
float IKmerStore<T>::getIndexLoad() const {
  return nb_kmers_inserted*1. / (1 << (2 * k));
}
Mikaël Salson's avatar
Mikaël Salson committed
237 238 239 240 241 242 243 244 245 246 247

template<class T>
int IKmerStore<T>::getK() const {
  return k;
}

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

248 249 250 251 252
template<class T>
string IKmerStore<T>::getSeed() const {
  return seed;
}

253 254

// .getResults()
Mikaël Salson's avatar
Mikaël Salson committed
255
template<class T>
256 257 258 259
vector<T> MapKmerStore<T>::getResults(const seqtype &seq, bool no_revcomp) {

  int s = IKmerStore<T>::getS();

Mikaël Salson's avatar
Mikaël Salson committed
260 261 262 263 264
  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++) {
265
    seqtype kmer = spaced(seq.substr(i, s), IKmerStore<T>::seed);
266
    //    seqtype kmer = seq.substr(i, s);
Mikaël Salson's avatar
Mikaël Salson committed
267
    // cout << kmer << endl << kmer0 << endl << endl ;
268
    if (IKmerStore<T>::revcomp_indexed && no_revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
269 270 271 272 273 274 275 276
      result[i] = get(kmer);
    } else {
      result[i] = (*this)[kmer];
    }
  }
  return result;
}

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
template<class T>
vector<T> ArrayKmerStore<T>::getResults(const seqtype &seq, bool no_revcomp) {
  
  int s = IKmerStore<T>::getS();

  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++)
    {
293
      intseq[i] = nuc_to_int(seq[i]);
294 295 296 297 298 299 300 301 302
    }

  /* Compute results */
  for (size_t i=0; (int) i+s < N+1; i++) {
    int kmer = spaced_int(intseq + i, IKmerStore<T>::seed);
    if (IKmerStore<T>::revcomp_indexed && no_revcomp) {
      result[i] = store[kmer]; // getfromint(kmer); // store[kmer];
      // cout << i << "/" << N << "  " << kmer << result[i] << endl ;
    } else {
303
      result[i] = (*this)[kmer]; // Deals with revcomp
304 305 306 307 308 309 310
    }
  }

  delete[] intseq ;
  return result;
}

Mikaël Salson's avatar
Mikaël Salson committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

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

// MapKmerStore

template <class T>
MapKmerStore<T>::MapKmerStore(string seed, bool revcomp){
  this->seed = seed;   
  int k = seed_weight(seed);
  this->k = k;
  this->s = seed.size();
  this->revcomp_indexed = revcomp;
326
  init();
Mikaël Salson's avatar
Mikaël Salson committed
327 328 329 330 331 332 333 334
}

template <class T>
MapKmerStore<T>::MapKmerStore(int k, bool revcomp){
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
335 336 337 338 339 340
  init();
}

template <class T>
void MapKmerStore<T>::init() {
  this->nb_kmers_inserted = 0;
Mikaël Salson's avatar
Mikaël Salson committed
341 342 343
}

template <class T> 
344
T& MapKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
345 346 347 348
  return store[word];
}

template <class T> 
349
T& MapKmerStore<T>::operator[](seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
350
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
351
    seqtype rc_kmer = revcomp(word);
Mikaël Salson's avatar
Mikaël Salson committed
352 353 354 355 356 357 358 359 360
    if (rc_kmer.compare(word) < 0)
      word = rc_kmer;
  }
  return store[word];
}

// ArrayKmerStore

template <class T> 
361
ArrayKmerStore<T>::ArrayKmerStore(int k, bool revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
362 363 364 365
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
366
  init();
Mikaël Salson's avatar
Mikaël Salson committed
367 368 369 370 371 372 373 374 375 376
}


template <class T> 
ArrayKmerStore<T>::ArrayKmerStore(string seed, bool revcomp){
  this->seed = seed; 
  int k = seed_weight(seed);
  this->k = k;
  this->s = seed.size();
  this->revcomp_indexed = revcomp;
377 378 379 380 381
  init();
}

template <class T>
void ArrayKmerStore<T>::init() {
382
  this->nb_kmers_inserted = 0;
383
  if ((size_t)(this->k << 1) >= sizeof(int) * 8)
Mikaël Salson's avatar
Mikaël Salson committed
384
    throw std::bad_alloc();
385
  store = new T[(unsigned int)1 << (this->k << 1)];
Mikaël Salson's avatar
Mikaël Salson committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399
  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> 
400
int ArrayKmerStore<T>::index(const seqtype& word) const{
Mikaël Salson's avatar
Mikaël Salson committed
401
  return dna_to_int(word, this->k);
Mikaël Salson's avatar
Mikaël Salson committed
402 403 404
}

template <class T> 
405
T& ArrayKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
406 407 408 409
  return store[index(word)];
}

template <class T> 
410
T& ArrayKmerStore<T>::operator[](seqtype& word){
411 412 413 414 415
  return (*this)[index(word)];
}

template <class T> 
T& ArrayKmerStore<T>::operator[](int word){
Mikaël Salson's avatar
Mikaël Salson committed
416
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
417 418
    int rc_kmer = revcomp_int(word, IKmerStore<T>::k);
    if (rc_kmer < word)
Mikaël Salson's avatar
Mikaël Salson committed
419 420
      word = rc_kmer;
  }
421
  return store[word];
Mikaël Salson's avatar
Mikaël Salson committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
}


/**
 * 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){
443
    cout << "  (using a MapKmer to fit into memory)" << endl;
Mikaël Salson's avatar
Mikaël Salson committed
444 445 446 447 448 449 450 451 452 453 454
    index = new MapKmerStore<T>(seed, revcomp);
  }
  return index;
}

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

#endif