adding comment

FlexibleSUSY · Jun 5, 2014 · 6cb0e7b · 6cb0e7b
1 parent 1ed7649
commit 6cb0e7b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/wrappers.hpp b/src/wrappers.hpp
@@ -201,6 +201,15 @@ double MaxRelDiff(const Eigen::ArrayBase<Derived>& a,
    return MaxRelDiff(a.matrix(), b.matrix());
 }
 
+/**
+ * The element of v, which is closest to mass, is moved to the
+ * position idx.
+ *
+ * @param idx new index of the mass eigenvalue
+ * @param mass mass to compare against
+ * @param v vector of masses
+ * @param z corresponding mixing matrix
+ */
 template <typename DerivedArray, typename DerivedMatrix>
 void move_goldstone_to(unsigned idx, double mass, Eigen::ArrayBase<DerivedArray>& v,
                        Eigen::MatrixBase<DerivedMatrix>& z)