From bb6999b032a99e13987abc01fe8d1dc6541e083b Mon Sep 17 00:00:00 2001 From: ebanks Date: Sun, 23 Jan 2011 03:36:09 +0000 Subject: [PATCH] Better documentation git-svn-id: file:///humgen/gsa-scr1/gsa-engineering/svn_contents/trunk@5057 348d0f76-0448-11de-a6fe-93d51630548a --- java/src/org/broadinstitute/sting/utils/MathUtils.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/java/src/org/broadinstitute/sting/utils/MathUtils.java b/java/src/org/broadinstitute/sting/utils/MathUtils.java index 79d457c82..c6ab656d7 100755 --- a/java/src/org/broadinstitute/sting/utils/MathUtils.java +++ b/java/src/org/broadinstitute/sting/utils/MathUtils.java @@ -342,7 +342,7 @@ public class MathUtils { } /** - * normalizes the log10-based array + * normalizes the log10-based array. ASSUMES THAT ALL ARRAY ENTRIES ARE <= 0 (<= 1 IN REAL-SPACE). * * @param array the array to be normalized * @param takeLog10OfOutput if true, the output will be transformed back into log10 units @@ -371,6 +371,13 @@ public class MathUtils { return normalized; } + /** + * normalizes the log10-based array. ASSUMES THAT ALL ARRAY ENTRIES ARE <= 0 (<= 1 IN REAL-SPACE). + * + * @param array the array to be normalized + * + * @return a newly allocated array corresponding the normalized values in array + */ public static double[] normalizeFromLog10(double[] array) { return normalizeFromLog10(array, false); }