DanilaFe/Abacus
1
0
Fork 0
mirror of https://github.com/DanilaFe/abacus synced 2024-12-23 07:50:09 -08:00
Code Issues Releases Wiki Activity

Add missing return documentation.

Browse Source
This commit is contained in:
Danila Fedorin 2017-07-27 14:06:25 -07:00
parent 15e42126b5
commit de3feae3b6
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/org/nwapw/abacus/plugin/StandardPlugin.java
View File

@ -117,7 +117,7 @@ public class StandardPlugin extends Plugin {
* Returns the nth term of the Taylor series (centered at 0) of e^x * Returns the nth term of the Taylor series (centered at 0) of e^x
* @param n the term required (n >= 0). * @param n the term required (n >= 0).
* @param x the real number at which the series is evaluated. * @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){ private NumberInterface getExpSeriesTerm(int n, NumberInterface x){
return x.intPow(n).divide(this.getFunction("!").apply((new NaiveNumber(n)).promoteTo(x.getClass()))); 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. * such that the error is at most maxError.
* @param maxError Maximum error permissible (This should probably be positive.) * @param maxError Maximum error permissible (This should probably be positive.)
* @param x where the function is evaluated. * @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){ private int getNTermsExp(NumberInterface maxError, NumberInterface x){
//We need n such that x^(n+2) <= (n+1)! * maxError //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. * 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). * @param number Any instance of the NumberInterface in question (should return an appropriate precision).
* @return * @return the maximum error.
*/ */
private NumberInterface getMaxError(NumberInterface number){ private NumberInterface getMaxError(NumberInterface number){
return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.precision()); return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.precision());