Merge pull request #87 from arnaud-m/v0.5.1-beta

Check code coverage and good practices and clean up
- close #84

Author: arnaud-m

.gitignore

@@ -2,13 +2,13 @@
 
 src/main/benchmarks/instances/
 src/main/benchmarks/algorithms/
-src/main/benchmarks/results/
-src/main/benchmarks/results-cryptarithms/
-src/main/benchmarks/results-archive/
+src/main/benchmarks/results*/
+src/main/benchmarks/results*.tar.gz
 src/main/benchmarks/solver.sh
 src/main/benchmarks/words
 src/main/benchmarks/oar-stderr.log
-src/main/benchmarks/nohup.out 
+src/main/benchmarks/nohup.out
+src/main/benchmarks/classify-additions.awk 
 
 #### joe made this: http://goel.io/joe
 

README.org

@@ -17,6 +17,7 @@ It is based on [[https://github.com/chocoteam/choco-solver][choco-solver]] which
   - [[http://www.cadaeic.net/alphas.htm][An Alphametic Page]], Mike Keith - a must for alphametic lovers.
   - [[http://cryptarithms.awardspace.us/][Cryptarithms Online]], Jorge A. C. B. Soares - it contains the Sphinx collection, links, books.
   - [[http://www.tkcs-collins.com/truman/alphamet/alphamet.shtml][Alphametic Puzzles]], Truman Collins - he has solvers and even generators.
+  - [[https://www.math.uni-bielefeld.de/~sillke/PUZZLES/ALPHAMETIC/][Alphametic]], Torsten Sillke - collection, variants, references, and links.
   - You can also browse our [[file:src/main/cryptarithms/][collection of cryptarithms]].
 
 * Download and Installation
@@ -40,7 +41,7 @@ It is based on [[https://github.com/chocoteam/choco-solver][choco-solver]] which
 
    The jar file contains all required dependencies.
    The next step is simply to run the console application.
-   : java -cp target/cryptator-0.5.1-SNAPSHOT-with-dependencies.jar cryptator.Cryptator send+more=money
+   : java -cp target/cryptator-0.5.1-with-dependencies.jar cryptator.Cryptator send+more=money
 
    There are three console applications and the links below point to demonstration scripts.
 
@@ -65,7 +66,7 @@ It is based on [[https://github.com/chocoteam/choco-solver][choco-solver]] which
  <dependency>
     <groupId>fr.univ-cotedazur</groupId>
     <artifactId>cryptator</artifactId>
-    <version>0.5.1-SNAPSHOT</version>
+    <version>0.5.1</version>
  </dependency>
  #+END_EXAMPLE
 

pom.xml

@@ -16,7 +16,7 @@
     <groupId>fr.univ-cotedazur</groupId>
     <artifactId>cryptator</artifactId>
     <packaging>jar</packaging>
-    <version>0.5.1-SNAPSHOT</version>
+    <version>0.5.1</version>
     <name>cryptator</name>
     <description>Constraint-based cryptarithm solver</description>
     <url>https://github.com/arnaud-m/cryptator</url>

src/main/R/sample-words.R

@@ -98,4 +98,4 @@ if(length(words) >= argv$words) {
         j <- j + 1
     }
 }
-cat("Generate", i , "words list(s) after", j, "tentative(s)\n")
+cat("Generate", i , "word list(s) after", j, "tentative(s)\n")

src/main/benchmarks/README.org

@@ -12,7 +12,7 @@
 
 #+BEGIN_SRC sh :results silent
    ln -s ../words .
-   ln -s ../../../target/cryptator-0.5.1-SNAPSHOT-with-dependencies.jar .
+   ln -s ../../../target/cryptator-0.5.1-with-dependencies.jar .
  #+END_SRC
 
 ** Clear directories
@@ -49,13 +49,22 @@
    }
  #+END_SRC
 
+
 * Generate
 
-** Configure the solver
+** Create the solver
 
-#+BEGIN_SRC sh
-  rm solver.sh
-  ln -s solver-generate.sh solver.sh
+#+BEGIN_SRC sh :tangle solver.sh
+JAR=cryptator-0.5.1-with-dependencies.jar
+MAINCLASS=cryptator.Cryptagen
+
+MAINARGS=`cat $1 $2 | xargs`
+
+INSTNAME=`echo $INSTNAME | sed 's/\s-*/-/g'`
+echo i `basename -s .dat $2`
+## SEED=`shuf -i1-1000 -n1`
+java -server  -Xms512m -Xmx8192m -cp $JAR $MAINCLASS $MAINARGS
+exit $?
  #+END_SRC
 
 ** Configure instances
@@ -81,12 +90,20 @@
    echo -v normal -d TRUE -lightM TRUE -lightP TRUE > algorithms/TT.dat
  #+END_SRC
 
+
+
+
 * Generate and Solve
-** Configure the solver
+** Create the solver
 
-#+BEGIN_SRC sh
-  rm solver.sh
-  ln -s solver-generate-and-solve.sh solver.sh
+#+BEGIN_SRC sh :tangle solver.sh
+JAR=cryptator-0.5.1-with-dependencies.jar
+MAINCLASS=cryptator.Cryptagen
+
+MAINARGS=`cat $1 $2 | xargs`
+
+java -server  -Xms512m -Xmx8192m -cp $JAR $MAINCLASS $MAINARGS | head -n -10
+exit $?
  #+END_SRC
 
 ** Configure instances
@@ -121,6 +138,17 @@ The word lists ~colors.txt~ and ~monsters.txt~ takes the most time by far (aroun
    generateLong 16 capitales.txt
  #+END_SRC
 
+*** Generate languages
+
+ #+BEGIN_SRC R :results output file :file "words-10-2.txt"
+   base <- 10
+   x <- head(letters, base)
+   xy <- expand.grid(x = x, y = x)
+   cat(paste(x, '\n', collapse = ''))
+   cat(paste(xy$x, xy$y, '\n', sep = "", collapse = ''))
+#+END_SRC
+
+
 ** Configure the algorithm
 
  #+BEGIN_SRC sh
@@ -129,11 +157,23 @@ The word lists ~colors.txt~ and ~monsters.txt~ takes the most time by far (aroun
 
 
 * Solve
-** Configure the solver
+** Create the solver
 
-#+BEGIN_SRC sh
-  rm solver.sh
-  ln -s solver-solve.sh solver.sh
+#+BEGIN_SRC sh :tangle solver.sh
+  JAR=cryptator-0.5.1-with-dependencies.jar
+  MAINCLASS=cryptator.Cryptator
+
+  MAINARGS=`cat $1 | xargs`
+
+  ## exclude cryptarithm with long words
+  ## grep -wvE '\w{10,}' $2 | sed 's/[[:space:]]//g'  | xargs java -server  -Xms512m -Xmx8192m -cp $JAR $MAINCLASS $MAINARGS
+
+  ## exclude cryptarithm without long words
+  ## grep -wE '\w{10,}' $2 | sed 's/[[:space:]]//g'  | xargs java -server  -Xms512m -Xmx8192m -cp $JAR $MAINCLASS $MAINARGS
+
+  ## Do not exclude anything
+  sed 's/[[:space:]]//g'  $2 | xargs java -server  -Xms512m -Xmx8192m -cp $JAR $MAINCLASS $MAINARGS
+  exit $?
  #+END_SRC
 
 ** Configure instances
@@ -193,8 +233,46 @@ Change the file extension accordingly.
        sed -n "$SED_EXPR" $INFILE >> $OUTFILE
     done
   ## Sort cryptarithms
-  find $OUTDIR -name '*.txt' -exec sort -u -o {} {} \;
+  find $OUTDIR -name '*.db.txt' -exec sort -u -o {} {} \;
+
+#+END_SRC
+
+** Classify cryptarithms
+
+
+#+BEGIN_SRC awk :tangle classify-additions.awk
+  {
+   operands = int(NF/2)
+   minlen = length($1)
+   maxlen = length($1)
+   for(i = 3 ; i < NF ; i+=2) {
+       if(length($i) < minlen) minlen=length($i);
+       else if(length($i) > maxlen) maxlen=length($i);
+   }
+   filename=sprintf("N%02d-%02d-%02d.db.txt", operands, minlen, maxlen)
+   #print operands, minlen, maxlen, filename, $0
+   print $0 >> filename;
+  }
+
+#+END_SRC
+
+
+#+BEGIN_SRC sh
+  INDIR=results-cryptarithms
+  OUTDIR=results-classified
+  rm -fr $OUTDIR
+  mkdir $OUTDIR
+  ## Classify
+  (
+      cd $OUTDIR
+      find ../$INDIR -name "*.db.txt" -exec awk -f ../classify-additions.awk {} \;
+
+  )
+  ## Sort cryptarithms
+  find $OUTDIR -name '*.db.txt' -exec sort -u -o {} {} \;
 
 #+END_SRC
 
+
+
 * Analysis

src/main/benchmarks/solver-generate-and-solve.sh

@@ -24,7 +24,7 @@ public enum CryptaOperator {
     SUB("-", 2, false, (a, b) -> a.subtract(b), (a, b) -> a.sub(b)),
     MUL("*", 3, true, (a, b) -> a.multiply(b), (a, b) -> a.mul(b)),
     DIV("//", 3, false, (a, b) -> a.divide(b), (a, b) -> a.div(b)),
-    FDIV("/", 3, false, (a, b) -> fdiv(a, b), (a, b) -> fdiv(a, b)),
+    FDIV("/", 3, false, CryptaOperator::fdiv, CryptaOperator::fdiv),
     MOD("%", 4, false, (a, b) -> a.mod(b), (a, b) -> a.mod(b)),
     POW("^", 4, false, (a, b) -> a.pow(b.intValue()), (a, b) -> a.pow(b)),
     ID("", 5, true, (a, b) -> BigInteger.ZERO, (a, b) -> null),
@@ -47,8 +47,8 @@ public enum CryptaOperator {
     private final int priority;
     private final boolean isCommutative;
 
-    CryptaOperator(final String token, int priority, boolean isCommutative, final BinaryOperator<BigInteger> function,
-            final BinaryOperator<ArExpression> expression) {
+    CryptaOperator(final String token, final int priority, final boolean isCommutative,
+            final BinaryOperator<BigInteger> function, final BinaryOperator<ArExpression> expression) {
         this.token = token;
         this.function = function;
         this.expression = expression;

src/main/benchmarks/solver-generate.sh

@@ -23,7 +23,7 @@ public final class ChocoLogger {
 
     private final Logger logger;
 
-    public ChocoLogger(Logger logger) {
+    public ChocoLogger(final Logger logger) {
         super();
         this.logger = logger;
     }
@@ -58,13 +58,13 @@ public void logOnSolver(final IChocoModel m) {
         logOnSolver(m.getModel());
     }
 
-    public void logOnSolver(Model model) {
+    public void logOnSolver(final Model model) {
         if (logger.isLoggable(Level.INFO)) {
             logger.log(Level.INFO, "Solver diagnostics:\n{0}", toDimacs(model.getSolver()));
         }
     }
 
-    public static String toDimacs(Model model) {
+    public static String toDimacs(final Model model) {
         final StringBuilder b = new StringBuilder();
         Formatter fmt = new Formatter(b, Locale.US);
         fmt.format("c MODEL_NAME %s", model.getName());

src/main/benchmarks/solver-solve.sh

@@ -38,11 +38,11 @@ public final Logger getLogger() {
         return Logger.getLogger(mainClass.getName());
     }
 
-    private final String getCommandName() {
+    private String getCommandName() {
         return mainClass.getName();
     }
 
-    private final String getArgumentName() {
+    private String getArgumentName() {
         return argumentName;
     }
 
@@ -96,21 +96,21 @@ public final boolean parseOptions(final String[] args) {
 
     }
 
-    private String printUsage(CmdLineParser parser, OptionHandlerFilter filter) {
+    private String printUsage(final CmdLineParser parser, final OptionHandlerFilter filter) {
         final ByteArrayOutputStream os = new ByteArrayOutputStream();
         parser.printUsage(new OutputStreamWriter(os), null, filter);
         return os.toString();
     }
 
-    private String printExample(String options) {
+    private String printExample(final String options) {
         return "java " + getCommandName() + " " + options + " " + getArgumentName();
     }
 
-    private String printExample(CmdLineParser parser, OptionHandlerFilter filter) {
+    private String printExample(final CmdLineParser parser, final OptionHandlerFilter filter) {
         return printExample(parser.printExample(filter));
     }
 
-    private String buildHelpMessage(CmdLineParser parser, OptionHandlerFilter filter) {
+    private String buildHelpMessage(final CmdLineParser parser, final OptionHandlerFilter filter) {
         StringBuilder b = new StringBuilder();
         b.append(" Help message:\n");
         b.append(printExample("[options...]")).append("\n");

src/main/java/cryptator/CryptaOperator.java

@@ -15,7 +15,8 @@ public class OptionsParserWithLog<E extends CryptaLogConfig> extends AbstractOpt
 
     private final ICryptaLogManager logManager;
 
-    public OptionsParserWithLog(Class<?> mainClass, E config, String argumentName, ICryptaLogManager logManager) {
+    public OptionsParserWithLog(final Class<?> mainClass, final E config, final String argumentName,
+            final ICryptaLogManager logManager) {
         super(mainClass, config, argumentName);
         this.logManager = logManager;
     }

src/main/java/cryptator/choco/ChocoLogger.java

@@ -10,14 +10,40 @@
 
 import cryptator.specs.ICryptaLogManager;
 
+/**
+ * The Enum Verbosity represents the verbosity levels of a program.
+ */
 public enum Verbosity {
-    SILENT, QUIET, NORMAL, VERBOSE, VERY_VERBOSE, DEBUG;
 
-    public void applyTo(ICryptaLogManager manager) {
+    /** The silent level. */
+    SILENT,
+    /** The quiet level. */
+    QUIET,
+    /** The normal level. */
+    NORMAL,
+    /** The verbose level. */
+    VERBOSE,
+    /** The very verbose level. */
+    VERY_VERBOSE,
+    /** The debug level. */
+    DEBUG;
+
+    /**
+     * Apply this verbosity level to a logging manager.
+     *
+     * @param manager the logging manager
+     */
+    public void applyTo(final ICryptaLogManager manager) {
         setVerbosity(manager, this);
     }
 
-    public static void setVerbosity(ICryptaLogManager manager, Verbosity verbosity) {
+    /**
+     * Sets the verbosity of a logging manager.
+     *
+     * @param manager   the manager
+     * @param verbosity the verbosity level
+     */
+    public static void setVerbosity(final ICryptaLogManager manager, final Verbosity verbosity) {
         if (verbosity != null && manager != null) {
             if (verbosity.equals(SILENT)) {
                 manager.setSilent();

src/main/java/cryptator/cmd/AbstractOptionsParser.java

@@ -91,7 +91,7 @@ public final int getSearchStrategy() {
         return searchStrategy;
     }
 
-    public final void setSearchStrategy(int searchStrategy) {
+    public final void setSearchStrategy(final int searchStrategy) {
         this.searchStrategy = searchStrategy;
     }