]> ruin.nu Git - germs.git/blob - src/genealgorithms.h
DOC: more doxygen documentation
[germs.git] / src / genealgorithms.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 __GENEALGORITHMS_H__
22 #define __GENEALGORITHMS_H__
23
24 #include <vector>
25
26 class GeneOrder;
27 struct Component;
28
29 /**
30  * Simple interval struct, holds the indexes + information if the interval is
31  * oriented or not.
32  */
33 struct Interval{
34         Interval(size_t f,size_t s,bool o = false):first(f),second(s),oriented(o){}
35         bool operator==(const Interval& i){
36                 return first == i.first && second == i.second && oriented == i.oriented;
37         }
38         //!The start index for this elementary interval
39         size_t first;
40         //!The end interval for this elementary interval
41         size_t second;
42         bool oriented;
43 };
44
45 /**
46  * Returns the length of the longest increasing sequence and the longest
47  * decreasing sequence.
48  */
49 std::pair<int,int> longestSequences(const GeneOrder& go);
50
51 /**
52  * Uses the Robinson-Schensted algorithm on the gene order. Gives the longest
53  * increasing and decreasing subsequences.
54  */
55 std::vector<std::vector<int> > robinsonSchensted(const GeneOrder& go);
56
57 /**
58  * Counts the number of cycles in the gene order.
59  */
60 size_t countCycles(const GeneOrder& go);
61
62 /**
63  * Calculates the inversion distance for this gene order
64  */
65 size_t inversionDistance(const GeneOrder& go);
66
67 /**
68  * Finds the components in the gene order.
69  */
70 std::vector<Component> findComponents(const GeneOrder& go);
71
72 /**
73  * Find intervals.
74  */
75 std::vector<Interval> findIntervals(const GeneOrder& go);
76
77 /**
78  * Creates a list with the intervals at each point. The first and second members
79  * of the returned Intervals are elementary intervals that start, or end, at the
80  * specific point.
81  */
82 std::vector<Interval> findIntervalsAtPoints(const std::vector<Interval>& intervals);
83
84 #endif
85