kmerstore.h 9.55 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
  Kmer &operator+=(const Kmer &);
  static bool hasRevcompSymetry();
} ;
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 ;

public:

  virtual ~IKmerStore();

45 46
  list< pair <T, string> > labels;

Mikaël Salson's avatar
Mikaël Salson committed
47 48 49
  /**
   * @param input: A single FASTA file
   * @param label: label that must be associated to the given files
50
   * @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
51 52 53 54 55 56
   */
  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
57
   * @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
58 59 60 61 62 63 64 65
   */
  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.
   */
66
  void insert(const seqtype &sequence,
Mikaël Salson's avatar
Mikaël Salson committed
67 68 69 70 71 72
              const string &label);

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

  /**
   * @return the value of k
   */
  int getK() const;

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

85 86 87 88 89
  /**
   * @return the seed used
   */
  string getSeed() const;

Mikaël Salson's avatar
Mikaël Salson committed
90 91 92 93 94 95 96
  /**
   * @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.
   */
97
  virtual vector<T> getResults(const seqtype &seq, bool no_revcomp=false) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
98 99 100 101 102 103 104 105 106 107 108 109

  /**
   * @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
   */
110
  virtual T& operator[](seqtype& word) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
111 112 113 114 115 116 117
};


template <class T> 
class MapKmerStore : public IKmerStore<T>
{
public:	
118
  map<seqtype, T> store;
Mikaël Salson's avatar
Mikaël Salson committed
119 120 121 122 123 124 125

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

  vector<T> getResults(const seqtype &seq, bool no_revcomp=false);
128 129
  T& get(seqtype &word);
  T& operator[](seqtype & word);
Mikaël Salson's avatar
Mikaël Salson committed
130 131 132 133 134 135 136
};

template <class T> 
class ArrayKmerStore : public IKmerStore<T>
{
  T* store;
	
137
  int index(const seqtype& word) const;
138 139 140 141 142 143 144 145

  /**
   * 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
146 147 148 149 150 151 152 153
public:
  /**
   * @param bool: if true, will also index revcomp
   * @param seed: the seed
   */
  ArrayKmerStore(string seed, bool=false);
  ArrayKmerStore(int k, bool=false);
  ~ArrayKmerStore();
154 155

  vector<T> getResults(const seqtype &seq, bool no_revcomp=false);	
156 157
  T& get(seqtype &word);
  T& operator[](seqtype & word);
158
  T& operator[](int word);
Mikaël Salson's avatar
Mikaël Salson committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
};


// 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);
  }
181

182
  labels.push_back(make_pair(T(label, 1), label)) ;
Mikaël Salson's avatar
Mikaël Salson committed
183 184 185
}

template<class T> 
186
void IKmerStore<T>::insert(const seqtype &sequence,
Mikaël Salson's avatar
Mikaël Salson committed
187 188
                           const string &label){
  for(size_t i = 0 ; i + s < sequence.length() + 1 ; i++) {
189
    seqtype kmer = spaced(sequence.substr(i, s), seed);
190 191 192 193

    if (has_extended_nucleotides(kmer))
      continue;

Mikaël Salson's avatar
Mikaël Salson committed
194 195
    int strand = 1;
    if (revcomp_indexed && T::hasRevcompSymetry()) {
196
      seqtype rc_kmer = revcomp(kmer);
Mikaël Salson's avatar
Mikaël Salson committed
197 198 199 200 201
      if (rc_kmer.compare(kmer) < 0) {
        strand = -1;
        kmer = rc_kmer;
      }
    }
202
    this->get(kmer) += T(label, strand);
Mikaël Salson's avatar
Mikaël Salson committed
203
    if (revcomp_indexed && ! T::hasRevcompSymetry()) {
204
      seqtype rc_kmer = revcomp(kmer);
205
      this->get(rc_kmer) += T(label, -1);
Mikaël Salson's avatar
Mikaël Salson committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
    }
  }
}
  

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

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

221 222 223 224 225
template<class T>
string IKmerStore<T>::getSeed() const {
  return seed;
}

226 227

// .getResults()
Mikaël Salson's avatar
Mikaël Salson committed
228
template<class T>
229 230 231 232
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
233 234 235 236 237
  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++) {
238
    seqtype kmer = spaced(seq.substr(i, s), IKmerStore<T>::seed);
239
    //    seqtype kmer = seq.substr(i, s);
Mikaël Salson's avatar
Mikaël Salson committed
240
    // cout << kmer << endl << kmer0 << endl << endl ;
241
    if (IKmerStore<T>::revcomp_indexed && no_revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
242 243 244 245 246 247 248 249
      result[i] = get(kmer);
    } else {
      result[i] = (*this)[kmer];
    }
  }
  return result;
}

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
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++)
    {
266
      intseq[i] = nuc_to_int(seq[i]);
267 268 269 270 271 272 273 274 275
    }

  /* 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 {
276
      result[i] = (*this)[kmer]; // Deals with revcomp
277 278 279 280 281 282 283
    }
  }

  delete[] intseq ;
  return result;
}

Mikaël Salson's avatar
Mikaël Salson committed
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

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;
}

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;
}

template <class T> 
310
T& MapKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
311 312 313 314
  return store[word];
}

template <class T> 
315
T& MapKmerStore<T>::operator[](seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
316
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
317
    seqtype rc_kmer = revcomp(word);
Mikaël Salson's avatar
Mikaël Salson committed
318 319 320 321 322 323 324 325 326
    if (rc_kmer.compare(word) < 0)
      word = rc_kmer;
  }
  return store[word];
}

// ArrayKmerStore

template <class T> 
327
ArrayKmerStore<T>::ArrayKmerStore(int k, bool revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
328 329 330 331
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
332
  init();
Mikaël Salson's avatar
Mikaël Salson committed
333 334 335 336 337 338 339 340 341 342
}


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;
343 344 345 346 347 348
  init();
}

template <class T>
void ArrayKmerStore<T>::init() {
  if ((size_t)(this->k << 1) >= sizeof(int) * 8)
Mikaël Salson's avatar
Mikaël Salson committed
349
    throw std::bad_alloc();
350
  store = new T[(unsigned int)1 << (this->k << 1)];
Mikaël Salson's avatar
Mikaël Salson committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364
  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> 
365
int ArrayKmerStore<T>::index(const seqtype& word) const{
Mikaël Salson's avatar
Mikaël Salson committed
366
  return dna_to_int(word, this->k);
Mikaël Salson's avatar
Mikaël Salson committed
367 368 369
}

template <class T> 
370
T& ArrayKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
371 372 373 374
  return store[index(word)];
}

template <class T> 
375
T& ArrayKmerStore<T>::operator[](seqtype& word){
376 377 378 379 380
  return (*this)[index(word)];
}

template <class T> 
T& ArrayKmerStore<T>::operator[](int word){
Mikaël Salson's avatar
Mikaël Salson committed
381
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
382 383
    int rc_kmer = revcomp_int(word, IKmerStore<T>::k);
    if (rc_kmer < word)
Mikaël Salson's avatar
Mikaël Salson committed
384 385
      word = rc_kmer;
  }
386
  return store[word];
Mikaël Salson's avatar
Mikaël Salson committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
}


/**
 * 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){
408
    cout << "  (using a MapKmer to fit into memory)" << endl;
Mikaël Salson's avatar
Mikaël Salson committed
409 410 411 412 413 414 415 416 417 418 419
    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