DanilaFe/Abacus
1
0
Fork 0
mirror of https://github.com/DanilaFe/abacus synced 2024-11-17 16:09:32 -08:00
Code Issues Releases Wiki Activity

Format code.

Browse Source
This commit is contained in:
Danila Fedorin 2017-07-30 21:11:32 -07:00
parent 122874b97a
commit 3ce74303ed
39 changed files with 695 additions and 561 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/main/java/org/nwapw/abacus/Abacus.java
View File

@ -78,8 +78,19 @@ public class Abacus {
pluginManager.load();
}
public static void main(String[] args) {
try {
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (ClassNotFoundException | InstantiationException | UnsupportedLookAndFeelException | IllegalAccessException e) {
e.printStackTrace();
}
new Window(new Abacus()).setVisible(true);
}
/**
* Gets the current tree builder.
*
* @return the main tree builder in this abacus instance.
*/
public TreeBuilder getTreeBuilder() {
@ -88,6 +99,7 @@ public class Abacus {
/**
* Gets the current plugin manager,
*
* @return the plugin manager in this abacus instance.
*/
public PluginManager getPluginManager() {
@ -97,6 +109,7 @@ public class Abacus {
/**
* Get the reducer that is responsible for transforming
* an expression into a number.
*
* @return the number reducer in this abacus instance.
*/
public NumberReducer getNumberReducer() {
@ -105,6 +118,7 @@ public class Abacus {
/**
* Gets the configuration object associated with this instance.
*
* @return the configuration object.
*/
public ConfigurationObject getConfiguration() {
@ -114,6 +128,7 @@ public class Abacus {
/**
* Parses a string into a tree structure using the main
* tree builder.
*
* @param input the input string to parse
* @return the resulting tree, null if the tree builder or the produced tree are null.
*/
@ -124,6 +139,7 @@ public class Abacus {
/**
* Evaluates the given tree using the main
* number reducer.
*
* @param tree the tree to reduce, must not be null.
* @return the resulting number, or null of the reduction failed.
*/
@ -133,6 +149,7 @@ public class Abacus {
/**
* Creates a number from a string.
*
* @param numberString the string to create the number from.
* @return the resulting number.
*/
@ -148,14 +165,4 @@ public class Abacus {
}
return null;
}
public static void main(String[] args){
try {
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (ClassNotFoundException | InstantiationException | UnsupportedLookAndFeelException | IllegalAccessException e) {
e.printStackTrace();
}
new Window(new Abacus()).setVisible(true);
}
}

96
src/main/java/org/nwapw/abacus/config/ConfigurationObject.java
View File

@ -23,53 +23,9 @@ public class ConfigurationObject {
*/
private Configuration configuration;
/**
* Sets up the ConfigurationObject.
* different constructors do different things,
* but they all lead here.
* @param configuration the configuration to set up with.
*/
private void setup(Configuration configuration){
this.configuration = configuration;
}
/**
* Creates a default configuration.
* @return the newly created default configuration.
*/
private Configuration getDefaultConfig(){
configuration = new Configuration();
configuration.numberType = "naive";
return configuration;
}
/**
* Returns the implementation the user has requested to
* represent their numbers.
* @return the implementation name.
*/
public String getNumberImplementation() {
return configuration.numberType;
}
/**
* Saves the ConfigurationObject to the given file.
* @param toFile the file to save ot.
* @return true if the save succeed, false if otherwise.
*/
public boolean save(File toFile){
if(toFile.getParentFile() != null) toFile.getParentFile().mkdirs();
try {
TOML_WRITER.write(configuration, toFile);
return true;
} catch (IOException e) {
e.printStackTrace();
}
return false;
}
/**
* Creates a new configuration object with the given config.
*
* @param config the config to use.
*/
public ConfigurationObject(Configuration config) {
@ -80,6 +36,7 @@ public class ConfigurationObject {
* Create a configuration object by attempting to
* load a config from the given path, using the
* default configuration otherwise.
*
* @param path the path to attempt to load.
*/
public ConfigurationObject(File path) {
@ -102,4 +59,53 @@ public class ConfigurationObject {
setup(getDefaultConfig());
}
/**
* Sets up the ConfigurationObject.
* different constructors do different things,
* but they all lead here.
*
* @param configuration the configuration to set up with.
*/
private void setup(Configuration configuration) {
this.configuration = configuration;
}
/**
* Creates a default configuration.
*
* @return the newly created default configuration.
*/
private Configuration getDefaultConfig() {
configuration = new Configuration();
configuration.numberType = "naive";
return configuration;
}
/**
* Returns the implementation the user has requested to
* represent their numbers.
*
* @return the implementation name.
*/
public String getNumberImplementation() {
return configuration.numberType;
}
/**
* Saves the ConfigurationObject to the given file.
*
* @param toFile the file to save ot.
* @return true if the save succeed, false if otherwise.
*/
public boolean save(File toFile) {
if (toFile.getParentFile() != null) toFile.getParentFile().mkdirs();
try {
TOML_WRITER.write(configuration, toFile);
return true;
} catch (IOException e) {
e.printStackTrace();
}
return false;
}
}

3
src/main/java/org/nwapw/abacus/function/Function.java
View File

@ -23,6 +23,7 @@ public abstract class Function {
/**
* Checks whether the given params will work for the given function.
*
* @param params the given params
* @return true if the params can be used with this function.
*/
@ -31,6 +32,7 @@ public abstract class Function {
/**
* Internal apply implementation, which already receives appropriately promoted
* parameters that have bee run through matchesParams
*
* @param params the promoted parameters.
* @return the return value of the function.
*/
@ -38,6 +40,7 @@ public abstract class Function {
/**
* Function to check, promote arguments and run the function.
*
* @param params the raw input parameters.
* @return the return value of the function, or null if an error occurred.
*/

5
src/main/java/org/nwapw/abacus/function/Operator.java
View File

@ -24,6 +24,7 @@ public class Operator {
/**
* Creates a new operator with the given parameters.
*
* @param associativity the associativity of the operator.
* @param precedence the precedence of the operator.
* @param function the function that the operator calls.
@ -37,6 +38,7 @@ public class Operator {
/**
* Gets the operator's associativity.
*
* @return the associativity.
*/
public OperatorAssociativity getAssociativity() {
@ -45,6 +47,7 @@ public class Operator {
/**
* Gets the operator's type.
*
* @return the type.
*/
public OperatorType getType() {
@ -53,6 +56,7 @@ public class Operator {
/**
* Gets the operator's precedence.
*
* @return the precedence.
*/
public int getPrecedence() {
@ -61,6 +65,7 @@ public class Operator {
/**
* Gets the operator's function.
*
* @return the function.
*/
public Function getFunction() {

81
src/main/java/org/nwapw/abacus/lexing/Lexer.java
View File

@ -10,47 +10,11 @@ import java.util.*;
/**
* A lexer that can generate tokens of a given type given a list of regular expressions
* to operate on.
*
* @param <T> the type used to identify which match belongs to which pattern.
*/
public class Lexer<T> {
/**
* An entry that represents a pattern that has been registered with the lexer.
* @param <T> the type used to identify the pattern.
*/
private static class PatternEntry<T>{
/**
* The name of the entry.
*/
public String name;
/**
* The id of the entry.
*/
public T id;
/**
* Creates a new pattern entry with the given name and id.
* @param name the name of the pattern entry.
* @param id the id of the pattern entry.
*/
public PatternEntry(String name, T id){
this.name = name;
this.id = id;
}
@Override
public int hashCode() {
return Objects.hash(name, id);
}
@Override
public boolean equals(Object obj) {
return obj instanceof PatternEntry &&
((PatternEntry) obj).name.equals(name) &&
((PatternEntry) obj).id.equals(id);
}
}
/**
* The registered patterns.
*/
@ -65,6 +29,7 @@ public class Lexer<T> {
/**
* Registers a single pattern.
*
* @param pattern the pattern regex
* @param id the ID by which to identify the pattern.
*/
@ -75,6 +40,7 @@ public class Lexer<T> {
/**
* Unregisters a pattern.
*
* @param pattern the pattern to unregister
* @param id the ID by which to identify the pattern.
*/
@ -84,6 +50,7 @@ public class Lexer<T> {
/**
* Reads one token from the given string.
*
* @param from the string to read from
* @param startAt the index to start at
* @param compare the comparator used to sort tokens by their ID.
@ -122,6 +89,7 @@ public class Lexer<T> {
/**
* Reads all tokens from a string.
*
* @param from the string to start from.
* @param startAt the index to start at.
* @param compare the comparator used to sort matches by their IDs.
@ -141,4 +109,43 @@ public class Lexer<T> {
return matches;
}
/**
* An entry that represents a pattern that has been registered with the lexer.
*
* @param <T> the type used to identify the pattern.
*/
private static class PatternEntry<T> {
/**
* The name of the entry.
*/
public String name;
/**
* The id of the entry.
*/
public T id;
/**
* Creates a new pattern entry with the given name and id.
*
* @param name the name of the pattern entry.
* @param id the id of the pattern entry.
*/
public PatternEntry(String name, T id) {
this.name = name;
this.id = id;
}
@Override
public int hashCode() {
return Objects.hash(name, id);
}
@Override
public boolean equals(Object obj) {
return obj instanceof PatternEntry &&
((PatternEntry) obj).name.equals(name) &&
((PatternEntry) obj).id.equals(id);
}
}
}

1
src/main/java/org/nwapw/abacus/lexing/pattern/AnyNode.java
View File

@ -2,6 +2,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A pattern node that matches any character.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class AnyNode<T> extends PatternNode<T> {

3
src/main/java/org/nwapw/abacus/lexing/pattern/EndNode.java
View File

@ -2,6 +2,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A node that represents a successful match.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class EndNode<T> extends PatternNode<T> {
@ -13,6 +14,7 @@ public class EndNode<T> extends PatternNode<T> {
/**
* Creates a new end node with the given ID.
*
* @param patternId the pattern ID.
*/
public EndNode(T patternId) {
@ -21,6 +23,7 @@ public class EndNode<T> extends PatternNode<T> {
/**
* Gets the pattern ID.
*
* @return the pattern ID.
*/
public T getPatternId() {

2
src/main/java/org/nwapw/abacus/lexing/pattern/LinkNode.java
View File

@ -1,10 +1,10 @@
package org.nwapw.abacus.lexing.pattern;
import java.util.ArrayList;
import java.util.Collection;
/**
* A node that is used as structural glue in pattern compilation.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class LinkNode<T> extends PatternNode<T> {

4
src/main/java/org/nwapw/abacus/lexing/pattern/Match.java
View File

@ -2,6 +2,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A match that has been generated by the lexer.
*
* @param <T> the type used to represent the ID of the pattern this match belongs to.
*/
public class Match<T> {
@ -17,6 +18,7 @@ public class Match<T> {
/**
* Creates a new match with the given parameters.
*
* @param content the content of this match.
* @param type the type of the match.
*/
@ -27,6 +29,7 @@ public class Match<T> {
/**
* Gets the content of this match.
*
* @return the content.
*/
public String getContent() {
@ -35,6 +38,7 @@ public class Match<T> {
/**
* Gets the pattern type of the node.
*
* @return the ID of the pattern that this match matched.
*/
public T getType() {

85
src/main/java/org/nwapw/abacus/lexing/pattern/Pattern.java
View File

@ -8,6 +8,7 @@ import java.util.function.Function;
/**
* A pattern that can be compiled from a string and used in lexing.
*
* @param <T> the type that is used to identify and sort this pattern.
*/
public class Pattern<T> {
@ -40,9 +41,49 @@ public class Pattern<T> {
put('?', Pattern.this::transformQuestion);
}};
/**
* Creates / compiles a new pattern with the given id from the given string.
*
* @param from the string to compile a pattern from.
* @param id the ID to use.
*/
public Pattern(String from, T id) {
this.id = id;
index = 0;
source = from;
PatternChain<T> chain = parseSegment(false);
if (chain == null) {
head = null;
} else {
chain.append(new EndNode<>(id));
head = chain.head;
}
}
/**
* Removes all characters that are considered "special" from
* the given string.
*
* @param from the string to sanitize.
* @return the resulting string.
*/
public static String sanitize(String from) {
Pattern<Integer> pattern = new Pattern<>("", 0);
from = from.replace(".", "\\.");
from = from.replace("|", "\\|");
from = from.replace("(", "\\(");
from = from.replace(")", "\\)");
for (Character key : pattern.operations.keySet()) {
from = from.replace("" + key, "\\" + key);
}
return from;
}
/**
* A regex operator function that turns the chain
* into a one-or-more chain.
*
* @param chain the chain to transform.
* @return the modified chain.
*/
@ -54,6 +95,7 @@ public class Pattern<T> {
/**
* A regex operator function that turns the chain
* into a zero-or-more chain.
*
* @param chain the chain to transform.
* @return the modified chain.
*/
@ -72,6 +114,7 @@ public class Pattern<T> {
/**
* A regex operator function that turns the chain
* into a zero-or-one chain.
*
* @param chain the chain to transform.
* @return the modified chain.
*/
@ -88,6 +131,7 @@ public class Pattern<T> {
/**
* Combines a collection of chains into one OR chain.
*
* @param collection the collection of chains to combine.
* @return the resulting OR chain.
*/
@ -104,6 +148,7 @@ public class Pattern<T> {
/**
* Parses a single value from the input into a chain.
*
* @return the resulting chain, or null on error.
*/
private PatternChain<T> parseValue() {
@ -116,6 +161,7 @@ public class Pattern<T> {
/**
* Parses a [] range from the input into a chain.
*
* @return the resulting chain, or null on error.
*/
private PatternChain<T> parseOr() {
@ -142,6 +188,7 @@ public class Pattern<T> {
/**
* Parses a repeatable segment from the input into a chain
*
* @param isSubsegment whether the segment is a sub-expression "()", and therefore
* whether to expect a closing brace.
* @return the resulting chain, or null on error.
@ -210,48 +257,12 @@ public class Pattern<T> {
return fullChain;
}
/**
* Creates / compiles a new pattern with the given id from the given string.
* @param from the string to compile a pattern from.
* @param id the ID to use.
*/
public Pattern(String from, T id){
this.id = id;
index = 0;
source = from;
PatternChain<T> chain = parseSegment(false);
if(chain == null) {
head = null;
} else {
chain.append(new EndNode<>(id));
head = chain.head;
}
}
/**
* Gets the head PatternNode, for use in matching
*
* @return the pattern node.
*/
public PatternNode<T> getHead() {
return head;
}
/**
* Removes all characters that are considered "special" from
* the given string.
* @param from the string to sanitize.
* @return the resulting string.
*/
public static String sanitize(String from){
Pattern<Integer> pattern = new Pattern<>("", 0);
from = from.replace(".", "\\.");
from = from.replace("|", "\\|");
from = from.replace("(", "\\(");
from = from.replace(")", "\\)");
for(Character key : pattern.operations.keySet()){
from = from.replace("" + key, "\\" + key);
}
return from;
}
}

5
src/main/java/org/nwapw/abacus/lexing/pattern/PatternChain.java
View File

@ -3,6 +3,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A chain of nodes that can be treated as a single unit.
* Used during pattern compilation.
*
* @param <T> the type used to identify which pattern has been matched.
*/
public class PatternChain<T> {
@ -18,6 +19,7 @@ public class PatternChain<T> {
/**
* Creates a new chain with the given start and end.
*
* @param head the start of the chain.
* @param tail the end of the chain.
*/
@ -28,6 +30,7 @@ public class PatternChain<T> {
/**
* Creates a chain that starts and ends with the same node.
*
* @param node the node to use.
*/
public PatternChain(PatternNode<T> node) {
@ -45,6 +48,7 @@ public class PatternChain<T> {
* Appends the other chain to this one. This modifies
* the nodes, as well.
* If this chain is empty, it is set to the other.
*
* @param other the other chain to append.
*/
public void append(PatternChain<T> other) {
@ -61,6 +65,7 @@ public class PatternChain<T> {
* Appends a single node to this chain. This modifies
* the nodes, as well.
* If this chain is empty, it is set to the node.
*
* @param node the node to append to this chain.
*/
public void append(PatternNode<T> node) {

6
src/main/java/org/nwapw/abacus/lexing/pattern/PatternNode.java
View File

@ -1,6 +1,5 @@
package org.nwapw.abacus.lexing.pattern;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
@ -9,6 +8,7 @@ import java.util.Set;
* A base class for a pattern node. Provides all functions
* necessary for matching, and is constructed by a Pattern instance
* from a string.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class PatternNode<T> {
@ -29,6 +29,7 @@ public class PatternNode<T> {
/**
* Determines whether the current input character can
* be matched by this node.
*
* @param other the character being matched.
* @return true if the character can be matched, false otherwise.
*/
@ -38,6 +39,7 @@ public class PatternNode<T> {
/**
* If this node can be used as part of a range, returns that value.
*
* @return a NULL terminator if this character cannot be converted
* into a range bound, or the appropriate range bound if it can.
*/
@ -47,6 +49,7 @@ public class PatternNode<T> {
/**
* Adds this node in a collection of other nodes.
*
* @param into the collection to add into.
*/
public void addInto(Collection<PatternNode<T>> into) {
@ -55,6 +58,7 @@ public class PatternNode<T> {
/**
* Adds the node's children into a collection of other nodes.
*
* @param into the collection to add into.
*/
public void addOutputsInto(Collection<PatternNode<T>> into) {

2
src/main/java/org/nwapw/abacus/lexing/pattern/RangeNode.java
View File

@ -2,6 +2,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A node that matches a range of characters.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class RangeNode<T> extends PatternNode<T> {
@ -17,6 +18,7 @@ public class RangeNode<T> extends PatternNode<T> {
/**
* Creates a new range node from the given range.
*
* @param from the bottom bound of the range.
* @param to the top bound of hte range.
*/

2
src/main/java/org/nwapw/abacus/lexing/pattern/ValueNode.java
View File

@ -2,6 +2,7 @@ package org.nwapw.abacus.lexing.pattern;
/**
* A node that matches a single value.
*
* @param <T> the type that's used to tell which pattern this node belongs to.
*/
public class ValueNode<T> extends PatternNode<T> {
@ -13,6 +14,7 @@ public class ValueNode<T> extends PatternNode<T> {
/**
* Creates a new node that matches the given character.
*
* @param value
*/
public ValueNode(char value) {

41
src/main/java/org/nwapw/abacus/number/NaiveNumber.java
View File

@ -5,26 +5,6 @@ package org.nwapw.abacus.number;
*/
public class NaiveNumber implements NumberInterface {
/**
* The value of this number.
*/
private double value;
/**
* Creates a new NaiveNumber with the given string.
* @param value the value, which will be parsed as a double.
*/
public NaiveNumber(String value) {
this(Double.parseDouble(value));
}
/**
* Creates a new NaiveNumber with the given value.
* @param value the value to use.
*/
public NaiveNumber(double value) {
this.value = value;
}
/**
* The number zero.
*/
@ -33,6 +13,27 @@ public class NaiveNumber implements NumberInterface {
* The number one.
*/
public static final NaiveNumber ONE = new NaiveNumber(1);
/**
* The value of this number.
*/
private double value;
/**
* Creates a new NaiveNumber with the given string.
*
* @param value the value, which will be parsed as a double.
*/
public NaiveNumber(String value) {
this(Double.parseDouble(value));
}
/**
* Creates a new NaiveNumber with the given value.
*
* @param value the value to use.
*/
public NaiveNumber(double value) {
this.value = value;
}
@Override
public int getMaxPrecision() {

13
src/main/java/org/nwapw/abacus/number/NumberInterface.java
View File

@ -7,6 +7,7 @@ public interface NumberInterface {
/**
* The maximum precision to which this number operates.
*
* @return the precision.
*/
int getMaxPrecision();
@ -14,27 +15,34 @@ public interface NumberInterface {
/**
* Multiplies this number by another, returning
* a new number instance.
*
* @param multiplier the multiplier
* @return the result of the multiplication.
*/
NumberInterface multiply(NumberInterface multiplier);
/**
* Divides this number by another, returning
* a new number instance.
*
* @param divisor the divisor
* @return the result of the division.
*/
NumberInterface divide(NumberInterface divisor);
/**
* Adds this number to another, returning
* a new number instance.
*
* @param summand the summand
* @return the result of the summation.
*/
NumberInterface add(NumberInterface summand);
/**
* Subtracts another number from this number,
* a new number instance.
*
* @param subtrahend the subtrahend.
* @return the result of the subtraction.
*/
@ -43,12 +51,14 @@ public interface NumberInterface {
/**
* Returns a new instance of this number with
* the sign flipped.
*
* @return the new instance.
*/
NumberInterface negate();
/**
* Raises this number to an integer power.
*
* @param exponent the exponent to which to take the number.
* @return the resulting value.
*/
@ -56,6 +66,7 @@ public interface NumberInterface {
/**
* Compares this number to another.
*
* @param number the number to compare to.
* @return same as Integer.compare();
*/
@ -63,12 +74,14 @@ public interface NumberInterface {
/**
* Same as Math.signum().
*
* @return 1 if this number is positive, -1 if this number is negative, 0 if this number is 0.
*/
int signum();
/**
* Promotes this class to another number class.
*
* @param toClass the class to promote to.
* @return the resulting new instance.
*/

2
src/main/java/org/nwapw/abacus/number/PreciseNumber.java
View File

@ -25,6 +25,7 @@ public class PreciseNumber implements NumberInterface{
/**
* Constructs a precise number from the given string.
*
* @param string a string representation of the number meeting the same conditions
* as the BidDecimal(String) constructor.
*/
@ -34,6 +35,7 @@ public class PreciseNumber implements NumberInterface{
/**
* Constructs a precise number from the given BigDecimal.
*
* @param value a BigDecimal object representing the value of the number.
*/
public PreciseNumber(BigDecimal value) {

2
src/main/java/org/nwapw/abacus/parsing/Parser.java
View File

@ -7,12 +7,14 @@ import java.util.List;
/**
* An itnerface that provides the ability to convert a list of tokens
* into a parse tree.
*
* @param <T> the type of tokens accepted by this parser.
*/
public interface Parser<T> {
/**
* Constructs a tree out of the given tokens.
*
* @param tokens the tokens to construct a tree from.
* @return the constructed tree, or null on error.
*/

3
src/main/java/org/nwapw/abacus/parsing/ShuntingYardParser.java
View File

@ -36,6 +36,7 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
/**
* Creates a new Shunting Yard parser with the given Abacus instance.
*
* @param abacus the abacus instance.
*/
public ShuntingYardParser(Abacus abacus) {
@ -47,6 +48,7 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
/**
* Rearranges tokens into a postfix list, using Shunting Yard.
*
* @param from the tokens to be rearranged.
* @return the resulting list of rearranged tokens.
*/
@ -110,6 +112,7 @@ public class ShuntingYardParser implements Parser<Match<TokenType>>, PluginListe
/**
* Constructs a tree recursively from a list of tokens.
*
* @param matches the list of tokens from the source string.
* @return the construct tree expression.
*/

2
src/main/java/org/nwapw/abacus/parsing/Tokenizer.java
View File

@ -4,12 +4,14 @@ import java.util.List;
/**
* Interface that provides the ability to convert a string into a list of tokens.
*
* @param <T> the type of the tokens produced.
*/
public interface Tokenizer<T> {
/**
* Converts a string into tokens.
*
* @param string the string to convert.
* @return the list of tokens, or null on error.
*/

3
src/main/java/org/nwapw/abacus/parsing/TreeBuilder.java
View File

@ -10,6 +10,7 @@ import java.util.List;
* working with any parameters at all, and the generics
* in this class are used only to ensure the tokenizer and parser
* are of the same type.
*
* @param <T> the type of tokens created by the tokenizer and used by the parser.
*/
public class TreeBuilder<T> {
@ -25,6 +26,7 @@ public class TreeBuilder<T> {
/**
* Create a new Tree Builder with the given tokenizer and parser
*
* @param tokenizer the tokenizer to turn strings into tokens
* @param parser the parser to turn tokens into a tree
*/
@ -35,6 +37,7 @@ public class TreeBuilder<T> {
/**
* Parse the given string into a tree.
*
* @param input the string to parse into a tree.
* @return the resulting tree.
*/

3
src/main/java/org/nwapw/abacus/plugin/ClassFinder.java
View File

@ -20,6 +20,7 @@ public class ClassFinder {
/**
* Loads all the plugin classes from the given plugin folder.
*
* @param filePath the path for the plugin folder.
* @return the list of all loaded classes.
* @throws IOException thrown if an error occurred scanning the plugin folder.
@ -31,6 +32,7 @@ public class ClassFinder {
/**
* Loads all the plugin classes from the given plugin folder.
*
* @param pluginFolderPath the folder in which to look for plugins.
* @return the list of all loaded classes.
* @throws IOException thrown if an error occurred scanning the plugin folder.
@ -51,6 +53,7 @@ public class ClassFinder {
/**
* Loads the classes from a single path, given by the file.
*
* @param jarLocation the location of the jar to load.
* @return the list of loaded classes loaded from the jar.
* @throws IOException thrown if there was an error reading the file

15
src/main/java/org/nwapw/abacus/plugin/Plugin.java
View File

@ -39,10 +39,12 @@ public abstract class Plugin {
*/
private boolean enabled;
private Plugin(){ }
private Plugin() {
}
/**
* Creates a new plugin with the given PluginManager.
*
* @param manager the manager controlling this plugin.
*/
public Plugin(PluginManager manager) {
@ -55,6 +57,7 @@ public abstract class Plugin {
/**
* Gets the list of functions provided by this plugin.
*
* @return the list of registered functions.
*/
public final Set<String> providedFunctions() {
@ -63,6 +66,7 @@ public abstract class Plugin {
/**
* Gets the list of functions provided by this plugin.
*
* @return the list of registered functions.
*/
public final Set<String> providedOperators() {
@ -71,6 +75,7 @@ public abstract class Plugin {
/**
* Gets the list of all numbers provided by this plugin.
*
* @return the list of registered numbers.
*/
public final Set<String> providedNumbers() {
@ -79,6 +84,7 @@ public abstract class Plugin {
/**
* Gets a function under the given function name.
*
* @param functionName the name of the function to get
* @return the function, or null if this plugin doesn't provide it.
*/
@ -88,6 +94,7 @@ public abstract class Plugin {
/**
* Gets an operator under the given operator name.
*
* @param operatorName the name of the operator to get.
* @return the operator, or null if this plugin doesn't provide it.
*/
@ -97,6 +104,7 @@ public abstract class Plugin {
/**
* Gets the class under the given name.
*
* @param numberName the name of the class.
* @return the class, or null if the plugin doesn't provide it.
*/
@ -129,6 +137,7 @@ public abstract class Plugin {
/**
* To be used in load(). Registers a function abstract class with the
* plugin internally, which makes it accessible to the plugin manager.
*
* @param name the name to register by.
* @param toRegister the function implementation.
*/
@ -140,6 +149,7 @@ public abstract class Plugin {
* To be used in load(). Registers an operator abstract class
* with the plugin internally, which makes it accessible to
* the plugin manager.
*
* @param name the name of the operator.
* @param operator the operator to register.
*/
@ -152,6 +162,7 @@ public abstract class Plugin {
* with the plugin internally, which makes it possible
* for the user to select it as an "implementation" for the
* number that they would like to use.
*
* @param name the name to register it under.
* @param toRegister the class to register.
*/
@ -163,6 +174,7 @@ public abstract class Plugin {
* Searches the PluginManager for the given function name.
* This can be used by the plugins internally in order to call functions
* they do not provide.
*
* @param name the name for which to search
* @return the resulting function, or null if none was found for that name.
*/
@ -174,6 +186,7 @@ public abstract class Plugin {
* Searches the PluginManager for the given operator name.
* This can be used by the plugins internally in order to call
* operations they do not provide.
*
* @param name the name for which to search
* @return the resulting operator, or null if none was found for that name.
*/

2
src/main/java/org/nwapw/abacus/plugin/PluginListener.java
View File

@ -7,12 +7,14 @@ public interface PluginListener {
/**
* Called when the PluginManager loads plugins.
*
* @param manager the manager that fired the event.
*/
public void onLoad(PluginManager manager);
/**
* Called when the PluginManager unloads all its plugins.
*
* @param manager the manager that fired the event.
*/
public void onUnload(PluginManager manager);

12
src/main/java/org/nwapw/abacus/plugin/PluginManager.java
View File

@ -73,6 +73,7 @@ public class PluginManager {
* list of items of the type using the setFunction and getting the value
* of it is available via getFunction. If the value is contained
* in the cache, it returns the cached value instead.
*
* @param plugins the plugin list to search.
* @param cache the cache to use
* @param setFunction the function to retrieve a set of available T's from the plugin
@ -98,8 +99,10 @@ public class PluginManager {
cache.put(name, loadedValue);
return loadedValue;
}
/**
* Gets a function under the given name.
*
* @param name the name of the function
* @return the function under the given name.
*/
@ -109,6 +112,7 @@ public class PluginManager {
/**
* Gets an operator under the given name.
*
* @param name the name of the operator.
* @return the operator under the given name.
*/
@ -118,6 +122,7 @@ public class PluginManager {
/**
* Gets a numer implementation under the given name.
*
* @param name the name of the implementation.
* @return the implementation class
*/
@ -127,6 +132,7 @@ public class PluginManager {
/**
* Adds an instance of Plugin that already has been instantiated.
*
* @param plugin the plugin to add.
*/
public void addInstantiated(Plugin plugin) {
@ -138,6 +144,7 @@ public class PluginManager {
/**
* Instantiates a class of plugin, and adds it to this
* plugin manager.
*
* @param newClass the new class to instantiate.
*/
public void addClass(Class<?> newClass) {
@ -183,6 +190,7 @@ public class PluginManager {
/**
* Gets all the functions loaded by the Plugin Manager.
*
* @return the set of all functions that were loaded.
*/
public Set<String> getAllFunctions() {
@ -191,6 +199,7 @@ public class PluginManager {
/**
* Gets all the operators loaded by the Plugin Manager.
*
* @return the set of all operators that were loaded.
*/
public Set<String> getAllOperators() {
@ -199,6 +208,7 @@ public class PluginManager {
/**
* Gets all the number implementations loaded by the Plugin Manager
*
* @return the set of all implementations that were loaded
*/
public Set<String> getAllNumbers() {
@ -207,6 +217,7 @@ public class PluginManager {
/**
* Adds a plugin change listener to this plugin manager.
*
* @param listener the listener to add.
*/
public void addListener(PluginListener listener) {
@ -215,6 +226,7 @@ public class PluginManager {
/**
* Remove the plugin change listener from this plugin manager.
*
* @param listener the listener to remove.
*/
public void removeListener(PluginListener listener) {

140
src/main/java/org/nwapw/abacus/plugin/StandardPlugin.java
View File

@ -72,17 +72,6 @@ public class StandardPlugin extends Plugin {
return product;
}
});
public static final Operator OP_CARET = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 2, new Function() {
@Override
protected boolean matchesParams(NumberInterface[] params) {
return params.length == 2;
}
@Override
protected NumberInterface applyInternal(NumberInterface[] params) {
return FUNCTION_EXP.apply(FUNCTION_LN.apply(params[0]).multiply(params[1]));
}
});
public static final Operator OP_FACTORIAL = new Operator(OperatorAssociativity.RIGHT, OperatorType.UNARY_POSTFIX, 0, new Function() {
//private HashMap<Class<? extends NumberInterface>, ArrayList<NumberInterface>> storedList = new HashMap<Class<? extends NumberInterface>, ArrayList<NumberInterface>>();
@Override
@ -155,8 +144,7 @@ public class StandardPlugin extends Plugin {
break;
//No infinite loop for you.
}
}
else {
} else {
param = param.multiply(new NaiveNumber(2).promoteTo(param.getClass()));
powersOf2--;
if (param.subtract(NaiveNumber.ONE.promoteTo(param.getClass())).signum() != 1) {
@ -211,6 +199,17 @@ public class StandardPlugin extends Plugin {
return sum;
}
};
public static final Operator OP_CARET = new Operator(OperatorAssociativity.RIGHT, OperatorType.BINARY_INFIX, 2, new Function() {
@Override
protected boolean matchesParams(NumberInterface[] params) {
return params.length == 2;
}
@Override
protected NumberInterface applyInternal(NumberInterface[] params) {
return FUNCTION_EXP.apply(FUNCTION_LN.apply(params[0]).multiply(params[1]));
}
});
public static final Function FUNCTION_SQRT = new Function() {
@Override
protected boolean matchesParams(NumberInterface[] params) {
@ -227,6 +226,65 @@ public class StandardPlugin extends Plugin {
super(manager);
}
/**
* 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 the nth term of the series.
*/
private static NumberInterface getExpSeriesTerm(int n, NumberInterface x) {
return x.intPow(n).divide(OP_FACTORIAL.getFunction().apply((new NaiveNumber(n)).promoteTo(x.getClass())));
}
/**
* Returns the number of terms needed to evaluate the exponential function (at x)
* 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 the number of terms needed to evaluated the exponential function.
*/
private static int getNTermsExp(NumberInterface maxError, NumberInterface x) {
//We need n such that |x^(n+1)| <= (n+1)! * maxError
//The variables LHS and RHS refer to the above inequality.
int n = 0;
x = FUNCTION_ABS.apply(x);
NumberInterface LHS = x, RHS = maxError;
while (LHS.compareTo(RHS) > 0) {
n++;
LHS = LHS.multiply(x);
RHS = RHS.multiply(new NaiveNumber(n + 1).promoteTo(RHS.getClass()));
}
return n;
}
/**
* Returns a partial sum of a series whose terms are given by the nthTermFunction, evaluated at x.
*
* @param x the value at which the series is evaluated.
* @param nthTermFunction the function that returns the nth term of the series, in the format term(x, n).
* @param n the number of terms in the partial sum.
* @return the value of the partial sum that has the same class as x.
*/
private static NumberInterface sumSeries(NumberInterface x, BiFunction<Integer, NumberInterface, NumberInterface> nthTermFunction, int n) {
NumberInterface sum = NaiveNumber.ZERO.promoteTo(x.getClass());
for (int i = 0; i <= n; i++) {
sum = sum.add(nthTermFunction.apply(i, x));
}
return sum;
}
/**
* 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 the maximum error.
*/
private static NumberInterface getMaxError(NumberInterface number) {
return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.getMaxPrecision());
}
@Override
public void onEnable() {
registerNumber("naive", NaiveNumber.class);
@ -250,60 +308,4 @@ 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 the nth term of the series.
*/
private static NumberInterface getExpSeriesTerm(int n, NumberInterface x){
return x.intPow(n).divide(OP_FACTORIAL.getFunction().apply((new NaiveNumber(n)).promoteTo(x.getClass())));
}
/**
* Returns the number of terms needed to evaluate the exponential function (at x)
* 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 the number of terms needed to evaluated the exponential function.
*/
private static int getNTermsExp(NumberInterface maxError, NumberInterface x) {
//We need n such that |x^(n+1)| <= (n+1)! * maxError
//The variables LHS and RHS refer to the above inequality.
int n = 0;
x = FUNCTION_ABS.apply(x);
NumberInterface LHS = x, RHS = maxError;
while (LHS.compareTo(RHS) > 0) {
n++;
LHS = LHS.multiply(x);
RHS = RHS.multiply(new NaiveNumber(n + 1).promoteTo(RHS.getClass()));
}
return n;
}
/**
* Returns a partial sum of a series whose terms are given by the nthTermFunction, evaluated at x.
* @param x the value at which the series is evaluated.
* @param nthTermFunction the function that returns the nth term of the series, in the format term(x, n).
* @param n the number of terms in the partial sum.
* @return the value of the partial sum that has the same class as x.
*/
private static NumberInterface sumSeries(NumberInterface x, BiFunction<Integer, NumberInterface, NumberInterface> nthTermFunction, int n){
NumberInterface sum = NaiveNumber.ZERO.promoteTo(x.getClass());
for(int i = 0; i <= n; i++){
sum = sum.add(nthTermFunction.apply(i, x));
}
return sum;
}
/**
* 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 the maximum error.
*/
private static NumberInterface getMaxError(NumberInterface number){
return (new NaiveNumber(10)).promoteTo(number.getClass()).intPow(-number.getMaxPrecision());
}
}

10
src/main/java/org/nwapw/abacus/tree/BinaryInfixNode.java
View File

@ -18,11 +18,13 @@ public class BinaryInfixNode extends TreeNode {
*/
private TreeNode right;
private BinaryInfixNode() {}
private BinaryInfixNode() {
}
/**
* Creates a new operation node with the given operation
* and no child nodes.
*
* @param operation the operation.
*/
public BinaryInfixNode(String operation) {
@ -32,6 +34,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Creates a new operation node with the given operation
* and child nodes.
*
* @param operation the operation.
* @param left the left node of the expression.
* @param right the right node of the expression.
@ -44,6 +47,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Gets the operation in this node.
*
* @return the operation in this node.
*/
public String getOperation() {
@ -52,6 +56,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Gets the left sub-expression of this node.
*
* @return the left node.
*/
public TreeNode getLeft() {
@ -60,6 +65,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Sets the left sub-expression of this node.
*
* @param left the sub-expression to apply.
*/
public void setLeft(TreeNode left) {
@ -68,6 +74,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Gets the right sub-expression of this node.
*
* @return the right node.
*/
public TreeNode getRight() {
@ -76,6 +83,7 @@ public class BinaryInfixNode extends TreeNode {
/**
* Sets the right sub-expression of this node.
*
* @param right the sub-expression to apply.
*/
public void setRight(TreeNode right) {

7
src/main/java/org/nwapw/abacus/tree/FunctionNode.java
View File

@ -20,10 +20,12 @@ public class FunctionNode extends TreeNode {
/**
* Creates a function node with no function.
*/
private FunctionNode() { }
private FunctionNode() {
}
/**
* Creates a new function node with the given function name.
*
* @param function the function name.
*/
public FunctionNode(String function) {
@ -33,6 +35,7 @@ public class FunctionNode extends TreeNode {
/**
* Gets the function name for this node.
*
* @return the function name.
*/
public String getFunction() {
@ -41,6 +44,7 @@ public class FunctionNode extends TreeNode {
/**
* Adds a child to the end of this node's child list.
*
* @param node the child to add.
*/
public void appendChild(TreeNode node) {
@ -49,6 +53,7 @@ public class FunctionNode extends TreeNode {
/**
* Adds a new child to the beginning of this node's child list.
*
* @param node the node to add.
*/
public void prependChild(TreeNode node) {

3
src/main/java/org/nwapw/abacus/tree/NumberNode.java
View File

@ -1,6 +1,5 @@
package org.nwapw.abacus.tree;
import org.nwapw.abacus.number.NaiveNumber;
import org.nwapw.abacus.number.NumberInterface;
/**
@ -22,6 +21,7 @@ public class NumberNode extends TreeNode {
/**
* Creates a new number node with the given double value.
*
* @param newNumber the number for which to create a number node.
*/
public NumberNode(NumberInterface newNumber) {
@ -30,6 +30,7 @@ public class NumberNode extends TreeNode {
/**
* Gets the number value of this node.
*
* @return the number value of this node.
*/
public NumberInterface getNumber() {

1
src/main/java/org/nwapw/abacus/tree/NumberReducer.java
View File

@ -17,6 +17,7 @@ public class NumberReducer implements Reducer<NumberInterface> {
/**
* Creates a new number reducer.
*
* @param abacus the calculator instance.
*/
public NumberReducer(Abacus abacus) {

2
src/main/java/org/nwapw/abacus/tree/Reducer.java
View File

@ -2,12 +2,14 @@ package org.nwapw.abacus.tree;
/**
* Interface used to reduce a tree into a single value.
*
* @param <T> the value to reduce into.
*/
public interface Reducer<T> {
/**
* Reduces the given tree into a single value of type T.
*
* @param node the node being passed in to be reduced.
* @param children the already-reduced children of this node.
* @return the resulting value from the reduce.

1
src/main/java/org/nwapw/abacus/tree/TokenType.java
View File

@ -16,6 +16,7 @@ public enum TokenType {
/**
* Creates a new token type with the given priority.
*
* @param priority the priority of this token type.
*/
TokenType(int priority) {

7
src/main/java/org/nwapw/abacus/tree/TreeNode.java
View File

@ -1,11 +1,5 @@
package org.nwapw.abacus.tree;
import org.nwapw.abacus.function.OperatorAssociativity;
import org.nwapw.abacus.lexing.Lexer;
import org.nwapw.abacus.lexing.pattern.Match;
import java.util.*;
/**
* An abstract class that represents an expression tree node.
*/
@ -13,6 +7,7 @@ public abstract class TreeNode {
/**
* The function that reduces a tree to a single vale.
*
* @param reducer the reducer used to reduce the tree.
* @param <T> the type the reducer produces.
* @return the result of the reduction, or null on error.

4
src/main/java/org/nwapw/abacus/tree/UnaryPrefixNode.java
View File

@ -13,6 +13,7 @@ public class UnaryPrefixNode extends TreeNode {
/**
* Creates a new node with the given operation and no child.
*
* @param operation the operation for this node.
*/
public UnaryPrefixNode(String operation) {
@ -21,6 +22,7 @@ public class UnaryPrefixNode extends TreeNode {
/**
* Creates a new node with the given operation and child.
*
* @param operation the operation for this node.
* @param applyTo the node to apply the function to.
*/
@ -38,6 +40,7 @@ public class UnaryPrefixNode extends TreeNode {
/**
* Gets the operation of this node.
*
* @return the operation this node performs.
*/
public String getOperation() {
@ -46,6 +49,7 @@ public class UnaryPrefixNode extends TreeNode {
/**
* Gets the node to which this node's operation applies.
*
* @return the tree node to which the operation will be applied.
*/
public TreeNode getApplyTo() {

50
src/main/java/org/nwapw/abacus/window/HistoryTableModel.java
View File

@ -2,9 +2,7 @@ package org.nwapw.abacus.window;
import org.nwapw.abacus.tree.TreeNode;
import javax.swing.event.TableModelListener;
import javax.swing.table.AbstractTableModel;
import javax.swing.table.TableModel;
import java.util.ArrayList;
import java.util.List;
@ -31,30 +29,6 @@ public class HistoryTableModel extends AbstractTableModel {
TreeNode.class,
String.class
};
/**
* Class used specifically to hold data about
* the previous entries into the calculator.
*/
public static class HistoryEntry {
public String input;
public TreeNode parsedInput;
public String output;
public HistoryEntry(String input, TreeNode parsedInput, String output){
this.input = input;
this.parsedInput = parsedInput;
this.output = output;
}
Object nthValue(int n){
if(n == 0) return input;
if(n == 1) return parsedInput;
if(n == 2) return output;
return null;
}
}
/**
* The list of entries.
*/
@ -69,6 +43,7 @@ public class HistoryTableModel extends AbstractTableModel {
/**
* Adds an entry to the model.
*
* @param entry the entry to add.
*/
public void addEntry(HistoryEntry entry) {
@ -105,4 +80,27 @@ public class HistoryTableModel extends AbstractTableModel {
return entries.get(rowIndex).nthValue(columnIndex);
}
/**
* Class used specifically to hold data about
* the previous entries into the calculator.
*/
public static class HistoryEntry {
public String input;
public TreeNode parsedInput;
public String output;
public HistoryEntry(String input, TreeNode parsedInput, String output) {
this.input = input;
this.parsedInput = parsedInput;
this.output = output;
}
Object nthValue(int n) {
if (n == 0) return input;
if (n == 1) return parsedInput;
if (n == 2) return output;
return null;
}
}
}

1
src/main/java/org/nwapw/abacus/window/Window.java
View File

@ -146,6 +146,7 @@ public class Window extends JFrame {
/**
* Creates a new window with the given manager.
*
* @param abacus the calculator instance to interact with other components.
*/
public Window(Abacus abacus) {