alg/flp.hpp

   1 #ifndef _MUSSA_FLP_H_
   2 #define _MUSSA_FLP_H_
   3 //  This file is part of the Mussa source distribution.
   4 //  http://mussa.caltech.edu/
   5 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
   6
   7 // This program and all associated source code files are Copyright (C) 2005
   8 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
   9 // under the GNU Public License; please see the included LICENSE.txt
  10 // file for more information, or contact Tristan directly.
  11
  12
  13 //                        ----------------------------------------
  14 //                            ---------- flp.hh  -----------
  15 //                        ----------------------------------------
  16 #include <boost/filesystem/path.hpp>
  17
  18 #include <list>
  19 #include <string>
  20 #include <vector>
  21 #include <iostream>
  22
  23 class Sequence;
  24 //! FLP = Fixed Length Pairs (Data)
  25 /*!
  26  * vector of linked lists of the match type struct
  27  */
  28 class FLPs
  29 {
  30 public:
  31     FLPs();
  32     FLPs(const FLPs& );
  33     //! Setup a FLP and reserve space for the match lists
  34     /*!
  35      * Initialize the all_matches structure with a list of matches
  36      * for enough windows for the size of sequence 1
  37      */
  38
  39     struct match
  40     {
  41       int index;
  42       int score;
  43
  44       friend bool operator==(const match&, const match& );
  45       friend std::ostream &operator<<(std::ostream&, const match&);
  46     };
  47
  48     void setup(int win_size, int hard_thres);
  49     //! compare two sequences and store the list of results in all_matches
  50     void seqcomp(const Sequence& seq1, const Sequence& seq2, bool is_RC);
  51     //bool FLPs::match_less(match *match1, match *match2);
  52     //void FLPs::sort();
  53     //! Return all the matches for a particular window?
  54     std::list<match> matches(int index) const;
  55     //! Return all the match indexes for a particular window?
  56     std::list<int> match_locations(int index) const;
  57     //! Return all the match indexes for a particular window above a threshold
  58     std::list<int> thres_matches(int index, int thres) const;
  59     //! Return the number of windows stored in this FLPs
  60     /*! (this is should be the same as seq1_len-window_size+1
  61      */
  62     int size() const;
  63     //! Save all the FLPs to save_file_path
  64     void save(boost::filesystem::path save_file_path);
  65     //! Load a vector of a lists of FLPs
  66     void load(boost::filesystem::path file_path);
  67
  68     //! how far we are through current seqcomp
  69     float progress() const;
  70
  71     const static int seqcomp_not_running = -1;
  72   private:
  73     //! the number of base pairs in the sliding window
  74     int window_size;
  75     //! the minimum tnumber of base pairs need for this window to be saved.
  76     int hard_threshold;
  77
  78     //! add a match from location seq1_i to seq2_i with a threshold of a_score
  79     /*! i2_offset is used to shift the window start when doing a reverse
  80      * compliment. (This is called by seqcomp() )
  81      */
  82     inline void add(int seq1_i, int seq2_i, int a_score, int i2_offset);
  83     //! this list of matches between the two sequences
  84     /*! All of the matches are stored here, it appears each window position
  85      *  in sequence 1 gets an entry in the vector, the list contains matches
  86      *  between sequence 1 and sequence 2
  87      */
  88     std::vector<std::list<match> > *all_matches;
  89     //! reserve space for the appropriate number of windows.
  90     /*! this is mostly so seqcomp can use operator[]
  91      */
  92     void alloc_matches(std::string::size_type len1=0);
  93
  94     //! current loop index
  95     int seqcomp_i;
  96     //! end seqcomp index (when terminating, seqcomp_i == seqcomp_end.
  97     //! when not running seqcomp_i == seqcomp_end == seqcomp_not_running
  98     int seqcomp_end;
  99 };
 100 #endif