kmerstore.h 9.81 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 45 46 47 48 49
} ;
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();

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

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

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

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

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

91 92 93 94 95
  /**
   * @return the seed used
   */
  string getSeed() const;

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

  /**
   * @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
   */
116
  virtual T& operator[](seqtype& word) = 0;
Mikaël Salson's avatar
Mikaël Salson committed
117 118 119 120 121 122 123
};


template <class T> 
class MapKmerStore : public IKmerStore<T>
{
public:	
124
  map<seqtype, T> store;
Mikaël Salson's avatar
Mikaël Salson committed
125 126 127 128 129 130 131

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

  vector<T> getResults(const seqtype &seq, bool no_revcomp=false);
134 135
  T& get(seqtype &word);
  T& operator[](seqtype & word);
Mikaël Salson's avatar
Mikaël Salson committed
136 137 138 139 140 141 142
};

template <class T> 
class ArrayKmerStore : public IKmerStore<T>
{
  T* store;
	
143
  int index(const seqtype& word) const;
144 145 146 147 148 149 150 151

  /**
   * 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
152 153 154 155 156 157 158 159
public:
  /**
   * @param bool: if true, will also index revcomp
   * @param seed: the seed
   */
  ArrayKmerStore(string seed, bool=false);
  ArrayKmerStore(int k, bool=false);
  ~ArrayKmerStore();
160 161

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


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

188
  labels.push_back(make_pair(T(label, 1), label)) ;
Mikaël Salson's avatar
Mikaël Salson committed
189 190 191
}

template<class T> 
192
void IKmerStore<T>::insert(const seqtype &sequence,
193 194
                           const string &label,
                           bool ignore_extended_nucleotides){
Mikaël Salson's avatar
Mikaël Salson committed
195
  for(size_t i = 0 ; i + s < sequence.length() + 1 ; i++) {
196
    seqtype kmer = spaced(sequence.substr(i, s), seed);
197

198
    if (ignore_extended_nucleotides && has_extended_nucleotides(kmer))
199 200
      continue;

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

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

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

228 229 230 231 232
template<class T>
string IKmerStore<T>::getSeed() const {
  return seed;
}

233 234

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

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
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++)
    {
273
      intseq[i] = nuc_to_int(seq[i]);
274 275 276 277 278 279 280 281 282
    }

  /* 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 {
283
      result[i] = (*this)[kmer]; // Deals with revcomp
284 285 286 287 288 289 290
    }
  }

  delete[] intseq ;
  return result;
}

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

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> 
317
T& MapKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
318 319 320 321
  return store[word];
}

template <class T> 
322
T& MapKmerStore<T>::operator[](seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
323
  if (this->isRevcomp() && T::hasRevcompSymetry()) {
324
    seqtype rc_kmer = revcomp(word);
Mikaël Salson's avatar
Mikaël Salson committed
325 326 327 328 329 330 331 332 333
    if (rc_kmer.compare(word) < 0)
      word = rc_kmer;
  }
  return store[word];
}

// ArrayKmerStore

template <class T> 
334
ArrayKmerStore<T>::ArrayKmerStore(int k, bool revcomp) {
Mikaël Salson's avatar
Mikaël Salson committed
335 336 337 338
  this->seed = seed_contiguous(k);
  this->k = k;
  this->s = k;
  this->revcomp_indexed = revcomp;
339
  init();
Mikaël Salson's avatar
Mikaël Salson committed
340 341 342 343 344 345 346 347 348 349
}


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;
350 351 352 353 354 355
  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
356
    throw std::bad_alloc();
357
  store = new T[(unsigned int)1 << (this->k << 1)];
Mikaël Salson's avatar
Mikaël Salson committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371
  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> 
372
int ArrayKmerStore<T>::index(const seqtype& word) const{
Mikaël Salson's avatar
Mikaël Salson committed
373
  return dna_to_int(word, this->k);
Mikaël Salson's avatar
Mikaël Salson committed
374 375 376
}

template <class T> 
377
T& ArrayKmerStore<T>::get(seqtype& word){
Mikaël Salson's avatar
Mikaël Salson committed
378 379 380 381
  return store[index(word)];
}

template <class T> 
382
T& ArrayKmerStore<T>::operator[](seqtype& word){
383 384 385 386 387
  return (*this)[index(word)];
}

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


/**
 * 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){
415
    cout << "  (using a MapKmer to fit into memory)" << endl;
Mikaël Salson's avatar
Mikaël Salson committed
416 417 418 419 420 421 422 423 424 425 426
    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