From efbd6a4c2086e00d9d61833c8f894ea718a19930 Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Thu, 27 Jul 2017 14:06:25 -0700 Subject: [PATCH] Add missing return documentation. --- src/org/nwapw/abacus/plugin/StandardPlugin.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/org/nwapw/abacus/plugin/StandardPlugin.java b/src/org/nwapw/abacus/plugin/StandardPlugin.java index dfc920e..5faafd6 100755 --- a/src/org/nwapw/abacus/plugin/StandardPlugin.java +++ b/src/org/nwapw/abacus/plugin/StandardPlugin.java @@ -117,7 +117,7 @@ public class StandardPlugin extends Plugin { * Returns the nth term of the Taylor series (centered at 0) of e^x * @param n the term required (n >= 0). * @param x the real number at which the series is evaluated. - * @return + * @return the nth term of the series. */ private NumberInterface getExpSeriesTerm(int n, NumberInterface x){ return x.intPow(n).divide(this.getFunction("!").apply((new NaiveNumber(n)).promoteTo(x.getClass()))); @@ -128,7 +128,7 @@ public class StandardPlugin extends Plugin { * such that the error is at most maxError. * @param maxError Maximum error permissible (This should probably be positive.) * @param x where the function is evaluated. - * @return + * @return the number of terms needed to evaluated the exponential function. */ private int getNTermsExp(NumberInterface maxError, NumberInterface x){ //We need n such that x^(n+2) <= (n+1)! * maxError @@ -162,7 +162,7 @@ public class StandardPlugin extends Plugin { /** * Returns the maximum error based on the precision of the class of number. * @param number Any instance of the NumberInterface in question (should return an appropriate precision). - * @return + * @return the maximum error. */ private NumberInterface getMaxError(NumberInterface number){ return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.precision());