From 3e85077e2f8d133cb449eb07fd9bc1551bc519a4 Mon Sep 17 00:00:00 2001 From: Michael Andreen Date: Mon, 18 Jun 2007 09:58:07 +0000 Subject: [PATCH] more documentation --- src/geneorder.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/geneorder.h b/src/geneorder.h index a4b7aaa..4659e0e 100644 --- a/src/geneorder.h +++ b/src/geneorder.h @@ -27,7 +27,13 @@ #include "misc.h" /** - * Stores a gene order permutation and ensures that all genes are present and not duplicated. + * Stores a gene order permutation and ensures that all genes are present + * and not duplicated. + * + * It has limited support for acting as an STL container, but still maintaining + * the invariant of a permutation starting with 0 and ending with n, with all + * genes present. + * * \author Michael Andreen */ class GeneOrder{ -- 2.39.2