src/geneorder.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Michael Andreen                                 *
   3  *   andreen@student.chalmers.se                                           *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA          *
  19  ***************************************************************************/
  20
  21 #ifndef __GENEORDER_H__
  22 #define __GENEORDER_H__
  23
  24 #include <vector>
  25 #include <stdexcept>
  26
  27 #include "misc.h"
  28
  29 /**
  30  * Stores a gene order permutation and ensures that all genes are present and not duplicated.
  31  * \author Michael Andreen
  32 */
  33 class GeneOrder{
  34         public:
  35
  36                 typedef std::vector<Gene> GeneList;
  37                 typedef GeneList::size_type size_type;
  38                 typedef GeneList::const_iterator iterator;
  39
  40                 /**
  41                  * Creates a copy of the given gene order
  42                  */
  43                 GeneOrder(const GeneOrder& go);
  44
  45                 /**
  46                  * Creates a gene order from a given list, using STL-type iterators.
  47                  *
  48                  * The given permutation needs to contain all genes 1 to n, if 0 is
  49                  * included it has to be the first item, if it is not present it will
  50                  * be added automatically. Similarily, if n is not the last item, then
  51                  * n+1 will be added to the end.
  52                  *
  53                  * \param begin iterator to the first element in the list, from begin()
  54                  * on stl collections and pointer to first item on plain arrays.
  55                  *
  56                  * \param end iterator to the element behind the last, from end() in
  57                  * stl collections or pointer to first element+size on plain arrays.
  58                  *
  59                  * \throws std::invalid_argument if the list is not a valid permutation.
  60                  */
  61                 template<class T>
  62                 GeneOrder(T begin, T end);
  63
  64                 /**
  65                  * Destroyes the gene order.
  66                  */
  67                 ~GeneOrder();
  68
  69                 /**
  70                  * Copies the given gene order.
  71                  */
  72                 const GeneOrder& operator=(const GeneOrder& go);
  73
  74                 /**
  75                  * Returns the gene at the given index.
  76                  *
  77                  * \throws std::out_of_range if i is smaller than 0 or bigger than n.
  78                  */
  79                 const Gene& operator[](size_type i) const;
  80
  81                 /**
  82                  * Returns the size of the permutation.
  83                  */
  84                 size_type size() const;
  85
  86                 /**
  87                  * Returns the vector containing the gene order permutation.
  88                  */
  89                 const GeneList& list() const;
  90
  91                 /**
  92                  * Returns the start iterator for the permutation.
  93                  * To be used with STL style functions.
  94                  *
  95                  * \see end
  96                  */
  97                 iterator begin() const;
  98
  99                 /**
 100                  * Returns the end iterator for the permutation.
 101                  * To be used with STL style functions.
 102                  *
 103                  * \see begin
 104                  */
 105                 iterator end() const;
 106
 107                 /**
 108                  * Reverserses the interval [i,j], changing the sign on all elements
 109                  * affected.
 110                  *
 111                  * \throws std::out_of_range if i is smaller than 0 or bigger than n.
 112                  */
 113                 void reverse(size_type i, size_type j);
 114
 115
 116         private:
 117                 GeneList _geneorder;
 118                 /**
 119                  * pads the permutation with 0 in front and n+1 at the end if needed
 120                  */
 121                 void pad();
 122
 123                 /**
 124                  * Verifies that the permutation starts with 0, ends with n+1 and that all genes i, 0 < i < n+1
 125                  * are present, without duplication.
 126                  */
 127                 void verify();
 128 };
 129
 130
 131 /**
 132  * Put all the genes in the list, check that all genes are included, pad with 0 and n+1 if needed.
 133  * TODO: This is far from done atm
 134  */
 135 template<typename T>
 136 GeneOrder::GeneOrder(T begin, T end): _geneorder(begin,end){
 137         pad();
 138         verify();
 139 }
 140
 141 #endif
 142