Added more doxygen documentation

[germs.git] / src / genealgorithms.h

diff --git a/src/genealgorithms.h b/src/genealgorithms.h
index 1d74e7130862188d4ff8e0ad57bf8a656e7d6023..a91f67ddcae2345497c24841ff93dc6d6d5ebf82 100644 (file)
--- a/src/genealgorithms.h
+++ b/src/genealgorithms.h
@@ -26,7 +26,10 @@
 class GeneOrder;
 struct Component;
 
-
+/**
+ * Simple interval struct, holds the indexes + information if the interval is
+ * oriented or not.
+ */
 struct Interval{
        Interval(size_t f,size_t s,bool o = false):first(f),second(s),oriented(o){}
        bool operator==(const Interval& i){
@@ -44,6 +47,8 @@ struct Interval{
 std::pair<int,int> longestSequences(const GeneOrder& go);
 
 /**
+ * Uses the Robinson-Schensted algorithm on the gene order. Gives the longest
+ * increasing and decreasing subsequences.
  */
 std::vector<std::vector<int> > robinsonSchensted(const GeneOrder& go);