smithlab_utils.hpp

/*
 *    Part of SMITHLAB software
 *
 *    Copyright (C) 2008 Cold Spring Harbor Laboratory,
 *                       University of Southern California and
 *                       Andrew D. Smith
 *
 *    Authors: Andrew D. Smith
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SMITHLAB_UTILS_HPP
#define SMITHLAB_UTILS_HPP

#include <algorithm>
#include <cctype>
#include <cmath>
#include <cstddef>
#include <iterator>
#include <sstream>
#include <string>
#include <vector>

extern "C" {
char have_smithlab_cpp();
}

namespace smithlab {
template <class In, class Out, class Pred>
Out copy_if(In first, In last, Out res, Pred p) {
  while (first != last) {
    if (p(*first))
      *res++ = *first;
    ++first;
  }
  return res;
}
} // namespace smithlab

typedef size_t MASK_t;

namespace smithlab {

// Code dealing with false discovery rate
double get_fdr_cutoff(const size_t n_tests, std::vector<double> &pvals,
                      const double alpha);

void correct_pvals(const size_t n_tests, std::vector<double> &pvals);

// Assumes 4 nucleotide DNA alphabet
static const size_t alphabet_size = 4;

std::vector<std::string> split(std::string, const char *,
                               bool get_empty_fields = false);
std::vector<std::string> split_whitespace_quoted(std::string to_split);
void split_whitespace(const std::string &s, std::vector<std::string> &v);

std::string strip(const std::string &s);

std::vector<std::string> squash(const std::vector<std::string> &v);

template <class T> std::string toa(T t) {
  std::ostringstream s;
  s << t;
  return s.str();
}
double log_sum_log_vec(const std::vector<double> &vals, size_t lim);

template <class FwrdItr> double log_sum_log(FwrdItr first, FwrdItr last) {
  const auto max_itr = std::max_element(first, last);
  const double max_val = *max_itr;
  double sum = 1.0;
  for (auto itr = first; itr != last; ++itr)
    sum += (itr == max_itr ? 0.0 : std::exp(*itr - max_val));
  return max_val + std::log(sum);
}
inline double log_sum_log(const double p, const double q) {
  if (p == 0) {
    return q;
  }
  else if (q == 0) {
    return p;
  }
  const double larger = (p > q) ? p : q;
  return larger + log(1.0 + exp((p > q ? q : p) - larger));
}

inline double log_sum_log(const double p, const double q, const double r) {
  return log_sum_log(log_sum_log(p, q), r);
}
} // namespace smithlab

namespace smithlab_bits {
static const MASK_t low_bit = 1ul;
static const MASK_t high_bit = static_cast<size_t>(0x8000000000000000ul);
static const MASK_t all_ones = static_cast<size_t>(-1);
static const MASK_t all_zeros = 0ul;
static const size_t word_size = 64ul;
} // namespace smithlab_bits

inline size_t base2int_upper_only(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 1;
  case 'G':
    return 2;
  case 'T':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 1;
  case 'G':
    return 2;
  case 'T':
    return 3;
  case 'a':
    return 0;
  case 'c':
    return 1;
  case 'g':
    return 2;
  case 't':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int_bs_upper_only(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 3;
  case 'G':
    return 2;
  case 'T':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int_bs(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 3;
  case 'G':
    return 2;
  case 'T':
    return 3;
  case 'a':
    return 0;
  case 'c':
    return 3;
  case 'g':
    return 2;
  case 't':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int_bs_ag_upper_only(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 1;
  case 'G':
    return 0;
  case 'T':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int_bs_ag(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 1;
  case 'G':
    return 0;
  case 'T':
    return 3;
  case 'a':
    return 0;
  case 'c':
    return 1;
  case 'g':
    return 0;
  case 't':
    return 3;
  default:
    return 4;
  }
}

inline size_t base2int_bs_rc(char c) {
  switch (c) {
  case 'A':
    return 0;
  case 'C':
    return 1;
  case 'G':
    return 0;
  case 'T':
    return 3;
  case 'a':
    return 0;
  case 'c':
    return 1;
  case 'g':
    return 0;
  case 't':
    return 3;
  }
  return 4;
}

inline size_t base2int_rc(char c) {
  switch (c) {
  case 'A':
    return 3;
  case 'C':
    return 2;
  case 'G':
    return 1;
  case 'T':
    return 0;
  case 'a':
    return 3;
  case 'c':
    return 2;
  case 'g':
    return 1;
  case 't':
    return 0;
  }
  return 4;
}

inline char int2base(size_t c) {
  switch (c) {
  case 0:
    return 'A';
  case 1:
    return 'C';
  case 2:
    return 'G';
  case 3:
    return 'T';
  }
  return 'N';
}

inline char int2base_rc(size_t c) {
  switch (c) {
  case 3:
    return 'A';
  case 2:
    return 'C';
  case 1:
    return 'G';
  case 0:
    return 'T';
  }
  return 'N';
}

inline bool isvalid(char c) { return (base2int(c) != 4); }

inline std::string i2mer(size_t n, size_t index) {
  std::string s(n, ' ');
  do {
    --n;
    s[n] = int2base(index % smithlab::alphabet_size);
    index /= smithlab::alphabet_size;
  } while (n > 0);
  return s;
}

inline std::string i2mer_rc(size_t n, size_t index) {
  std::string s(n, ' ');
  do {
    --n;
    s[n] = int2base_rc(index % smithlab::alphabet_size);
    index /= smithlab::alphabet_size;
  } while (n > 0);
  return s;
}

inline size_t mer2i(const std::string::const_iterator a,
                    std::string::const_iterator b) {
  size_t multiplier = 1, index = 0;
  do {
    --b;
    index += base2int(*b) * multiplier;
    multiplier *= smithlab::alphabet_size;
  } while (b > a);
  return index;
}

inline size_t mer2i_rc(std::string::const_iterator a,
                       const std::string::const_iterator b) {
  size_t multiplier = 1, index = 0;
  do {
    index += base2int_rc(*a) * multiplier;
    multiplier *= smithlab::alphabet_size;
  } while (++a < b);
  return index;
}

template <class T> std::string toa(T t) {
  std::ostringstream s;
  s << t;
  return s.str();
}

////////////////////////////////////////////////////////////////////////
// Code for dealing with the DNA alphabet

char complement(int i);

inline std::string revcomp(const std::string &s) {
  std::string r;
  std::transform(s.begin(), s.end(), back_inserter(r), complement);
  std::reverse(r.begin(), r.end());
  return r;
}

inline void revcomp_inplace(std::string &s) {
  std::transform(s.begin(), s.end(), s.begin(), complement);
  std::reverse(s.begin(), s.end());
}

inline void revcomp_inplace(std::string::iterator first,
                            std::string::iterator last) {
  std::transform(first, last, first, complement);
  std::reverse(first, last);
}

inline std::string bits2string_masked(size_t mask, size_t bits) {
  std::string s;
  size_t selector = smithlab_bits::high_bit;
  for (size_t i = 0; i < smithlab_bits::word_size; ++i) {
    s += (selector & bits & mask) ? '1' : '0';
    selector >>= 1;
  }
  return s;
}

inline std::string bits2string_for_positions(size_t positions, size_t bits) {
  std::string s;
  size_t selector = smithlab_bits::high_bit;
  for (size_t i = 0; i < smithlab_bits::word_size; ++i) {
    s += (selector & bits) ? '1' : '0';
    selector >>= 1;
  }
  return s.substr(s.length() - positions);
}

inline size_t percent(const size_t a, const size_t b) {
  return static_cast<size_t>((100.0 * a) / b);
}

inline bool valid_base(char c) {
  char i = std::toupper(c);
  return (i == 'A' || i == 'C' || i == 'G' || i == 'T');
}

inline size_t mer2index(const char *s, size_t n) {
  size_t multiplier = 1, index = 0;
  do {
    --n;
    index += base2int(s[n]) * multiplier;
    multiplier *= smithlab::alphabet_size;
  } while (n > 0);
  return index;
}

inline size_t kmer_counts(const std::vector<std::string> &seqs,
                          std::vector<size_t> &counts, size_t k) {
  counts.clear();
  size_t nwords = static_cast<size_t>(
      pow(static_cast<float>(smithlab::alphabet_size), static_cast<int>(k)));
  counts.resize(nwords, 0);
  size_t total = 0;
  for (size_t i = 0; i < seqs.size(); ++i) {
    std::vector<char> seq(seqs[i].length() + 1, '\0');
    auto seq_data = seq.data();
    copy(cbegin(seqs[i]), cend(seqs[i]), seq_data);
    for (size_t j = 0; j < seqs[i].length() - k + 1; ++j)
      if (std::count_if(seq_data + j, seq_data + j + k, &valid_base) ==
          static_cast<int>(k)) {
        counts[mer2index(seq_data + j, k)]++;
        ++total;
      }
  }
  return total;
}

/*
 * How to use the ProgressBar:
 *
 * //====================================
 * const uint64_t lim = v.size();
 * ProgressBar progress(lim);
 * if (VERBOSE)
 *   progress.report(cerr, 0);
 * for (uint64_t i = 0; i < lim; ++i) {
 *   if (VERBOSE && progress.time_to_report(i))
 *     progress.report(cerr, i);
 *   v[i] += x;
 *  }
 * if (VERBOSE)
 *   progress.report(cerr, lim);
 */
class ProgressBar {
public:
  ProgressBar(const size_t x, const std::string message = "completion")
      : total(x), prev(0), mid_tag(message) {
    // the 3 below is for the default left_tag and right_tag printed
    // width and the 5 is for the width of the percent (up to 100)
    // plus two pipes ('|')
    bar_width = max_bar_width - message.length() - 3 - 5;
    bar = std::string(bar_width, ' ');
  }
  bool time_to_report(const size_t i) const {
    return std::round((100.0 * std::min(i, total)) / total) > prev;
  }
  void report(std::ostream &out, const size_t i);

private:
  size_t total{};
  size_t prev{};
  size_t bar_width{};
  std::string left_tag = "\r[";
  std::string mid_tag;
  std::string bar;
  std::string right_tag = "%]";

  static const size_t max_bar_width = 72;
};

extern char to_valid_five_letter[256];

#endif