diff options
Diffstat (limited to 'BJC-Utils2/src/examples/java/bjc/utils')
9 files changed, 115 insertions, 8 deletions
diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/BinarySearcher.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/BinarySearcher.java index 99a1b5e..18fdbc6 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/BinarySearcher.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/BinarySearcher.java @@ -12,6 +12,10 @@ import bjc.utils.funcdata.bst.BinarySearchTree; * */ public class BinarySearcher { + /** + * Main method of class + * @param args Unused CLI args + */ public static void main(String[] args) { Scanner s = new Scanner(System.in); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageState.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageState.java index 82dccf5..5513d62 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageState.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageState.java @@ -6,12 +6,25 @@ import bjc.utils.data.Pair; import bjc.utils.dice.DiceExpressionParser; import bjc.utils.dice.ast.DiceASTExpression; +/** + * Internal state of the AST-based dice langugae + * @author ben + * + */ public class DiceASTLanguageState extends Pair<DiceExpressionParser, Map<String, DiceASTExpression>> { + /** + * Create a new state + */ public DiceASTLanguageState() { } + /** + * Create a new state with the given contents + * @param left The parser to use + * @param right The enviroment to use + */ public DiceASTLanguageState(DiceExpressionParser left, Map<String, DiceASTExpression> right) { super(left, right); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageTest.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageTest.java index 548543c..583c7a6 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageTest.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceASTLanguageTest.java @@ -17,6 +17,12 @@ import bjc.utils.dice.ast.VariableDiceNode; import bjc.utils.funcdata.ITreePart.TreeLinearizationMethod; import bjc.utils.parserutils.AST; +/** + * A test of the AST based dice language + * + * @author ben + * + */ public class DiceASTLanguageTest { private static final class LastChecker implements Consumer<IDiceASTNode> { @@ -59,14 +65,19 @@ public class DiceASTLanguageTest { }); } - public static void printEnv(String ln, DiceASTLanguageState stat) { + /** + * @param ln + * Unused parameter, kept in place to conform to expected + * type sig + */ + private static void printEnv(String ln, DiceASTLanguageState stat) { System.out.println("Printing enviroment for debugging purposes."); stat.doWith((dep, env) -> env.forEach((key, exp) -> System.out .println("\tKey: " + key + "\tExp: " + exp.toString()))); } - public static void rollReference(String ln, + private static void rollReference(String ln, DiceASTLanguageState stat) { String[] strangs = ln.split(" "); @@ -85,6 +96,12 @@ public class DiceASTLanguageTest { } } + /** + * Main method of class + * + * @param args + * Unused CLI args + */ public static void main(String[] args) { Scanner scn = new Scanner(System.in); int i = 0; diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageState.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageState.java index 88c7e50..5f1bcc9 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageState.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageState.java @@ -6,12 +6,29 @@ import bjc.utils.data.Pair; import bjc.utils.dice.DiceExpressionParser; import bjc.utils.dice.IDiceExpression; +/** + * Internal state of dice language + * + * @author ben + * + */ public class DiceLanguageState extends Pair<DiceExpressionParser, Map<String, IDiceExpression>> { + /** + * Create a new state + */ public DiceLanguageState() { } + /** + * Create a new state with the desired parameters + * + * @param left + * The parser to use + * @param right + * The enviroment to use + */ public DiceLanguageState(DiceExpressionParser left, Map<String, IDiceExpression> right) { super(left, right); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageTest.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageTest.java index 6312201..3ae79f2 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageTest.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/DiceLanguageTest.java @@ -8,6 +8,12 @@ import java.util.function.BiConsumer; import bjc.utils.dice.DiceExpressionParser; import bjc.utils.dice.IDiceExpression; +/** + * Test of dice language + * + * @author ben + * + */ public class DiceLanguageTest { private static Map<String, BiConsumer<String, DiceLanguageState>> acts; @@ -18,14 +24,18 @@ public class DiceLanguageTest { acts.put("env", DiceLanguageTest::printEnv); } - public static void printEnv(String ln, DiceLanguageState stat) { + /** + * @param ln + * Unused parameter, kept to comply with expected type sig + */ + private static void printEnv(String ln, DiceLanguageState stat) { System.out.println("Printing enviroment for debugging purposes."); stat.doWith((dep, env) -> env.forEach((key, exp) -> System.out .println("\tKey: " + key + "\tExp: " + exp.toString()))); } - public static void rollReference(String ln, DiceLanguageState stat) { + private static void rollReference(String ln, DiceLanguageState stat) { String[] strangs = ln.split(" "); System.out.println("\tRolling dice expression " + strangs[1] + " " @@ -33,8 +43,8 @@ public class DiceLanguageTest { int nRolls = Integer.parseInt(strangs[2]); - IDiceExpression dexp = stat - .merge((dep, env) -> env.get(strangs[1])); + IDiceExpression dexp = + stat.merge((dep, env) -> env.get(strangs[1])); for (int i = 1; i <= nRolls; i++) { int roll = dexp.roll(); @@ -43,6 +53,12 @@ public class DiceLanguageTest { } } + /** + * Main method + * + * @param args + * Unused CLI args + */ public static void main(String[] args) { Scanner scn = new Scanner(System.in); int i = 0; @@ -64,7 +80,7 @@ public class DiceLanguageTest { System.out.println("\tParsed: " + exp.toString()); System.out.println("\tSample Roll: " + exp.roll()); - + env.put("last", exp); } diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/ShuntTester.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/ShuntTester.java index d535a70..7b69c95 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/ShuntTester.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/ShuntTester.java @@ -6,7 +6,19 @@ import bjc.utils.funcdata.FunctionalList; import bjc.utils.funcdata.FunctionalStringTokenizer; import bjc.utils.parserutils.ShuntingYard; +/** + * Test of shunting yard + * + * @author ben + * + */ public class ShuntTester { + /** + * Main method + * + * @param args + * Unused CLI args + */ public static void main(String[] args) { Scanner scn = new Scanner(System.in); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/TreeConstructTest.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/TreeConstructTest.java index ad8bf36..2b40268 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/TreeConstructTest.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/parsing/TreeConstructTest.java @@ -9,7 +9,16 @@ import bjc.utils.parserutils.AST; import bjc.utils.parserutils.ShuntingYard; import bjc.utils.parserutils.TreeConstructor; +/** + * Test of tree constructor + * @author ben + * + */ public class TreeConstructTest { + /** + * Main method + * @param args Unused CLI args + */ public static void main(String[] args) { Scanner scn = new Scanner(System.in); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/DiabloItemGen.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/DiabloItemGen.java index 9450416..1b5b37c 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/DiabloItemGen.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/DiabloItemGen.java @@ -62,6 +62,12 @@ public class DiabloItemGen { addCase(rn, 10, "of Ability"); } + /** + * Main Method + * + * @param args + * Unused CLI args + */ public static void main(String[] args) { parts.addRule("<item>"); addItemRules(); diff --git a/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/RandomStringExamples.java b/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/RandomStringExamples.java index 7a9cdb4..95ff5ba 100644 --- a/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/RandomStringExamples.java +++ b/BJC-Utils2/src/examples/java/bjc/utils/examples/rangen/RandomStringExamples.java @@ -4,9 +4,21 @@ import bjc.utils.funcdata.FunctionalList; import bjc.utils.funcdata.FunctionalStringTokenizer; import bjc.utils.gen.RandomGrammar; +/** + * Examples of random grammar + * + * @author ben + * + */ public class RandomStringExamples { private static RandomGrammar<String> rg; + /** + * Main method + * + * @param args + * Unused CLI args + */ public static void main(String[] args) { rg = new RandomGrammar<>(); @@ -43,7 +55,8 @@ public class RandomStringExamples { } private static void addRule(String rule, String... cases) { - FunctionalList<FunctionalList<String>> cses = new FunctionalList<>(); + FunctionalList<FunctionalList<String>> cses = + new FunctionalList<>(); for (String strang : cases) { cses.add(FunctionalStringTokenizer.fromString(strang) |