alg/sequence.cpp

   1 //  This file is part of the Mussa source distribution.
   2 //  http://mussa.caltech.edu/
   3 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
   4
   5 // This program and all associated source code files are Copyright (C) 2005
   6 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
   7 // under the GNU Public License; please see the included LICENSE.txt
   8 // file for more information, or contact Tristan directly.
   9
  10
  11 //  This file is part of the Mussa source distribution.
  12 //  http://mussa.caltech.edu/
  13 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
  14
  15 // This program and all associated source code files are Copyright (C) 2005
  16 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
  17 // under the GNU Public License; please see the included LICENSE.txt
  18 // file for more information, or contact Tristan directly.
  19
  20
  21 //                        ----------------------------------------
  22 //                           ---------- sequence.cc -----------
  23 //                        ----------------------------------------
  24 #include <boost/filesystem/fstream.hpp>
  25 namespace fs = boost::filesystem;
  26
  27 #include <boost/spirit/core.hpp>
  28 #include <boost/spirit/actor/push_back_actor.hpp>
  29 #include <boost/spirit/iterator/file_iterator.hpp>
  30 #include <boost/spirit/utility/chset.hpp>
  31 namespace spirit = boost::spirit;
  32
  33 #include "alg/sequence.hpp"
  34 #include "mussa_exceptions.hpp"
  35
  36 #include <string>
  37 #include <stdexcept>
  38 #include <iostream>
  39 #include <sstream>
  40 #include <set>
  41
  42 annot::annot()
  43  : begin(0),
  44    end(0),
  45    type(""),
  46    name("")
  47 {
  48 }
  49
  50 annot::annot(int begin, int end, std::string type, std::string name)
  51  : begin(begin),
  52    end(end),
  53    type(type),
  54    name(name)
  55 {
  56 }
  57
  58 annot::~annot()
  59 {
  60 }
  61
  62 bool operator==(const annot& left, const annot& right)
  63 {
  64   return ((left.begin== right.begin) and
  65           (left.end == right.end) and
  66           (left.type == right.type) and
  67           (left.name == right.name));
  68 }
  69
  70 motif::motif(int begin, std::string motif)
  71  : annot(begin, begin+motif.size(), "motif", motif),
  72    sequence(motif)
  73 {
  74 }
  75
  76 motif::~motif()
  77 {
  78 }
  79
  80
  81 Sequence::Sequence(alphabet_ref alphabet_)
  82   : parent(0),
  83     alphabet(alphabet_),
  84     seq_start(0),
  85     seq_count(0),
  86     strand(UnknownStrand)
  87 {
  88 }
  89
  90 Sequence::~Sequence()
  91 {
  92 }
  93
  94 Sequence::Sequence(const char *seq, alphabet_ref alphabet_)
  95   : parent(0),
  96     alphabet(alphabet_),
  97     seq_start(0),
  98     seq_count(0),
  99     strand(UnknownStrand),
 100     header(""),
 101     species("")
 102 {
 103   set_filtered_sequence(seq, alphabet);
 104 }
 105
 106 Sequence::Sequence(const std::string& seq, alphabet_ref alphabet_)
 107   : parent(0),
 108     alphabet(alphabet_),
 109     seq_start(0),
 110     seq_count(0),
 111     strand(UnknownStrand),
 112     header(""),
 113     species("")
 114 {
 115   set_filtered_sequence(seq, alphabet);
 116 }
 117
 118 Sequence::Sequence(const Sequence& o)
 119   : parent(o.parent),
 120     seq(o.seq),
 121     alphabet(o.alphabet),
 122     seq_start(o.seq_start),
 123     seq_count(o.seq_count),
 124     strand(o.strand),
 125     header(o.header),
 126     species(o.species),
 127     annots(o.annots),
 128     motif_list(o.motif_list)
 129 {
 130 }
 131
 132 Sequence &Sequence::operator=(const Sequence& s)
 133 {
 134   if (this != &s) {
 135     parent = s.parent;
 136     seq = s.seq;
 137     alphabet = s.alphabet;
 138     seq_start = s.seq_start;
 139     seq_count = s.seq_count;
 140     strand = s.strand;
 141     header = s.header;
 142     species = s.species;
 143     annots = s.annots;
 144     motif_list = s.motif_list;
 145   }
 146   return *this;
 147 }
 148
 149 static void multiplatform_getline(std::istream& in, std::string& line)
 150 {
 151   line.clear();
 152   char c;
 153   in.get(c);
 154   while(in.good() and !(c == '\012' or c == '\015') ) {
 155     line.push_back(c);
 156     in.get(c);
 157   }
 158   // if we have cr-lf eat it
 159   c = in.peek();
 160   if (c=='\012' or c == '\015') {
 161     in.get();
 162   }
 163 }
 164
 165 void Sequence::load_fasta(fs::path file_path, int seq_num, int start_index, int end_index)
 166 {
 167   load_fasta(file_path, alphabet, seq_num, start_index, end_index);
 168 }
 169
 170 //! load a fasta file into a sequence
 171 void Sequence::load_fasta(fs::path file_path, alphabet_ref a,
 172                           int seq_num, int start_index, int end_index)
 173 {
 174   fs::fstream data_file;
 175   data_file.open(file_path, std::ios::in);
 176
 177   if (!data_file.good())
 178   {
 179     throw mussa_load_error("Sequence File: "+file_path.string()+" not found");
 180   } else {
 181     try {
 182       load_fasta(data_file, a, seq_num, start_index, end_index);
 183     } catch(sequence_empty_error e) {
 184       // there doesn't appear to be any sequence
 185       // catch and rethrow to include the filename
 186       std::stringstream msg;
 187       msg << "The selected sequence in "
 188           << file_path.native_file_string()
 189           << " appears to be empty";
 190       throw sequence_empty_error(msg.str());
 191     } catch(sequence_empty_file_error e) {
 192       std::stringstream errormsg;
 193       errormsg << file_path.native_file_string()
 194                << " did not have any fasta sequences" << std::endl;
 195       throw sequence_empty_file_error(errormsg.str());
 196     } catch(sequence_invalid_load_error e) {
 197       std::ostringstream msg;
 198       msg << file_path.native_file_string();
 199       msg << " " << e.what();
 200       throw sequence_invalid_load_error(msg.str());
 201     }
 202   }
 203 }
 204
 205 void Sequence::load_fasta(std::istream& file,
 206                           int seq_num, int start_index, int end_index)
 207 {
 208   load_fasta(file, alphabet, seq_num, start_index, end_index);
 209 }
 210
 211 void
 212 Sequence::load_fasta(std::istream& data_file, alphabet_ref a,
 213                      int seq_num,
 214                      int start_index, int end_index)
 215 {
 216   std::string file_data_line;
 217   int header_counter = 0;
 218   size_t line_counter = 0;
 219   bool read_seq = true;
 220   std::string rev_comp;
 221   std::string sequence_raw;
 222   std::string seq_tmp;      // holds sequence during basic filtering
 223   const Alphabet &alpha = get_alphabet(a);
 224
 225   if (seq_num == 0) {
 226     throw mussa_load_error("fasta sequence number is 1 based (can't be 0)");
 227   }
 228
 229   // search for the header of the fasta sequence we want
 230   while ( (!data_file.eof()) && (header_counter < seq_num) )
 231   {
 232     multiplatform_getline(data_file, file_data_line);
 233     ++line_counter;
 234     if (file_data_line.substr(0,1) == ">")
 235       header_counter++;
 236   }
 237
 238   if (header_counter > 0) {
 239     header = file_data_line.substr(1);
 240
 241     sequence_raw = "";
 242
 243     while ( !data_file.eof() && read_seq ) {
 244       multiplatform_getline(data_file,file_data_line);
 245       ++line_counter;
 246       if (file_data_line.substr(0,1) == ">")
 247         read_seq = false;
 248       else {
 249         for (std::string::const_iterator line_i = file_data_line.begin();
 250              line_i != file_data_line.end();
 251              ++line_i)
 252          {
 253            if(alpha.exists(*line_i)) {
 254              sequence_raw += *line_i;
 255            } else {
 256             std::ostringstream msg;
 257             msg << "Unrecognized characters in fasta sequence at line ";
 258             msg << line_counter;
 259             throw sequence_invalid_load_error(msg.str());
 260            }
 261          }
 262       }
 263     }
 264
 265     // Lastly, if subselection of the sequence was specified we keep cut out
 266     // and only keep that part
 267     // end_index = 0 means no end was specified, so cut to the end
 268     if (end_index == 0)
 269       end_index = sequence_raw.size();
 270
 271     // sequence filtering for upcasing agctn and convert non AGCTN to N
 272     if (end_index-start_index <= 0) {
 273       std::string msg("The selected sequence appears to be empty");
 274       throw sequence_empty_error(msg);
 275     }
 276     set_filtered_sequence(sequence_raw, a, start_index, end_index-start_index);
 277   } else {
 278     std::string errormsg("There were no fasta sequences");
 279     throw sequence_empty_file_error(errormsg);
 280   }
 281 }
 282
 283 void Sequence::set_filtered_sequence(const std::string &in_seq,
 284                                      alphabet_ref alphabet_,
 285                                      size_type start,
 286                                      size_type count,
 287                                      strand_type strand_)
 288 {
 289   alphabet = alphabet_;
 290   if ( count == npos)
 291     count = in_seq.size() - start;
 292   boost::shared_ptr<seq_string> new_seq(new seq_string);
 293   new_seq->reserve(count);
 294
 295   // finally, the actual conversion loop
 296   const Alphabet& alpha_impl = get_alphabet(); // go get one of our actual alphabets
 297   std::string::const_iterator seq_i = in_seq.begin()+start;
 298   for(size_type i = 0; i != count; ++i, ++seq_i)
 299   {
 300     if (alpha_impl.exists(*seq_i)) {
 301       new_seq->append(1, toupper(*seq_i));
 302     } else {
 303       new_seq->append(1, 'N');
 304     }
 305   }
 306   parent = 0;
 307   seq = new_seq;
 308   seq_start = 0;
 309   seq_count = count;
 310   strand = strand_;
 311 }
 312
 313 void
 314 Sequence::load_annot(fs::path file_path, int start_index, int end_index)
 315 {
 316   fs::fstream data_stream(file_path, std::ios::in);
 317   if (!data_stream)
 318   {
 319     throw mussa_load_error("Sequence File: " + file_path.string() + " not found");
 320   }
 321
 322   // so i should probably be passing the parse function some iterators
 323   // but the annotations files are (currently) small, so i think i can
 324   // get away with loading the whole file into memory
 325   std::string data;
 326   char c;
 327   while(data_stream.good()) {
 328     data_stream.get(c);
 329     data.push_back(c);
 330   }
 331   data_stream.close();
 332
 333   parse_annot(data, start_index, end_index);
 334 }
 335
 336 /* If this works, yikes, this is some brain hurting code.
 337  *
 338  * what's going on is that when pb_annot is instantiated it stores references
 339  * to begin, end, name, type, declared in the parse function, then
 340  * when operator() is called it grabs values from those references
 341  * and uses that to instantiate an annot object and append that to our
 342  * annotation list.
 343  *
 344  * This weirdness is because the spirit library requires that actions
 345  * conform to a specific prototype operator()(IteratorT, IteratorT)
 346  * which doesn't provide any useful opportunity for me to actually
 347  * grab the results of our parsing.
 348  *
 349  * so I instantiate this structure in order to have a place to grab
 350  * my data from.
 351  */
 352
 353 struct push_back_annot {
 354   std::list<annot>& annot_list;
 355   int& begin;
 356   int& end;
 357   std::string& name;
 358   std::string& type;
 359   int &parsed;
 360
 361   push_back_annot(std::list<annot>& annot_list_,
 362                   int& begin_,
 363                   int& end_,
 364                   std::string& name_,
 365                   std::string& type_,
 366                   int &parsed_)
 367   : annot_list(annot_list_),
 368     begin(begin_),
 369     end(end_),
 370     name(name_),
 371     type(type_),
 372     parsed(parsed_)
 373   {
 374   }
 375
 376   void operator()(std::string::const_iterator,
 377                   std::string::const_iterator) const
 378   {
 379     //std::cout << "adding annot: " << begin << "|" << end << "|" << name << "|" << type << std::endl;
 380     annot_list.push_back(annot(begin, end, name, type));
 381     ++parsed;
 382   };
 383 };
 384
 385 struct push_back_seq {
 386   std::list<Sequence>& seq_list;
 387   std::string& name;
 388   std::string& seq;
 389   int &parsed;
 390
 391   push_back_seq(std::list<Sequence>& seq_list_,
 392                 std::string& name_,
 393                 std::string& seq_,
 394                 int &parsed_)
 395   : seq_list(seq_list_),
 396     name(name_),
 397     seq(seq_),
 398     parsed(parsed_)
 399   {
 400   }
 401
 402   void operator()(std::string::const_iterator,
 403                   std::string::const_iterator) const
 404   {
 405     // filter out newlines from our sequence
 406     std::string new_seq;
 407     for(std::string::const_iterator seq_i = seq.begin();
 408         seq_i != seq.end();
 409         ++seq_i)
 410     {
 411       if (*seq_i != '\015' && *seq_i != '\012') new_seq += *seq_i;
 412     }
 413     //std::cout << "adding seq: " << name << " " << new_seq << std::endl;
 414
 415     Sequence s(new_seq);
 416     s.set_fasta_header(name);
 417     seq_list.push_back(s);
 418     ++parsed;
 419   };
 420 };
 421
 422 void
 423 Sequence::parse_annot(std::string data, int start_index, int end_index)
 424 {
 425   int start=0;
 426   int end=0;
 427   std::string name;
 428   std::string type;
 429   std::string seq;
 430   std::list<annot> parsed_annots;
 431   std::list<Sequence> query_seqs;
 432   int parsed=1;
 433
 434   bool ok = spirit::parse(data.begin(), data.end(),
 435               (
 436                //begin grammar
 437                  !(
 438                     (
 439                       spirit::alpha_p >>
 440                       +(spirit::graph_p)
 441                     )[spirit::assign_a(species)] >>
 442                     +(spirit::space_p)
 443                   ) >>
 444                   *(
 445                      ( // ignore html tags
 446                        *(spirit::space_p) >>
 447                        spirit::ch_p('<') >>
 448                        +(~spirit::ch_p('>')) >>
 449                        spirit::ch_p('>') >>
 450                        *(spirit::space_p)
 451                      )
 452                    |
 453                     ( // parse an absolute location name
 454                      (spirit::uint_p[spirit::assign_a(start)] >>
 455                       +spirit::space_p >>
 456                       spirit::uint_p[spirit::assign_a(end)] >>
 457                       +spirit::space_p >>
 458                       (
 459                          spirit::alpha_p >>
 460                          *spirit::graph_p
 461                       )[spirit::assign_a(name)] >>
 462                       // optional type
 463                       !(
 464                           +spirit::space_p >>
 465                           (
 466                             spirit::alpha_p >>
 467                             *spirit::graph_p
 468                           )[spirit::assign_a(type)]
 469                       )
 470                       // to understand how this group gets set
 471                       // read the comment above struct push_back_annot
 472                      )[push_back_annot(parsed_annots, start, end, type, name, parsed)]
 473                    |
 474                     ((spirit::ch_p('>')|spirit::str_p("&gt;")) >>
 475                        (*(spirit::print_p))[spirit::assign_a(name)] >>
 476                        spirit::eol_p >>
 477                        (+(spirit::chset<>(Alphabet::nucleic_cstr)))[spirit::assign_a(seq)]
 478                      )[push_back_seq(query_seqs, name, seq, parsed)]
 479                     ) >>
 480                     *spirit::space_p
 481                    )
 482               //end grammar
 483               )).full;
 484   if (not ok) {
 485     std::stringstream msg;
 486     msg << "Error parsing annotation #" << parsed;
 487     throw annotation_load_error(msg.str());
 488   }
 489   // add newly parsed annotations to our sequence
 490   std::copy(parsed_annots.begin(), parsed_annots.end(), std::back_inserter(annots));
 491   // go seearch for query sequences
 492   find_sequences(query_seqs.begin(), query_seqs.end());
 493 }
 494
 495 void Sequence::add_annotation(const annot& a)
 496 {
 497   annots.push_back(a);
 498 }
 499
 500 const std::list<annot>& Sequence::annotations() const
 501 {
 502   return annots;
 503 }
 504
 505 Sequence
 506 Sequence::subseq(int start, int count)
 507 {
 508   if (!seq) {
 509     Sequence new_seq;
 510     return new_seq;
 511   }
 512
 513   // there might be an off by one error with start+count > size()
 514   if ( count == npos || start+count > size()) {
 515     count = size()-start;
 516   }
 517   Sequence new_seq(*this);
 518   new_seq.parent = this;
 519   new_seq.seq_start = seq_start+start;
 520   new_seq.seq_count = count;
 521
 522   new_seq.motif_list = motif_list;
 523   new_seq.annots.clear();
 524   // attempt to copy & reannotate position based annotations
 525   int end = start+count;
 526
 527   for(std::list<annot>::const_iterator annot_i = annots.begin();
 528       annot_i != annots.end();
 529       ++annot_i)
 530   {
 531     int annot_begin= annot_i->begin;
 532     int annot_end = annot_i->end;
 533
 534     if (annot_begin < end) {
 535       if (annot_begin >= start) {
 536         annot_begin -= start;
 537       } else {
 538         annot_begin = 0;
 539       }
 540
 541       if (annot_end < end) {
 542         annot_end -= start;
 543       } else {
 544         annot_end = count;
 545       }
 546
 547       annot new_annot(annot_begin, annot_end, annot_i->type, annot_i->name);
 548       new_seq.annots.push_back(new_annot);
 549     }
 550   }
 551
 552   return new_seq;
 553 }
 554
 555 std::string Sequence::create_reverse_map() const
 556 {
 557   std::string rc_map(256, '~');
 558   // if we're rna, use U instead of T
 559   // we might want to add an "is_rna" to sequence at somepoint
 560   char TU = (alphabet == reduced_rna_alphabet) ? 'U' : 'T';
 561   char tu = (alphabet == reduced_rna_alphabet) ? 'u' : 't';
 562   rc_map['A'] = TU ; rc_map['a'] = tu ;
 563   rc_map['T'] = 'A'; rc_map['t'] = 'a';
 564   rc_map['U'] = 'A'; rc_map['u'] = 'a';
 565   rc_map['G'] = 'C'; rc_map['g'] = 'c';
 566   rc_map['C'] = 'G'; rc_map['c'] = 'g';
 567   rc_map['M'] = 'K'; rc_map['m'] = 'k';
 568   rc_map['R'] = 'Y'; rc_map['r'] = 'y';
 569   rc_map['W'] = 'W'; rc_map['w'] = 'w';
 570   rc_map['S'] = 'S'; rc_map['s'] = 's';
 571   rc_map['Y'] = 'R'; rc_map['y'] = 'r';
 572   rc_map['K'] = 'M'; rc_map['k'] = 'm';
 573   rc_map['V'] = 'B'; rc_map['v'] = 'b';
 574   rc_map['H'] = 'D'; rc_map['h'] = 'd';
 575   rc_map['D'] = 'H'; rc_map['d'] = 'h';
 576   rc_map['B'] = 'V'; rc_map['b'] = 'v';
 577   rc_map['N'] = 'N'; rc_map['n'] = 'n';
 578   rc_map['X'] = 'X'; rc_map['x'] = 'x';
 579   rc_map['?'] = '?';
 580   rc_map['.'] = '.';
 581   rc_map['-'] = '-';
 582   rc_map['~'] = '~'; // not really needed, but perhaps it's clearer.
 583   return rc_map;
 584 }
 585
 586 Sequence Sequence::rev_comp() const
 587 {
 588   std::string rev_comp;
 589   rev_comp.reserve(length());
 590
 591   std::string rc_map = create_reverse_map();
 592
 593   // reverse and convert
 594   Sequence::const_reverse_iterator seq_i;
 595   Sequence::const_reverse_iterator seq_end = rend();
 596   for(seq_i = rbegin();
 597       seq_i != seq_end;
 598       ++seq_i)
 599   {
 600     rev_comp.append(1, rc_map[*seq_i]);
 601   }
 602   return Sequence(rev_comp, alphabet);
 603 }
 604
 605 void Sequence::set_fasta_header(std::string header_)
 606 {
 607   header = header_;
 608 }
 609
 610 void Sequence::set_species(const std::string& name)
 611 {
 612   species = name;
 613 }
 614
 615 std::string Sequence::get_species() const
 616 {
 617   return species;
 618 }
 619
 620
 621 std::string
 622 Sequence::get_fasta_header() const
 623 {
 624   return header;
 625 }
 626
 627 std::string
 628 Sequence::get_name() const
 629 {
 630   if (header.size() > 0)
 631     return header;
 632   else if (species.size() > 0)
 633     return species;
 634   else
 635     return "";
 636 }
 637
 638 const Alphabet& Sequence::get_alphabet() const
 639 {
 640   return get_alphabet(alphabet);
 641 }
 642
 643 const Alphabet& Sequence::get_alphabet(alphabet_ref alpha) const
 644 {
 645   switch (alpha) {
 646     case reduced_dna_alphabet:
 647       return Alphabet::reduced_dna_alphabet();
 648     case reduced_rna_alphabet:
 649       return Alphabet::reduced_rna_alphabet();
 650     case reduced_nucleic_alphabet:
 651       return Alphabet::reduced_nucleic_alphabet();
 652     case nucleic_alphabet:
 653       return Alphabet::nucleic_alphabet();
 654     case protein_alphabet:
 655       return Alphabet::protein_alphabet();
 656     default:
 657       throw std::runtime_error("unrecognized alphabet type");
 658       break;
 659   }
 660 }
 661
 662 void Sequence::set_sequence(const std::string& s, alphabet_ref a)
 663 {
 664   set_filtered_sequence(s, a);
 665 }
 666
 667 std::string Sequence::get_sequence() const
 668 {
 669   if (seq)
 670     return *seq;
 671   else
 672     return std::string();
 673 }
 674
 675 Sequence::const_reference Sequence::operator[](Sequence::size_type i) const
 676 {
 677   return at(i);
 678 }
 679
 680 Sequence::const_reference Sequence::at(Sequence::size_type i) const
 681 {
 682   if (!seq) throw std::out_of_range("empty sequence");
 683   return seq->at(i+seq_start);
 684 }
 685
 686 void
 687 Sequence::clear()
 688 {
 689   parent = 0;
 690   seq.reset();
 691   seq_start = 0;
 692   seq_count = 0;
 693   strand = UnknownStrand;
 694   header.clear();
 695   species.clear();
 696   annots.clear();
 697   motif_list.clear();
 698 }
 699
 700 const char *Sequence::c_str() const
 701 {
 702   if (seq)
 703     return seq->c_str()+seq_start;
 704   else
 705     return 0;
 706 }
 707
 708 Sequence::const_iterator Sequence::begin() const
 709 {
 710   if (seq and seq_count != 0)
 711     return seq->begin()+seq_start;
 712   else
 713     return Sequence::const_iterator(0);
 714 }
 715
 716 Sequence::const_iterator Sequence::end() const
 717 {
 718   if (seq and seq_count != 0) {
 719     return seq->begin() + seq_start + seq_count;
 720   } else {
 721     return Sequence::const_iterator(0);
 722   }
 723 }
 724
 725 Sequence::const_reverse_iterator Sequence::rbegin() const
 726 {
 727   if (seq and seq_count != 0)
 728     return seq->rbegin()+(seq->size()-(seq_start+seq_count));
 729   else
 730     return Sequence::const_reverse_iterator();
 731 }
 732
 733 Sequence::const_reverse_iterator Sequence::rend() const
 734 {
 735   if (seq and seq_count != 0) {
 736     return rbegin() + seq_count;
 737   } else {
 738     return Sequence::const_reverse_iterator();
 739   }
 740 }
 741
 742 bool Sequence::empty() const
 743 {
 744   return (seq_count == 0) ? true : false;
 745 }
 746
 747 Sequence::size_type Sequence::start() const
 748 {
 749   if (parent)
 750     return seq_start - parent->start();
 751   else
 752     return seq_start;
 753 }
 754
 755 Sequence::size_type Sequence::stop() const
 756 {
 757   return start() + seq_count;
 758 }
 759
 760 Sequence::size_type Sequence::size() const
 761 {
 762   return seq_count;
 763 }
 764
 765 Sequence::size_type Sequence::length() const
 766 {
 767   return size();
 768 }
 769
 770 void
 771 Sequence::save(fs::fstream &save_file)
 772 {
 773   //fstream save_file;
 774   std::list<annot>::iterator annots_i;
 775
 776   // not sure why, or if i'm doing something wrong, but can't seem to pass
 777   // file pointers down to this method from the mussa control class
 778   // so each call to save a sequence appends to the file started by mussa_class
 779   //save_file.open(save_file_path.c_str(), std::ios::app);
 780
 781   save_file << "<Sequence>" << std::endl;
 782   save_file << *this << std::endl;
 783   save_file << "</Sequence>" << std::endl;
 784
 785   save_file << "<Annotations>" << std::endl;
 786   save_file << species << std::endl;
 787   for (annots_i = annots.begin(); annots_i != annots.end(); ++annots_i)
 788   {
 789     save_file << annots_i->begin << " " << annots_i->end << " " ;
 790     save_file << annots_i->name << " " << annots_i->type << std::endl;
 791   }
 792   save_file << "</Annotations>" << std::endl;
 793   //save_file.close();
 794 }
 795
 796 void
 797 Sequence::load_museq(fs::path load_file_path, int seq_num)
 798 {
 799   fs::fstream load_file;
 800   std::string file_data_line;
 801   int seq_counter;
 802   annot an_annot;
 803   std::string::size_type space_split_i;
 804   std::string annot_value;
 805
 806   annots.clear();
 807   load_file.open(load_file_path, std::ios::in);
 808
 809   seq_counter = 0;
 810   // search for the seq_num-th sequence
 811   while ( (!load_file.eof()) && (seq_counter < seq_num) )
 812   {
 813     getline(load_file,file_data_line);
 814     if (file_data_line == "<Sequence>")
 815       seq_counter++;
 816   }
 817   getline(load_file, file_data_line);
 818   // looks like the sequence is written as a single line
 819   set_filtered_sequence(file_data_line, reduced_dna_alphabet);
 820   getline(load_file, file_data_line);
 821   getline(load_file, file_data_line);
 822   if (file_data_line == "<Annotations>")
 823   {
 824     getline(load_file, file_data_line);
 825     species = file_data_line;
 826     while ( (!load_file.eof())  && (file_data_line != "</Annotations>") )
 827     {
 828       getline(load_file,file_data_line);
 829       if ((file_data_line != "") && (file_data_line != "</Annotations>"))
 830       {
 831         // need to get 4 values...almost same code 4 times...
 832         // get annot start index
 833         space_split_i = file_data_line.find(" ");
 834         annot_value = file_data_line.substr(0,space_split_i);
 835         an_annot.begin = atoi (annot_value.c_str());
 836         file_data_line = file_data_line.substr(space_split_i+1);
 837         // get annot end index
 838         space_split_i = file_data_line.find(" ");
 839         annot_value = file_data_line.substr(0,space_split_i);
 840         an_annot.end = atoi (annot_value.c_str());
 841
 842         if (space_split_i == std::string::npos)  // no entry for type or name
 843         {
 844           std::cout << "seq, annots - no type or name\n";
 845           an_annot.type = "";
 846           an_annot.name = "";
 847         }
 848         else   // else get annot type
 849         {
 850           file_data_line = file_data_line.substr(space_split_i+1);
 851           space_split_i = file_data_line.find(" ");
 852           annot_value = file_data_line.substr(0,space_split_i);
 853           an_annot.type = annot_value;
 854           if (space_split_i == std::string::npos)  // no entry for name
 855           {
 856             std::cout << "seq, annots - no name\n";
 857             an_annot.name = "";
 858           }
 859           else          // get annot name
 860           {
 861             file_data_line = file_data_line.substr(space_split_i+1);
 862             space_split_i = file_data_line.find(" ");
 863             annot_value = file_data_line.substr(0,space_split_i);
 864             an_annot.type = annot_value;
 865           }
 866         }
 867         annots.push_back(an_annot);  // don't forget to actually add the annot
 868       }
 869       //std::cout << "seq, annots: " << an_annot.start << ", " << an_annot.end
 870       //     << "-->" << an_annot.type << "::" << an_annot.name << std::endl;
 871     }
 872   }
 873   load_file.close();
 874 }
 875
 876
 877 void Sequence::add_motif(const Sequence& a_motif)
 878 {
 879   std::vector<int> motif_starts = find_motif(a_motif);
 880
 881   for(std::vector<int>::iterator motif_start_i = motif_starts.begin();
 882       motif_start_i != motif_starts.end();
 883       ++motif_start_i)
 884   {
 885     motif_list.push_back(motif(*motif_start_i, a_motif.get_sequence()));
 886   }
 887 }
 888
 889 void Sequence::clear_motifs()
 890 {
 891   motif_list.clear();
 892 }
 893
 894 const std::list<motif>& Sequence::motifs() const
 895 {
 896   return motif_list;
 897 }
 898
 899 std::vector<int>
 900 Sequence::find_motif(const Sequence& a_motif) const
 901 {
 902   std::vector<int> motif_match_starts;
 903   Sequence norm_motif_rc;
 904
 905   motif_match_starts.clear();
 906   // std::cout << "motif is: " << norm_motif << std::endl;
 907
 908   if (a_motif.size() > 0)
 909   {
 910     //std::cout << "Sequence: none blank motif\n";
 911     motif_scan(a_motif, &motif_match_starts);
 912
 913     norm_motif_rc = a_motif.rev_comp();;
 914     // make sure not to do search again if it is a palindrome
 915     if (norm_motif_rc != a_motif) {
 916       motif_scan(norm_motif_rc, &motif_match_starts);
 917     }
 918   }
 919   return motif_match_starts;
 920 }
 921
 922 void
 923 Sequence::motif_scan(const Sequence& a_motif, std::vector<int> * motif_match_starts) const
 924 {
 925   // if there's no sequence we can't scan for it?
 926   // should this throw an exception?
 927   if (!seq) return;
 928
 929   std::string::size_type seq_i = 0;
 930   Sequence::size_type motif_i = 0;
 931   Sequence::size_type motif_len = a_motif.length();
 932   Sequence::value_type motif_char;
 933   Sequence::value_type seq_char;
 934
 935   while (seq_i < size())
 936   {
 937     // this is pretty much a straight translation of Nora's python code
 938     // to match iupac letter codes
 939     motif_char = toupper(a_motif[motif_i]);
 940     seq_char = toupper(seq->at(seq_start+seq_i));
 941     if (motif_char =='N')
 942       motif_i++;
 943     else if (motif_char == seq_char)
 944       motif_i++;
 945     else if ((motif_char =='M') && ((seq_char=='A') || (seq_char=='C')))
 946       motif_i++;
 947     else if ((motif_char =='R') && ((seq_char=='A') || (seq_char=='G')))
 948       motif_i++;
 949     else if ((motif_char =='W') && ((seq_char=='A') || (seq_char=='T')))
 950       motif_i++;
 951     else if ((motif_char =='S') && ((seq_char=='C') || (seq_char=='G')))
 952       motif_i++;
 953     else if ((motif_char =='Y') && ((seq_char=='C') || (seq_char=='T')))
 954       motif_i++;
 955     else if ((motif_char =='K') && ((seq_char=='G') || (seq_char=='T')))
 956       motif_i++;
 957     else if ((motif_char =='V') &&
 958              ((seq_char=='A') || (seq_char=='C') || (seq_char=='G')))
 959       motif_i++;
 960     else if ((motif_char =='H') &&
 961              ((seq_char=='A') || (seq_char=='C') || (seq_char=='T')))
 962       motif_i++;
 963     else if ((motif_char =='D') &&
 964              ((seq_char=='A') || (seq_char=='G') || (seq_char=='T')))
 965       motif_i++;
 966     else if ((motif_char =='B') &&
 967              ((seq_char=='C') || (seq_char=='G') || (seq_char=='T')))
 968       motif_i++;
 969     else
 970     {
 971       // if a motif doesn't match, erase our current trial and try again
 972       seq_i -= motif_i;
 973       motif_i = 0;
 974     }
 975
 976     // end Nora stuff, now we see if a match is found this pass
 977     if (motif_i == motif_len)
 978     {
 979       annot new_motif;
 980       motif_match_starts->push_back(seq_i - motif_len + 1);
 981       motif_i = 0;
 982     }
 983
 984     seq_i++;
 985   }
 986   //std::cout << std::endl;
 987 }
 988
 989 void Sequence::add_string_annotation(std::string a_seq,
 990                                      std::string name)
 991 {
 992   std::vector<int> seq_starts = find_motif(a_seq);
 993
 994   //std::cout << "searching for " << a_seq << " found " << seq_starts.size() << std::endl;
 995
 996   for(std::vector<int>::iterator seq_start_i = seq_starts.begin();
 997       seq_start_i != seq_starts.end();
 998       ++seq_start_i)
 999   {
1000     annots.push_back(annot(*seq_start_i,
1001                            *seq_start_i+a_seq.size(),
1002                            "",
1003                            name));
1004   }
1005 }
1006
1007 void Sequence::find_sequences(std::list<Sequence>::iterator start,
1008                               std::list<Sequence>::iterator end)
1009 {
1010   while (start != end) {
1011     add_string_annotation(start->get_sequence(), start->get_fasta_header());
1012     ++start;
1013   }
1014 }
1015
1016
1017 std::ostream& operator<<(std::ostream& out, const Sequence& s)
1018 {
1019   for(Sequence::const_iterator s_i = s.begin(); s_i != s.end(); ++s_i) {
1020     out << *s_i;
1021   }
1022   return out;
1023 }
1024
1025 bool operator<(const Sequence& x, const Sequence& y)
1026 {
1027   Sequence::const_iterator x_i = x.begin();
1028   Sequence::const_iterator y_i = y.begin();
1029   // for sequences there's some computation associated with computing .end
1030   // so lets cache it.
1031   Sequence::const_iterator xend = x.end();
1032   Sequence::const_iterator yend = y.end();
1033   while(1) {
1034     if( x_i == xend and y_i == yend ) {
1035       return false;
1036     } else if ( x_i == xend ) {
1037       return true;
1038     } else if ( y_i == yend ) {
1039       return false;
1040     } else if ( (*x_i) < (*y_i)) {
1041       return true;
1042     } else if ( (*x_i) > (*y_i) ) {
1043       return false;
1044     } else {
1045       ++x_i;
1046       ++y_i;
1047     }
1048   }
1049 }
1050
1051 bool operator==(const Sequence& x, const Sequence& y)
1052 {
1053   if (x.empty() and y.empty()) {
1054     // if there's no sequence in either sequence structure, they're equal
1055     return true;
1056   } else if (x.empty() or y.empty()) {
1057     // if we fail the first test, and we discover one is empty,
1058     // we know they can't be equal. (and we need to do this
1059     // to prevent dereferencing an empty pointer)
1060     return false;
1061   } else if (x.seq_count != y.seq_count) {
1062     // if they're of different lenghts, they're not equal
1063     return false;
1064   }
1065   Sequence::const_iterator xseq_i = x.begin();
1066   Sequence::const_iterator yseq_i = y.begin();
1067   // since the length of the two sequences is equal, we only need to
1068   // test one.
1069   for(; xseq_i != x.end(); ++xseq_i, ++yseq_i) {
1070     if (toupper(*xseq_i) != toupper(*yseq_i)) {
1071       return false;
1072     }
1073   }
1074   return true;
1075 }
1076
1077 bool operator!=(const Sequence& x, const Sequence& y)
1078 {
1079   return not operator==(x, y);
1080 }