Optimize pow for integer bases.

0c16bb4e9b

src/main/java/org/nwapw/abacus/Abacus.java

@@ -6,16 +6,12 @@ import org.nwapw.abacus.number.NumberInterface;
 import org.nwapw.abacus.parsing.LexerTokenizer;
 import org.nwapw.abacus.parsing.ShuntingYardParser;
 import org.nwapw.abacus.parsing.TreeBuilder;
-import org.nwapw.abacus.plugin.ClassFinder;
 import org.nwapw.abacus.plugin.NumberImplementation;
 import org.nwapw.abacus.plugin.PluginManager;
 import org.nwapw.abacus.plugin.StandardPlugin;
 import org.nwapw.abacus.tree.NumberReducer;
 import org.nwapw.abacus.tree.TreeNode;
 
-import java.io.File;
-import java.io.IOException;
-
 /**
  * The main calculator class. This is responsible
  * for piecing together all of the components, allowing
@@ -27,10 +23,6 @@ public class Abacus {
      * The default number implementation to be used if no other one is available / selected.
      */
     public static final NumberImplementation DEFAULT_IMPLEMENTATION = StandardPlugin.IMPLEMENTATION_NAIVE;
-    /**
-     * The file used for saving and loading configuration.
-     */
-    public static final File CONFIG_FILE = new File("config.toml");
 
     /**
      * The plugin manager responsible for
@@ -54,26 +46,19 @@ public class Abacus {
 
     /**
      * Creates a new instance of the Abacus calculator.
+     *
+     * @param configuration the configuration object for this Abacus instance.
      */
