Merge pull request #85 from arnaud-m/feat-60

Define experimental protocol for solving cryptarithms
- close #60

Author: arnaud-m

README.org

@@ -17,7 +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.
-
+  - You can also browse our [[file:src/main/cryptarithms/][collection of cryptarithms]].
 
 * Download and Installation
 
@@ -39,15 +39,16 @@ It is based on [[https://github.com/chocoteam/choco-solver][choco-solver]] which
    : mvn clean package -DskipTests=true
 
    The jar file contains all required dependencies.
-   The next step is simply to run one of the console applications.
-   The links point to demonstration scripts.
+   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
+
+   There are three console applications and the links below point to demonstration scripts.
 
  - *solve a cryptarithm* with [[file:src/main/shell/demo-solve.sh][Cryptator]].
  - *generate cryptarithms* with [[file:src/main/shell/demo-generate.sh][Cryptagen]] (see the [[file:src/main/shell/demo-generate-output.md][demo output]]).
  - *play the game* with [[file:src/main/shell/demo-play.sh][Cryptamancer]].
 
-
-    Execute the main classe without argument to display the help message.
+    Execute the main class without argument to display the help message.
 ** As a library
 
    The jar file does not contains any dependencies, as of being used as a dependency of another application.

src/main/R/sample-words.R

@@ -63,6 +63,7 @@ p <- add_argument(p, "--letters", help="number of letters", type="integer", defa
 p <- add_argument(p, "--vowels", help="number of vowels", type="integer", default = 4)
 p <- add_argument(p, "--words", help="number of words per list", type="integer", default = 50)
 p <- add_argument(p, "--minlen", help="minimal word length", type="integer", default = 2)
+p <- add_argument(p, "--maxlen", help="maximal word length", type="integer", default = Inf)
 
 ## Parse the command line arguments
 argv <- parse_args(p)
@@ -74,8 +75,8 @@ argv <- parse_args(p)
 words <- ScanWords(argv$dictionary)
 cat("Scan", length(words), "words in", argv$dictionary,"\n")
 
-words <- subset(words, nchar(words) >= argv$minlen)
-cat("Find", length(words), "words with length >=", argv$minlen,"\n")
+words <- subset(words, (argv$minlen <= nchar(words)) & (nchar(words) <= argv$maxlen))
+cat("Find ", length(words), " words with length in [", argv$minlen, ", ", argv$maxlen, "]\n", sep = "")
 
 ## Try generating words lists
 i <- 0 # instance
@@ -97,4 +98,4 @@ if(length(words) >= argv$words) {
         j <- j + 1
     }
 }
-cat("Generate", i , "words lists after", j, "tentatives\n")
+cat("Generate", i , "words list(s) after", j, "tentative(s)\n")

src/main/benchmarks/README.org

@@ -72,7 +72,7 @@
    echo -v normal -d TRUE -lightM FALSE -lightP FALSE > algorithms/FF.dat
  #+END_SRC
 
-*** Other algorithms
+*** All algorithms
 
  #+BEGIN_SRC sh
    echo -v normal -d TRUE -lightM FALSE -lightP FALSE > algorithms/FF.dat
@@ -82,7 +82,6 @@
  #+END_SRC
 
 * Generate and Solve
-
 ** Configure the solver
 
 #+BEGIN_SRC sh
@@ -118,12 +117,8 @@ The word lists ~colors.txt~ and ~monsters.txt~ takes the most time by far (aroun
    generateLong 14 elements.txt
    generateLong 49 palindromes-fr.txt
    generateLong 41 palindromes-en.txt
-   generateLong 14 countries.txt
-   generateLong 11 computer.txt
-   generateLong 12 jobs.txt
-   generateLong 13 jobs.txt
-   generateLong 13 vins.txt
-   generateLong 28 mythologie-grecque/mythologie-grecque.txt
+   generateLong 15 capitales.txt
+   generateLong 16 capitales.txt
  #+END_SRC
 
 ** Configure the algorithm
@@ -132,7 +127,41 @@ The word lists ~colors.txt~ and ~monsters.txt~ takes the most time by far (aroun
    echo -v quiet -d FALSE -l TRUE -lightM FALSE -lightP FALSE > algorithms/ALL.dat
  #+END_SRC
 
+
+* Solve
+** Configure the solver
+
+#+BEGIN_SRC sh
+  rm solver.sh
+  ln -s solver-solve.sh solver.sh
+ #+END_SRC
+
+** Configure instances
+
+Select instance files in the directory ~instances-solve~.
+
+ - Filename prefixed by ~long~ requires the bignum model.
+ - Filename prefixed by ~short~ are accepted by the scalar model.
+
+** Configure the algorithm
+
+ #+BEGIN_SRC sh
+   ARGS=" -v verbose -t 10"
+   echo $ARGS -l TRUE > algorithms/BIGNUM.dat
+   echo $ARGS -l FALSE -h FALSE > algorithms/SCALAR.dat
+   echo $ARGS -l FALSE -h TRUE > algorithms/HORNER.dat
+
+   echo $ARGS -l TRUE -search 1 > algorithms/BIGNUM-1.dat
+   echo $ARGS -l FALSE -h FALSE -search 1 > algorithms/SCALAR-1.dat
+   echo $ARGS -l FALSE -h TRUE -search 1 > algorithms/HORNER-1.dat
+
+ #+END_SRC
+
+
 * Testing
+
+Change the file extension accordingly.
+
 ** Solve instances in sequential
    #+BEGIN_SRC sh
      nohup gridjobs  -l -p '*.dat' &

src/main/benchmarks/instances-solve/long-cryptarithms-10.db.txt

@@ -0,0 +1,20 @@
+actor+actress+artist+cellist+contractor+electrician+internist+retailer+sailor+scientist+socialite+tailor=entertainer
+actor+actress+artist+contractor+courier+instructor+internist+nun+nurse+scientist+senator+star+treasurer=auctioneer
+actor+actress+astronaut+courier+instructor+internist+nun+scientist+scout+senator+trainer+treasurer=contractor
+actor+actress+captain+carpenter+cartoonist+optician+painter+pianist+poet+prince+reporter+trainer=contractor
+actor+actress+captain+carpenter+caterer+internist+operator+optician+painter+prince+scientist+senator=contractor
+actor+astronaut+caterer+courier+instructor+internist+nurse+scientist+scout+senator+trainer+treasurer=auctioneer
+actor+captain+carpenter+contractor+interpreter+operator+pilot+police+politician+prince+reporter+retailer=electrician
+actor+captain+caterer+contractor+entertainer+optician+oracle+painter+pilot+police+prince+principal=electrician
+actor+carpenter+caterer+entertainer+operator+oracle+painter+pilot+poet+prince+principal+reporter+retailer=electrician
+actress+aide+caterer+contractor+dancer+dentist+director+editor+scientist+senator+star+trader+trainer=cartoonist
+actress+artist+captain+caterer+contractor+internist+operator+painter+pianist+prince+reporter+senator+star=cartoonist
+actress+caterer+cellist+contractor+electrician+internist+oracle+sailor+senator+socialite+tailor+trainer=entertainer
+actress+caterer+contractor+dancer+dentist+dictator+director+editor+internist+senator+star+trader=cartoonist
+artist+captain+carpenter+internist+painter+pianist+pitcher+rancher+scientist+star+teacher+technician+trainer=researcher
+captain+carpenter+caterer+operator+oracle+painter+pilot+poet+police+politician+reporter+tailor+trainer=contractor
+captain+carpenter+electrician+operator+optician+oracle+painter+pilot+poet+principal+retailer+tailor+trainer=entertainer
+carpenter+caterer+contractor+interpreter+optician+pilot+poet+politician+prince+reporter+retailer+trainer=electrician
+carpenter+contractor+operator+optician+painter+pilot+poet+prince+principal+reporter+retailer+tailor=politician
+carpenter+contractor+operator+oracle+painter+poet+police+principal+reporter+retailer+tailor+trainer=politician
+electrician+operator+oracle+painter+poet+politician+prince+principal+reporter+retailer+tailor+trainer=entertainer

src/main/benchmarks/instances-solve/long-cryptarithms-ext-10.db.txt

@@ -0,0 +1,14 @@
+this+a+fire+therefore+for+all+histories+i+tell+a+tale+that+falsifies+its+title+tis+a+lie+the+tale+of+the+last+fire+horses+late+after+the+first+fathers+foresee+the+horrors+the+last+free+troll+terrifies+the+horses+of+fire+the+troll+rests+at+the+hole+of+losses+it+is+there+that+she+stores+roles+of+leathers+after+she+satisfies+her+hate+off+those+fears+a+taste+rises+as+she+hears+the+least+far+horse+those+fast+horses+that+first+hear+the+troll+flee+off+to+the+forest+the+horses+that+alerts+raise+the+stares+of+the+others+as+the+troll+assails+at+the+total+shift+her+teeth+tear+hoof+off+torso+as+the+last+horse+forfeits+its+life+the+first+fathers+hear+of+the+horrors+their+fears+that+the+fires+for+their+feasts+arrest+as+the+first+fathers+resettle+the+last+of+the+fire+horses+the+last+troll+harasses+the+forest+heart+free+at+last+of+the+last+troll+all+offer+their+fire+heat+to+the+assisters+far+off+the+troll+fasts+its+life+shorter+as+stars+rise+the+horses+rest+safe+after+all+share+hot+fish+as+their+affiliates+tailor+a+roofs+for+their+safe=fortresses
+aristocratic+prescription+prosopopoeia+protectorate=transoceanic
+narragansett+nonogenarian+osteoporosis+proportionate+transposition=retrogression
+internescine+osteoporosis+perspiration+postprocessor+proscription=transpiration
+antiperspirant+interstitial+presentation+proportionate+transliterate=transportation
+aristocratic+postposition+procrastinate+proprioception+proscription+protectorate+transoceanic=interpretation
+inappropriate+osteoporosis+procrastinate+prosopopoeia+reconnaissance+spectroscope+transcription=proprioception
+apperception+aristocratic+interpretation+presentation+proprioception+proscription+transpiration+transposition=concessionaire
+perspiration+postprocessor+practitioner+proscription+prosopopoeia+reconnaissance+transoceanic+transposition=concessionaire
+postposition+presentation+protestation+reconnaissance+spectroscope+spectroscopic+transcription+transposition=interpretation
+apperception+aristocratic+inconsistent+osteoporosis+prescription+protectorate+protestation+statistician=spectroscopic
+inconsistent+osteoporosis+perspiration+postposition+presentation+proportionate+spectroscopic+transpiration=transportation
+apperception+interception+practitioner+proscription+protectorate+spectroscope+spectroscopic+transoceanic=transposition
+apperception+aristocratic+concessionaire+conscription+inappropriate+incapacitate+inconsistent+interception+osteoporosis+perspiration+prescription+proscription+prosopopoeia+protectorate+protestation+statistician+transoceanic+transpiration=antiperspirant

src/main/benchmarks/instances-solve/long-cryptarithms-ext-15.db.txt

@@ -0,0 +1,2 @@
+as+a+stamp+collector+i+collect+dear+old+classic+stamps+cool+beer+labels+some+beer+coasters+old+beer+cans+nice+beer+caps+baseball+and+sports+cards+nine+and+ten+meccano+sets+lionel+model+trains+rare+books+and+maps+and+i+also+collected+some+real+rare+old=postcards
+as+a+stamp+collector+i+collect+dear+old+classic+stamps+cool+beer+labels+some+beer+coasters+old+beer+cans+nice+beer+caps+baseball+and+sports+cards+nine+and+ten+meccano+sets+lionel+model+trains+rare+books+and+maps+and+i+also+collected+some+real+rare+old+dolls+bears+race+cars+snooker+tables+and=postcards

src/main/benchmarks/instances-solve/long-cryptarithms-ext-16.db.txt

@@ -0,0 +1 @@
+lets+also+remember+the+golden+age+of+old+films+as+the+fantastic+bogart+and+the+fantastic+bergman+and+that+dear+old+sam+starred+in+one+of+the+most+memorable+action+films+called=casablanca

src/main/benchmarks/instances-solve/short-cryptarithms-10.db.txt

@@ -0,0 +1,82 @@
+achille+ares+aristee+asia+asteria+atlas+attis+castor+ceos+cottos+crios+eole+eos+eros+ether+hera+heracles+hestia+hilaire+les+leto+otos+rhea+talos+tartare+thalassa+theia+trachios=olethros
+achille+ares+aristee+asia+asteria+atlas+attis+castor+ceos+cottos+crios+eole+eos+ether+helios+hera+hestia+hilaire+les+leto+olethros+otos+rhea+talos+tartare+thalassa+theia+trachios=heracles
+achille+ares+aristee+asia+astreos+atlas+attis+castor+ceos+chaos+cottos+crios+eole+eos+eros+ether+hera+heracles+hestia+hilaire+les+leto+olethros+otos+rhea+talos+tartare+theia=thalassa
+actor+actress+aide+artist+caterer+cellist+dictator+director+editor+oracle+soldier+star+tailor=retailer
+actor+actress+aide+artist+caterer+cellist+dictator+doctor+editor+soldier+star+trader=retailer
+actor+actress+aide+artist+caterer+cellist+dictator+doctor+sailor+soldier+star+trader=retailer
+actor+actress+aide+artist+caterer+cellist+director+editor+soldier+star+tailor+trader=retailer
+actor+actress+aide+artist+caterer+cellist+editor+sailor+soldier+star+tailor+trader=director
+actor+actress+aide+artist+caterer+courier+doctor+editor+educator+scout+trader+tutor=dictator
+actor+actress+aide+artist+caterer+director+doctor+editor+scout+star+trader+tutor=educator
+actor+actress+aide+artist+caterer+doctor+oracle+retailer+soldier+star+tailor+trader=director
+actor+actress+aide+artist+cellist+dictator+director+doctor+editor+oracle+sailor+soldier+star=retailer
+actor+actress+aide+artist+cellist+dictator+doctor+editor+oracle+soldier+star+tailor=retailer
+actor+actress+aide+caterer+cellist+dictator+editor+oracle+sailor+soldier+star+tailor=retailer
+actor+actress+aide+dancer+dictator+director+doctor+editor+scientist+senator+star+trader+trainer=internist
+actor+actress+artist+astronaut+caterer+nun+nurse+scientist+scout+senator+star+trainer+tutor=internist
+actor+actress+artist+captain+carpenter+caterer+optician+painter+poet+reporter+scientist+senator+star=internist
+actor+actress+artist+captain+caterer+painter+pianist+poet+prince+senator+star+trainer=princess
+actor+actress+artist+carpenter+caterer+operator+optician+pianist+poet+prince+senator+star+trainer=scientist
+actor+actress+artist+caterer+cellist+dictator+director+doctor+oracle+soldier+star+tailor+trader=retailer
+actor+aide+caterer+dancer+dictator+director+editor+optician+painter+poet+prince+trader+trainer=carpenter
+actor+artist+captain+caterer+internist+operator+optician+painter+pianist+poet+reporter+scientist+senator=carpenter
+actor+athlete+author+barber+butcher+butler+catcher+caterer+coach+cobbler+hobo+teacher+tutor=lecturer
+actor+athlete+author+barber+butler+catcher+caterer+coach+cobbler+laborer+oracle+teacher+tutor=lecturer
+actor+captain+carpenter+caterer+operator+optician+oracle+painter+poet+reporter+retailer+tailor+trainer=principal
+actor+captain+caterer+coach+operator+optician+painter+pitcher+poet+prince+rancher+teacher+trainer=reporter
+actor+captain+dictator+director+editor+operator+optician+painter+poet+prince+reporter+trader+trainer=carpenter
+actress+aide+artist+captain+caterer+dancer+dentist+internist+painter+pianist+prince+scientist+star=president
+actress+aide+artist+caterer+cellist+doctor+editor+retailer+sailor+soldier+star+trader=dictator
+actress+aide+artist+caterer+cellist+doctor+oracle+retailer+sailor+soldier+star+trader=dictator
+actress+aide+artist+caterer+cellist+editor+oracle+retailer+sailor+soldier+star+tailor+trader=dictator
+actress+artist+captain+carpenter+cashier+caterer+internist+pitcher+prince+rancher+star+teacher+trainer=scientist
+actress+artist+captain+cashier+catcher+caterer+harpist+painter+pianist+pitcher+prince+star+trainer=princess
+actress+artist+captain+cashier+catcher+caterer+harpist+pitcher+prince+rancher+star+teacher+trainer=princess
+actress+artist+captain+cashier+catcher+harpist+painter+pianist+pitcher+prince+rancher+star+trainer=princess
+actress+artist+captain+cashier+catcher+harpist+painter+pianist+pitcher+prince+star+teacher+trainer=princess
+actress+artist+cashier+catcher+caterer+harpist+painter+pianist+pitcher+prince+rancher+star+trainer=princess
+actress+athlete+cashier+caterer+cellist+coach+oracle+sailor+scholar+star+tailor+teacher=retailer
+actress+captain+operator+optician+painter+pianist+poet+prince+reporter+senator+star+trainer=carpenter
+aide+artist+dentist+designer+gardener+guide+internist+nurse+ranger+star+student+trainer=treasurer
+albania+algeria+angola+armenia+benin+gabon+gambia+georgia+lebanon+liberia+mali+niger+nigeria+romania=mongolia
+albania+algeria+angola+armenia+benin+gabon+gambia+georgia+mali+namibia+niger+nigeria+oman+romania=mongolia
+albania+algeria+angola+armenia+gabon+gambia+georgia+iran+lebanon+liberia+namibia+niger+nigeria+romania=mongolia
+albania+algeria+benin+brunei+burundi+grenada+guinea+india+iran+ireland+liberia+niger+nigeria+uganda=bulgaria
+albania+angola+armenia+gabon+gambia+georgia+lebanon+liberia+mali+namibia+niger+nigeria+oman+romania=mongolia
+andorra+armenia+cameroon+canada+congo+greece+grenada+india+iran+monaco+morocco+niger+nigeria+oman=dominica
+angel+beast+elf+genie+giant+titan=nessie
+angel+crone+demon+dragon+gnome+golem+orc=gorgon
+angel+crone+demon+gnome+golem+gorgon+ogre+orc=dragon
+angel+crone+demon+gnome+golem+gorgon+orc=dragon
+angel+crone+demon+gnome+golem+merman+orc=dragon
+angel+crone+demon+golem+merman+ogre+orc=dragon
+angel+crone+dragon+gnome+golem+ogre+orc=merman
+angel+crone+gnome+golem+hag+horror+orc=merman
+angel+demon+dragon+gnome+golem+ogre+troll=gorgon
+angel+dragon+gnome+golem+hag+horror+ogre=merman
+angel+genie+giant+gnome+golem+merman+titan+troll=gorgon
+angel+genie+giant+gnome+merman+titan+troll=gorgon
+angel+genie+giant+golem+gorgon+ogre+titan+troll=merman
+angel+genie+giant+golem+merman+ogre+titan+troll=gorgon
+angel+giant+gnome+golem+gorgon+ogre+titan+troll=merman
+angel+giant+gnome+golem+gorgon+titan+troll=merman
+angel+giant+golem+merman+ogre+titan+troll=gorgon
+angola+armenia+benin+gabon+gambia+georgia+iran+lebanon+liberia+mali+namibia+niger+nigeria+oman=mongolia
+animator+artist+emperor+empress+marine+mason+miner+painter+pianist+senator+star+trainer=importer
+apple+banana+grape+lemon+mango+melon+pear=orange
+aramon+corton+cot+macon+marsanne+romanee+roussane+roussanne+samos+sancerre+saumur+tannat+tursan=sauternes
+ares+aristee+artemis+asia+asteria+astreos+atlas+attis+eole+eos+eros+ether+helios+hemera+hemithee+hera+hermes+hestia+hilaire+les+leto+moros+olethros+otos+talos+tartare+theia+themis=thalassa
+ares+aristee+artemis+asia+asteria+astreos+atlas+attis+eole+eos+eros+ether+helios+hemera+hemithee+hera+hermes+hestia+hilaire+leto+metis+olethros+otos+rhea+talos+tartare+theia+themis=thalassa
+ares+aristee+artemis+asia+asteria+atlas+attis+eole+eos+eros+ether+helios+hemera+hemithee+hera+hermes+hestia+hilaire+les+leto+metis+moros+otos+rhea+talos+tartare+theia+themis=olethros
+ares+asia+asteria+astreos+atlas+attis+castor+ceos+chaos+crios+eole+eos+eros+ether+helios+hera+heracles+hestia+hilaire+les+leto+otos+rhea+talos+tartare+thalassa+theia+trachios=olethros
+captain+caterer+operator+optician+oracle+painter+pilot+police+prince+principal+reporter+retailer+trainer=carpenter
+cinco+oito+dez+doze+treze+catorze+dezoito=oitenta
+crone+dragon+genie+giant+ogre+orc+titan=gorgon
+demon+dryad+gnome+hag+horror+hydra=merman
+demon+dryad+gnome+hydra+merman+ogre=horror
+demon+dryad+gnome+mummy+ogre+undead=gorgon
+dragon+dryad+genie+giant+ogre+titan+yeti=gorgon
+genie+ghost+giant+gorgon+ogre+siren+titan=horror
+genie+ghost+giant+hag+nessie+ogre+siren+titan=horror
+genie+ghost+giant+horror+ogre+siren+titan=gorgon
+genie+ghost+giant+nessie+siren+titan=horror

src/main/benchmarks/solver-solve.sh

@@ -0,0 +1,14 @@
+JAR=cryptator-0.5.1-SNAPSHOT-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 $?

src/main/cryptarithms/README.org

@@ -0,0 +1,6 @@
+#+STARTUP: overview hidestars logdone
+#+LANGUAGE: en
+#+TITLE: Cryptator Collection
+
+- Thousands of cryptarithms generated by our solver.
+- Each file contains a theme collection.