-    public Abacus() {
+    public Abacus(Configuration configuration) {
         pluginManager = new PluginManager(this);
         numberReducer = new NumberReducer(this);
-        configuration = new Configuration(CONFIG_FILE);
-        configuration.saveTo(CONFIG_FILE);
+        this.configuration = new Configuration(configuration);
         LexerTokenizer lexerTokenizer = new LexerTokenizer();
         ShuntingYardParser shuntingYardParser = new ShuntingYardParser(this);
         treeBuilder = new TreeBuilder<>(lexerTokenizer, shuntingYardParser);
 
-        pluginManager.addListener(lexerTokenizer);
         pluginManager.addListener(shuntingYardParser);
-        pluginManager.addInstantiated(new StandardPlugin(pluginManager));
-        try {
-            ClassFinder.loadJars("plugins")
-                    .forEach(plugin -> pluginManager.addClass(plugin));
-        } catch (IOException | ClassNotFoundException e) {
-            e.printStackTrace();
-        }
-        pluginManager.load();
+        pluginManager.addListener(lexerTokenizer);
     }
 
     public static void main(String[] args) {

src/main/java/org/nwapw/abacus/config/Configuration.java

@@ -39,6 +39,15 @@ public class Configuration {
      */
     private Set<String> disabledPlugins = new HashSet<>();
 
+    /**
+     * Creates a new configuration form the given configuration.
+     *
+     * @param copyFrom the configuration to copy.
+     */
+    public Configuration(Configuration copyFrom){
+        copyFrom(copyFrom);
+    }
+
     /**
      * Creates a new configuration with the given values.
      *
@@ -85,6 +94,15 @@ public class Configuration {
         }
     }
 
+    /**
+     * Gets the value of this configuration as a string.
+     *
+     * @return the string that represents this configuration.
+     */
+    public String asTomlString(){
+        return TOML_WRITER.write(this);
+    }
+
     /**
      * Gets the number implementation from this configuration.
      *

src/main/java/org/nwapw/abacus/function/Operator.java

@@ -26,6 +26,7 @@ public class Operator {
      * Creates a new operator with the given parameters.
      *
      * @param associativity the associativity of the operator.
+     * @param operatorType  the type of this operator, like binary infix or unary postfix.
      * @param precedence    the precedence of the operator.
      * @param function      the function that the operator calls.
      */

src/main/java/org/nwapw/abacus/fx/AbacusController.java

@@ -13,10 +13,14 @@ import org.nwapw.abacus.Abacus;
 import org.nwapw.abacus.config.Configuration;
 import org.nwapw.abacus.number.ComputationInterruptedException;
 import org.nwapw.abacus.number.NumberInterface;
+import org.nwapw.abacus.plugin.ClassFinder;
 import org.nwapw.abacus.plugin.PluginListener;
 import org.nwapw.abacus.plugin.PluginManager;
+import org.nwapw.abacus.plugin.StandardPlugin;
 import org.nwapw.abacus.tree.TreeNode;
 
+import java.io.File;
+import java.io.IOException;
 import java.util.Set;
 
 
@@ -26,6 +30,10 @@ import java.util.Set;
  */
 public class AbacusController implements PluginListener {
 
+    /**
+     * The file used for saving and loading configuration.
+     */
+    public static final File CONFIG_FILE = new File("config.toml");
     /**
      * The title for the apply alert dialog.
      */
@@ -205,9 +213,16 @@ public class AbacusController implements PluginListener {
             if (oldValue.equals(settingsTab)) alertIfApplyNeeded(true);
         });
 
-        abacus = new Abacus();
-        abacus.getPluginManager().addListener(this);
-        abacus.getPluginManager().reload();
+        abacus = new Abacus(new Configuration(CONFIG_FILE));
+        PluginManager abacusPluginManager = abacus.getPluginManager();
+        abacusPluginManager.addListener(this);
+        abacusPluginManager.addInstantiated(new StandardPlugin(abacus.getPluginManager()));
+        try {
+            ClassFinder.loadJars("plugins").forEach(abacusPluginManager::addClass);
+        } catch (IOException | ClassNotFoundException e) {
+            e.printStackTrace();
+        }
+        abacusPluginManager.reload();
 
         changesMade = false;
         reloadAlertShown = false;
@@ -255,7 +270,7 @@ public class AbacusController implements PluginListener {
         for (ToggleablePlugin pluginEntry : enabledPlugins) {
             if (!pluginEntry.isEnabled()) disabledPlugins.add(pluginEntry.getClassName());
         }
-        configuration.saveTo(Abacus.CONFIG_FILE);
+        configuration.saveTo(CONFIG_FILE);
         changesMade = false;
         reloadAlertShown = false;
     }

src/main/java/org/nwapw/abacus/lexing/pattern/ValueNode.java

@@ -15,7 +15,7 @@ public class ValueNode<T> extends PatternNode<T> {
     /**
      * Creates a new node that matches the given character.
      *
-     * @param value
+     * @param value the character value of the node.
      */
     public ValueNode(char value) {
         this.value = value;

src/main/java/org/nwapw/abacus/number/NumberInterface.java

@@ -182,7 +182,7 @@ public abstract class NumberInterface {
      * Also, checks if the thread has been interrupted, and if so, throws
      * an exception.
      *
-     * @return the least integer >= the number, if int can hold the value.
+     * @return the least integer bigger or equal to the number.
      */
     public final NumberInterface ceiling(){
         checkInterrupted();
@@ -192,7 +192,7 @@ public abstract class NumberInterface {
     /**
      * Return the greatest integer less than or equal to the number.
      *
-     * @return the greatest int >= the number, if int can hold the value.
+     * @return the greatest integer smaller or equal the number.
      */
     protected abstract NumberInterface floorInternal();
 
@@ -201,7 +201,7 @@ public abstract class NumberInterface {
      * Also, checks if the thread has been interrupted, and if so, throws
      * an exception.
      *
-     * @return the greatest int >= the number, if int can hold the value.
+     * @return the greatest int greater than or equal to the number.
      */
     public final NumberInterface floor(){
         checkInterrupted();
@@ -216,7 +216,7 @@ public abstract class NumberInterface {
     protected abstract NumberInterface fractionalPartInternal();
 
     /**
-     * Returns the fractional part of the number.
+     * Returns the fractional part of the number, specifically x - floor(x).
      * Also, checks if the thread has been interrupted,
      * and if so, throws an exception.
      * @return the fractional part of the number.
@@ -230,7 +230,7 @@ public abstract class NumberInterface {
      * Returns the integer representation of this number, discarding any fractional part,
      * if int can hold the value.
      *
-     * @return
+     * @return the integer value of this number.
      */
     public abstract int intValue();
 

src/main/java/org/nwapw/abacus/number/PreciseNumber.java

@@ -113,19 +113,18 @@ public class PreciseNumber extends NumberInterface {
         String str = value.toPlainString();
         int decimalIndex = str.indexOf('.');
         if (decimalIndex != -1) {
-            return new PreciseNumber(str.substring(0, decimalIndex));
+            NumberInterface floor = new PreciseNumber(str.substring(0, decimalIndex));
+            if(signum() == -1){
+                floor = floor.subtract(ONE);
+            }
+            return floor;
         }
         return this;
     }
 
     @Override
     public NumberInterface fractionalPartInternal() {
-        String str = value.toPlainString();
-        int decimalIndex = str.indexOf('.');
-        if (decimalIndex != -1) {
-            return new PreciseNumber(str.substring(decimalIndex + 1));
-        }
-        return ZERO;
+        return this.subtractInternal(floorInternal());
     }
 
     @Override

src/main/java/org/nwapw/abacus/plugin/NumberImplementation.java

@@ -28,7 +28,7 @@ public abstract class NumberImplementation {
      * Creates a new number implementation with the given data.
      *
      * @param implementation the implementation class.
-     * @param priority       the priority, higher -> more likely to be converted into.
+     * @param priority       the priority, higher means more likely to be converted into.
      */
     public NumberImplementation(Class<? extends NumberInterface> implementation, int priority) {
         this.implementation = implementation;

src/main/java/org/nwapw/abacus/plugin/PluginManager.java

@@ -70,6 +70,8 @@ public class PluginManager {
 
     /**
      * Creates a new plugin manager.
+     *
+     * @param abacus the abacus instance.
      */
     public PluginManager(Abacus abacus) {
         this.abacus = abacus;

src/main/java/org/nwapw/abacus/plugin/StandardPlugin.java

@@ -18,6 +18,11 @@ import java.util.function.BiFunction;
  */
 public class StandardPlugin extends Plugin {
 
+    /**
+     * Stores objects of NumberInterface with integer values for reuse.
+     */
+    private final static HashMap<Class<? extends NumberInterface>, HashMap<Integer, NumberInterface>> integerValues = new HashMap<>();
+
     /**
      * The addition operator, +
      */
@@ -112,7 +117,7 @@ public class StandardPlugin extends Plugin {
         @Override
         protected NumberInterface applyInternal(NumberInterface[] params) {
             if (params[0].signum() == 0) {
-                return (new NaiveNumber(1)).promoteTo(params[0].getClass());
+                return fromInt(params[0].getClass(), 1);
             }
             NumberInterface factorial = params[0];
             NumberInterface multiplier = params[0];
@@ -157,14 +162,14 @@ public class StandardPlugin extends Plugin {
             int powersOf2 = 0;
             while (FUNCTION_ABS.apply(param.subtract(NaiveNumber.ONE.promoteTo(param.getClass()))).compareTo(new NaiveNumber(0.1).promoteTo(param.getClass())) >= 0) {
                 if (param.subtract(NaiveNumber.ONE.promoteTo(param.getClass())).signum() == 1) {
-                    param = param.divide(new NaiveNumber(2).promoteTo(param.getClass()));
+                    param = param.divide(fromInt(param.getClass(), 2));
                     powersOf2++;
                     if (param.subtract(NaiveNumber.ONE.promoteTo(param.getClass())).signum() != 1) {
                         break;
                         //No infinite loop for you.
                     }
                 } else {
-                    param = param.multiply(new NaiveNumber(2).promoteTo(param.getClass()));
+                    param = param.multiply(fromInt(param.getClass(), 2));
                     powersOf2--;
                     if (param.subtract(NaiveNumber.ONE.promoteTo(param.getClass())).signum() != -1) {
                         break;
@@ -203,17 +208,17 @@ public class StandardPlugin extends Plugin {
          */
         private NumberInterface getLog2(NumberInterface number) {
             NumberInterface maxError = getMaxError(number);
-            //NumberInterface errorBound = (new NaiveNumber(1)).promoteTo(number.getClass());
+            //NumberInterface errorBound = fromInt(number.getClass(), 1);
             //We'll use the series \sigma_{n >= 1) ((1/3^n + 1/4^n) * 1/n)
             //In the following, a=1/3^n, b=1/4^n, c = 1/n.
             //a is also an error bound.
-            NumberInterface a = (new NaiveNumber(1)).promoteTo(number.getClass()), b = a, c = a;
+            NumberInterface a = fromInt(number.getClass(), 1), b = a, c = a;
             NumberInterface sum = NaiveNumber.ZERO.promoteTo(number.getClass());
             int n = 0;
             while (a.compareTo(maxError) >= 1) {
                 n++;
-                a = a.divide((new NaiveNumber(3)).promoteTo(number.getClass()));
-                b = b.divide((new NaiveNumber(4)).promoteTo(number.getClass()));
+                a = a.divide(fromInt(number.getClass(), 3));
+                b = b.divide(fromInt(number.getClass(), 4));
                 c = NaiveNumber.ONE.promoteTo(number.getClass()).divide((new NaiveNumber(n)).promoteTo(number.getClass()));
                 sum = sum.add(a.add(b).multiply(c));
             }
@@ -311,7 +316,7 @@ public class StandardPlugin extends Plugin {
                 //right and left refer to lhs and rhs in the above inequality.
                 NumberInterface sum = NaiveNumber.ONE.promoteTo(params[0].getClass());
                 NumberInterface nextNumerator = params[0];
-                NumberInterface left = params[0].multiply((new NaiveNumber(3)).promoteTo(params[0].getClass()).intPow(params[0].ceiling().intValue())), right = maxError;
+                NumberInterface left = params[0].multiply(fromInt(params[0].getClass(), 3).intPow(params[0].ceiling().intValue())), right = maxError;
                 do {
                     sum = sum.add(nextNumerator.divide(factorial(params[0].getClass(), n + 1)));
                     n++;
@@ -344,6 +349,13 @@ public class StandardPlugin extends Plugin {
                 return NaiveNumber.ZERO.promoteTo(params[0].getClass());
             else if (params[1].compareTo(NaiveNumber.ZERO.promoteTo(params[0].getClass())) == 0)
                 return NaiveNumber.ONE.promoteTo(params[1].getClass());
+            //Detect integer bases:
+            if(params[0].fractionalPart().compareTo(fromInt(params[0].getClass(), 0)) == 0
+                    && FUNCTION_ABS.apply(params[0]).compareTo(fromInt(params[0].getClass(), Integer.MAX_VALUE)) < 0
+                    && FUNCTION_ABS.apply(params[1]).compareTo(fromInt(params[1].getClass(), 1)) >= 0){
+                NumberInterface[] newParams = {params[0], params[1].fractionalPart()};
+                return params[0].intPow(params[1].floor().intValue()).multiply(applyInternal(newParams));
+            }
             return FUNCTION_EXP.apply(FUNCTION_LN.apply(FUNCTION_ABS.apply(params[0])).multiply(params[1]));
         }
     });
@@ -359,12 +371,12 @@ public class StandardPlugin extends Plugin {
         @Override
         protected NumberInterface applyInternal(NumberInterface[] params) {
             NumberInterface pi = getPi(params[0].getClass());
-            NumberInterface twoPi = pi.multiply(new NaiveNumber(2).promoteTo(pi.getClass()));
+            NumberInterface twoPi = pi.multiply(fromInt(pi.getClass(), 2));
             NumberInterface theta = getSmallAngle(params[0], pi);
             //System.out.println(theta);
             if (theta.compareTo(pi.multiply(new NaiveNumber(1.5).promoteTo(twoPi.getClass()))) >= 0) {
                 theta = theta.subtract(twoPi);
-            } else if (theta.compareTo(pi.divide(new NaiveNumber(2).promoteTo(pi.getClass()))) > 0) {
+            } else if (theta.compareTo(pi.divide(fromInt(pi.getClass(), 2))) > 0) {
                 theta = pi.subtract(theta);
             }
             //System.out.println(theta);
@@ -382,7 +394,7 @@ public class StandardPlugin extends Plugin {
 
         @Override
         protected NumberInterface applyInternal(NumberInterface[] params) {
-            return functionSin.apply(getPi(params[0].getClass()).divide(new NaiveNumber(2).promoteTo(params[0].getClass()))
+            return functionSin.apply(getPi(params[0].getClass()).divide(fromInt(params[0].getClass(), 2))
                     .subtract(params[0]));
         }
     };
@@ -439,7 +451,7 @@ public class StandardPlugin extends Plugin {
 
         @Override
         protected NumberInterface applyInternal(NumberInterface[] params) {
-            return functionCos.apply(params[0]).divide(functionCos.apply(params[0]));
+            return functionCos.apply(params[0]).divide(functionSin.apply(params[0]));
         }
     };
 
@@ -470,7 +482,7 @@ public class StandardPlugin extends Plugin {
      * @return the maximum error.
      */
     private static NumberInterface getMaxError(NumberInterface number) {
-        return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.getMaxPrecision());
+        return fromInt(number.getClass(), 10).intPow(-number.getMaxPrecision());
     }
 
     /**
@@ -531,20 +543,20 @@ public class StandardPlugin extends Plugin {
         return theta;
     }
 
-    public static NumberInterface intPow(NumberInterface number, Class<? extends NumberInterface> numberClass, NumberInterface exponent) {
-        if (exponent.compareTo((new NaiveNumber(0)).promoteTo(numberClass)) == 0) {
-            return (new NaiveNumber(1)).promoteTo(numberClass);
+    /**
+     * Returns a number of class numType with value n.
+     * @param numType class of number to return.
+     * @param n value of returned number.
+     * @return numClass instance with value n.
+     */
+    private static NumberInterface fromInt(Class<? extends NumberInterface> numType, int n){
+        if(!integerValues.containsKey(numType)){
+            integerValues.put(numType, new HashMap<>());
         }
-        boolean takeReciprocal = exponent.compareTo((new NaiveNumber(0)).promoteTo(numberClass)) < 0;
-        exponent = FUNCTION_ABS.apply(exponent);
-        NumberInterface power = number;
-        for (NumberInterface currentExponent = (new NaiveNumber(1)).promoteTo(numberClass); currentExponent.compareTo(exponent) < 0; currentExponent = currentExponent.add((new NaiveNumber(1)).promoteTo(numberClass))) {
-            power = power.multiply(number);
+        if(!integerValues.get(numType).containsKey(n)){
+            integerValues.get(numType).put(n, new NaiveNumber(n).promoteTo(numType));
         }
-        if (takeReciprocal) {
-            power = (new NaiveNumber(1)).promoteTo(numberClass).divide(power);
-        }
-        return power;
+        return integerValues.get(numType).get(n);
     }
 
     @Override

src/test/java/org/nwapw/abacus/tests/CalculationTests.java

@@ -0,0 +1,104 @@
+package org.nwapw.abacus.tests;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.nwapw.abacus.Abacus;
+import org.nwapw.abacus.config.Configuration;
+import org.nwapw.abacus.number.NumberInterface;
+import org.nwapw.abacus.plugin.StandardPlugin;
+import org.nwapw.abacus.tree.TreeNode;
+
+public class CalculationTests {
+
+    private static Abacus abacus = new Abacus(new Configuration("precise", new String[]{}));
+
+    @BeforeClass
+    public static void prepareTests(){
+        abacus.getPluginManager().addInstantiated(new StandardPlugin(abacus.getPluginManager()));
+        abacus.getPluginManager().load();
+    }
+
+    private void testOutput(String input, String parseOutput, String output){
+        TreeNode parsedTree = abacus.parseString(input);
+        Assert.assertNotNull(parsedTree);
+        Assert.assertEquals(parsedTree.toString(), parseOutput);
+        NumberInterface result = abacus.evaluateTree(parsedTree);
+        Assert.assertNotNull(result);
+        Assert.assertTrue(result.toString().startsWith(output));
+    }
+
+    private void testEvalError(String input, String parseOutput){
+        TreeNode parsedTree = abacus.parseString(input);
+        Assert.assertNotNull(parsedTree);
+        Assert.assertEquals(parsedTree.toString(), parseOutput);
+        Assert.assertNull(abacus.evaluateTree(parsedTree));
+    }
+
+    @Test
+    public void testAddition(){
+        testOutput("9.5+10", "(9.5+10)", "19.5");
+    }
+
+    @Test
+    public void testSubtraction(){
+        testOutput("9.5-10", "(9.5-10)", "-0.5");
+    }
+
+    @Test
+    public void testMultiplication(){
+        testOutput("9.5*10", "(9.5*10)", "95");
+    }
+
+    @Test
+    public void testDivision(){
+        testOutput("9.5/2", "(9.5/2)", "4.75");
+    }
+
+    @Test
+    public void testNegation(){
+        testOutput("-9.5", "(9.5)`", "-9.5");
+    }
+
+    @Test
+    public void testFactorial(){
+        testOutput("7!", "(7)!", "5040");
+    }
+
+    @Test
+    public void testAbs(){
+        testOutput("abs(-1)", "abs((1)`)", "1");
+        testOutput("abs(1)", "abs(1)", "1");
+    }
+
+    @Test
+    public void testLn(){
+        testEvalError("ln(-1)", "ln((1)`)");
+        testOutput("ln2", "ln(2)", "0.6931471805599453094172321214581765680755");
+    }
+
+    @Test
+    public void testSqrt(){
+        testOutput("sqrt0", "sqrt(0)", "0");
+        testOutput("sqrt4", "sqrt(4)", "2");
+        testOutput("sqrt2", "sqrt(2)", "1.4142135623730950488016887242096980785696");
+    }
+
+    @Test
+    public void testExp(){
+        testOutput("exp0", "exp(0)", "1");
+        testOutput("exp1", "exp(1)", "2.718281828459045235360287471352662497757247");
+        testOutput("exp300", "exp(300)", "19424263952412559365842088360176992193662086");
+        testOutput("exp300", "exp(300)", "19424263952412559365842088360176992193662086");
+    }
+
+    @Test
+    public void testPow(){
+        testOutput("0^2", "(0^2)", "0");
+        testOutput("2^0", "(2^0)", "1");
+        testOutput("2^1", "(2^1)", "2");
+        testOutput("2^-1", "(2^(1)`)", "0.5");
+        testOutput("2^50", "(2^50)", "112589990684262");
+    }
+
+}

src/test/java/org/nwapw/abacus/tests/TokenizerTests.java

@@ -4,6 +4,7 @@ import org.junit.Assert;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.nwapw.abacus.Abacus;
+import org.nwapw.abacus.config.Configuration;
 import org.nwapw.abacus.function.Function;
 import org.nwapw.abacus.function.Operator;
 import org.nwapw.abacus.function.OperatorAssociativity;
@@ -18,7 +19,7 @@ import java.util.List;
 
 public class TokenizerTests {
 
-    private static Abacus abacus = new Abacus();
+    private static Abacus abacus = new Abacus(new Configuration("precise", new String[]{}));
     private static LexerTokenizer lexerTokenizer = new LexerTokenizer();
     private static Function subtractFunction = new Function() {
         @Override