First commit

.gitignore

@@ -0,0 +1,6 @@
+# Composer
+composer.lock
+vendor/
+
+# Phar build
+build/

README.md

@@ -0,0 +1,121 @@
+word-ladder
+===========
+
+word-ladder is a command-line program and PHP library for solving
+[word ladder problems].
+
+*Word ladder* is a word game invented by [Lewis Caroll]. The player is given two
+words and must find a 'ladder' from one to another on which only one letter is
+changed between words on adjacent rungs on the ladder.
+e.g.
+
+	Ladder from GIT to HUB:
+	GIT -> GUT -> HUT -> HUB
+
+Word ladder problems can have more than one correct answer. Because of this,
+word-ladder will declare the first solution it finds, then it will analyse
+all solutions (the same length as the first one) and declare the *best* one.
+(Where 'best' is defined as being the solution whose least common word, is more
+common than all other solutions' least common words. i.e. Ladders are judged to
+only be as strong as their weakest link / rung.)
+
+There are some variations on the word ladder game in which the problem must be
+solved in a specified number of steps. In some cases it is possible to solve the
+problem in fewer steps. Unlike most other solvers, word-ladder accepts an option
+to attempt to solve the problem in a set number of steps. (When this option is
+not provided it simply attempts to solve the problem in as few steps as
+possible.)
+
+Program - Getting started
+-------------------------
+
+Download [the Phar]. Place it wherever you want on your system. Execute it from
+the command line through PHP. (Or you can execute it directly if you have a
+valid, modern PHP binary at /usr/bin/php.)
+
+Program - Usage
+---------------
+
+	Usage: word-ladder START FINISH [STEPS]
+
+The command-line program accepts three parameters, *START*, *FINISH*, and
+*STEPS*, where only the third, *STEPS* is optional.
+
+**START**: The first word in the ladder.
+
+**FINISH**: The last word in the ladder.
+
+**STEPS**: The number of steps / rungs on the ladder.
+
+Example:
+
+	$ word-ladder git hub
+	Attempting: git -> hub
+	First solution set (3 steps) found after 2 lookups:
+	0: git  [a person who is deemed to be despicable or contemptible; "only a ro...]
+	1: gib  [a castrated tomcat]
+	2: gub  []
+	3: hub  [the central part of a car wheel (or fan or propeller etc) through w...]
+	[Prevalence score: 112.26878713664]
+	Finding and analysing all solutions... Done.
+
+	10 solution(s) found.
+
+	0: git  [a person who is deemed to be despicable or contemptible; "only a ro...]
+	1: gut  [a strong cord made from the intestines of sheep and used in surgery]
+	2: hut  [small crude shelter used as a dwelling]
+	3: hub  [the central part of a car wheel (or fan or propeller etc) through w...]
+
+	[Prevalence score: 16551.249116398]
+
+Library - Getting started
+-------------------------
+
+1. Get [Composer]
+2. Require word-ladder with `php composer.phar require daniel-ac-martin/word-ladder`
+3. Install dependencies with `php composer.phar install`
+
+Library - Usage
+---------------
+
+The library is invoked by including Composer's autoloader and then calling the
+method, *WordLadder\WordLadder::solve*. Please see the following example.
+
+```php
+<?php
+
+require_once 'vendor/autoload.php'; // Composer's autoloader
+
+$start  = 'git';
+$finish = 'hub';
+$steps  = 4;
+
+try
+{
+	$solution = WordLadder\WordLadder::solve($start, $finish, $steps);
+
+	foreach($solution->solution() as $e)
+	{
+		echo $e->word() . ': ' . substr($e->definition(), 0, 78 - strlen($start)) . "\n";
+	}
+}
+catch(Exception $e)
+{
+	die('Error: ' . $e->getMessage() . "\n");
+}
+
+?>
+```
+
+License
+-------
+
+Copyright (C) 2015 Daniel A.C. Martin
+
+Distributed under the GNU GPL v3.
+
+ [word ladder problems]: http://en.wikipedia.org/wiki/Word_ladder
+ [Lewis Caroll]:         http://en.wikipedia.org/wiki/Lewis_Carroll
+ [the Phar]:             https://github.com/daniel-ac-martin/word-ladder/releases/download/0.1/word-ladder.phar
+ [Composer]:             http://getcomposer.org
+

bin/word-ladder

@@ -0,0 +1,114 @@
+#! /usr/bin/php
+<?php
+
+/*
+ * Copyright (C) 2015 Daniel A.C. Martin.
+ * This file is part of word-ladder.
+ * 
+ * word-ladder is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * word-ladder is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with word-ladder.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+define('PROGRAM_NAME', basename(__FILE__));
+define('N', "\n");
+
+require_once __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
+
+if
+(
+	   empty($argv)
+	|| (count($argv) < 3)
+	|| (count($argv) > 4)
+)
+{
+	echo 'Usage: ' . PROGRAM_NAME . ' START FINISH [STEPS]' . N;
+	exit(1);
+}
+else if(strlen($argv[1]) != strlen($argv[2]))
+{
+	echo 'Error: Both words must be the same size.' . N;
+	exit(2);
+}
+else
+{
+	$solution = null;
+	$start    = $argv[1];
+	$finish   = $argv[2];
+	$steps    = isset($argv[3]) ? $argv[3] : null;
+
+	echo 'Attempting: ' . $argv[1] . ' -> ' . $argv[2] . N;
+
+	try
+	{
+		$solution = WordLadder\WordLadder::solve($start, $finish, $steps, true);
+	}
+	catch(Exception $e)
+	{
+		echo 'Error: ' . $e->getMessage() . N;
+		exit(3);
+	}
+
+	$s = $solution->solution();
+
+	echo 'First solution set (' . (count($s) - 1) . ' steps) found after ' . $solution->lookups() . ' lookups:' . N;
+
+	print_solution($solution->solution());
+
+	echo '[Prevalence score: ' . $solution->prevalenceScore($solution) . ']' . N;
+	echo 'Finding and analysing all solutions...';
+
+	try
+	{
+		$solution = WordLadder\WordLadder::solve($start, $finish, $steps);
+	}
+	catch(Exception $e)
+	{
+		echo 'Error: ' . $e->getMessage() . N;
+		exit(4);
+	}
+
+
+	echo ' Done.' . N . N;
+	echo $solution->setSize() . ' solution(s) found.' . N . N;
+
+	print_solution($solution->solution());
+
+	echo N . '[Prevalence score: ' . $solution->prevalenceScore() . ']' . N;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Functions
+////////////////////////////////////////////////////////////////////////////////
+
+function print_word($number, $word)
+{
+	$v = $word->word();
+	$g = $word->definition();
+
+	$glossary_space = 73 - strlen($v);
+	$glossary = ($glossary_space >= strlen($g)) ? $g
+	                                            : substr($g, 0, $glossary_space - 3) . '...';
+	echo $number . ': ' . $v . '  [' . $glossary . ']' . N;
+}
+
+function print_solution($solution)
+{
+	$n = 0;
+
+	foreach($solution as $e)
+	{
+		print_word($n++, $e);
+	}
+}
+
+?>

composer.json

@@ -0,0 +1,28 @@
+{
+	"name": "daniel-ac-martin/word-ladder",
+	"type": "project",
+	"description": "A command-line program and library for solving word ladder puzzles.",
+	"keywords": ["word", "ladder", "solver", "word ladder", "word ladder solver"],
+	"homepage": "https://github.com/daniel-ac-martin/word-ladder",
+	"license": "GNU GPL",
+	"authors": [
+		{
+			"name": "Daniel A.C. Martin",
+			"homepage": "http://dacm.org",
+			"email": "[email protected]",
+			"role": "Creator/Developer"
+		}
+	],
+    "bin": ["bin/word-ladder"],
+    "require": {
+        "daniel-ac-martin/php-seids": "~1.0"
+    },
+	"require-dev": {
+		"squizlabs/php_codesniffer": "2.3.x"
+	},
+	"autoload": {
+		"psr-4": {
+			"WordLadder\\": "src/WordLadder"
+		}
+	}
+}

data/10-letters/0.json

@@ -0,0 +1 @@
+[{"value":"zootomists","paths":{"3":{"n":1}},"prevalence":"4.3733081404986","glossary":null},{"value":"zoonomists","paths":{"3":{"t":0}},"prevalence":"0","glossary":null}]

data/10-letters/1.json

@@ -0,0 +1 @@
+[{"value":"zoothapsis","paths":{"8":{"e":1}},"prevalence":"0","glossary":null},{"value":"zoothapses","paths":{"8":{"i":0}},"prevalence":"0","glossary":null}]

data/10-letters/10.json

@@ -0,0 +1 @@
+[{"value":"zigzaggery","paths":{"9":{"s":1}},"prevalence":"8.302485185237","glossary":null},{"value":"zigzaggers","paths":{"9":{"y":0}},"prevalence":"2.4287845791422","glossary":null}]

data/10-letters/100.json

@@ -0,0 +1 @@
+[{"value":"wayfarings","paths":{"2":{"r":1}},"prevalence":"42.140019687444","glossary":null},{"value":"warfarings","paths":{"2":{"y":0}},"prevalence":"8.5851949572741","glossary":null}]

data/10-letters/1000.json

@@ -0,0 +1 @@
+[{"value":"solidarist","paths":{"9":{"m":1}},"prevalence":"206.22481224865","glossary":null},{"value":"solidarism","paths":{"9":{"t":0}},"prevalence":"172.2756918058","glossary":null}]

data/10-letters/1001.json

@@ -0,0 +1 @@
+[{"value":"solicitous","paths":{"8":{"r":1}},"prevalence":"13330.315323431","glossary":"showing hovering attentiveness; \"solicitous about about her health\"; \"made solicitous inquiries about our family\""},{"value":"solicitors","paths":{"8":{"u":0}},"prevalence":"9091.1366973129","glossary":null}]

data/10-letters/1002.json

@@ -0,0 +1 @@
+[{"value":"solemnizes","paths":{"7":{"s":4},"9":{"d":2,"r":1}},"prevalence":"120.47094371836","glossary":null},{"value":"solemnizer","paths":{"7":{"s":5},"9":{"d":2,"s":0}},"prevalence":"6.8653600668875","glossary":null},{"value":"solemnized","paths":{"7":{"s":3},"9":{"r":1,"s":0}},"prevalence":"3456.8860247217","glossary":null},{"value":"solemnised","paths":{"9":{"r":5,"s":4},"7":{"z":2}},"prevalence":"1088.5835406678","glossary":null},{"value":"solemnises","paths":{"9":{"d":3,"r":5},"7":{"z":0}},"prevalence":"14.814620761173","glossary":null},{"value":"solemniser","paths":{"9":{"d":3,"s":4},"7":{"z":1}},"prevalence":"0.90823541888228","glossary":null}]

data/10-letters/1003.json

@@ -0,0 +1 @@
+[{"value":"solecizing","paths":{"6":{"s":1}},"prevalence":"0","glossary":null},{"value":"solecising","paths":{"6":{"z":0}},"prevalence":"0","glossary":null}]

data/10-letters/1004.json

@@ -0,0 +1 @@
+[{"value":"solarizing","paths":{"0":{"p":3},"6":{"s":1}},"prevalence":"30.390216556817","glossary":null},{"value":"solarising","paths":{"0":{"p":2},"6":{"z":0}},"prevalence":"4.345168811028","glossary":null},{"value":"polarising","paths":{"6":{"z":3},"0":{"s":1}},"prevalence":"812.4233227032","glossary":null},{"value":"polarizing","paths":{"6":{"s":2},"0":{"s":0}},"prevalence":"6125.9183005814","glossary":null}]

data/10-letters/1005.json

@@ -0,0 +1 @@
+[{"value":"sogdologer","paths":{"2":{"c":4},"6":{"a":2,"i":1}},"prevalence":"0","glossary":null},{"value":"sogdoliger","paths":{"2":{"c":5},"6":{"a":2,"o":0}},"prevalence":"0","glossary":null},{"value":"sogdolager","paths":{"2":{"c":3},"6":{"i":1,"o":0}},"prevalence":"0","glossary":null},{"value":"socdolager","paths":{"6":{"i":5,"o":4},"2":{"g":2}},"prevalence":"0.23165748606472","glossary":null},{"value":"socdologer","paths":{"6":{"a":3,"i":5},"2":{"g":0}},"prevalence":"0","glossary":null},{"value":"socdoliger","paths":{"6":{"a":3,"o":4},"2":{"g":1}},"prevalence":"0","glossary":null}]

data/10-letters/1006.json

@@ -0,0 +1 @@
+[{"value":"sodomizing","paths":{"6":{"s":1}},"prevalence":"365.00139901509","glossary":null},{"value":"sodomising","paths":{"6":{"z":0}},"prevalence":"44.443150346786","glossary":null}]

data/10-letters/1007.json

@@ -0,0 +1 @@
+[{"value":"sodalities","paths":[{"m":2,"n":1}],"prevalence":"589.14667354582","glossary":null},{"value":"nodalities","paths":[{"m":2,"s":0}],"prevalence":"4.6118947624706","glossary":null},{"value":"modalities","paths":{"2":{"l":4,"r":3},"0":{"n":1,"s":0}},"prevalence":"25477.265129286","glossary":null},{"value":"moralities","paths":{"2":{"d":2,"l":4}},"prevalence":"3721.8142590658","glossary":null},{"value":"molalities","paths":{"2":{"d":2,"r":3},"4":{"r":5}},"prevalence":"79.430237563664","glossary":null},{"value":"molarities","paths":{"4":{"l":4},"0":{"p":6}},"prevalence":"107.41023329107","glossary":null},{"value":"polarities","paths":[{"m":5}],"prevalence":"6487.1283567174","glossary":null}]

data/10-letters/1008.json

@@ -0,0 +1 @@
+[{"value":"sociopathy","paths":{"9":{"s":1}},"prevalence":"453.81759973944","glossary":null},{"value":"sociopaths","paths":{"9":{"y":0}},"prevalence":"994.96916919943","glossary":null}]

data/10-letters/1009.json

@@ -0,0 +1 @@
+[{"value":"socializes","paths":{"7":{"s":4,"t":5},"9":{"d":2,"r":1}},"prevalence":"899.25169888518","glossary":null},{"value":"socializer","paths":{"7":{"s":8},"9":{"d":2,"s":0}},"prevalence":"143.58191600736","glossary":"a person who takes part in social activities"},{"value":"socialized","paths":{"7":{"s":3},"9":{"r":1,"s":0}},"prevalence":"15052.700371048","glossary":"under group or government control; \"socialized ownership\"; \"socialized medicine\""},{"value":"socialised","paths":{"9":{"r":8,"s":4},"7":{"z":2}},"prevalence":"2254.9536456002","glossary":"under group or government control; \"socialized ownership\"; \"socialized medicine\""},{"value":"socialises","paths":{"9":{"d":3,"r":8},"8":{"m":7,"t":6},"7":{"t":5,"z":0}},"prevalence":"113.14228833845","glossary":null},{"value":"socialites","paths":{"7":{"s":4,"z":0}},"prevalence":"1539.6112433505","glossary":null},{"value":"socialists","paths":{"8":{"e":4,"m":7}},"prevalence":"14829.547783574","glossary":null},{"value":"socialisms","paths":{"8":{"e":4,"t":6}},"prevalence":"245.27004467423","glossary":null},{"value":"socialiser","paths":{"9":{"d":3,"s":4},"7":{"z":1}},"prevalence":"28.966839649811","glossary":"a person who takes part in social activities"}]

data/10-letters/101.json

@@ -0,0 +1 @@
+[{"value":"watersides","paths":{"9":{"r":1}},"prevalence":"56.94221747523","glossary":null},{"value":"watersider","paths":{"9":{"s":0}},"prevalence":"5.9518477161069","glossary":null}]

data/10-letters/1010.json

@@ -0,0 +1 @@
+[{"value":"sobersides","paths":{"9":{"d":1}},"prevalence":"53.785205164907","glossary":"a serious and sedate individual"},{"value":"sobersided","paths":{"9":{"s":0}},"prevalence":"28.012528989838","glossary":"completely lacking in humor or lightness of touch; \"choreography that was sobersided and sententious\"; \"a play with a sobersided social message\""}]

data/10-letters/1011.json

@@ -0,0 +1 @@
+[{"value":"snugnesses","paths":{"1":{"m":2},"3":{"b":1}},"prevalence":"0","glossary":null},{"value":"snubnesses","paths":{"3":{"g":0}},"prevalence":"0","glossary":null},{"value":"smugnesses","paths":{"1":{"n":0}},"prevalence":"0.18527263402939","glossary":null}]

data/10-letters/1012.json

@@ -0,0 +1 @@
+[{"value":"snuggeries","paths":{"1":{"m":1}},"prevalence":"57.841434893549","glossary":null},{"value":"smuggeries","paths":{"1":{"n":0}},"prevalence":"4.167999599129","glossary":null}]

data/10-letters/1013.json

@@ -0,0 +1 @@
+[{"value":"snufflings","paths":{"1":{"h":1}},"prevalence":"39.237731041485","glossary":null},{"value":"shufflings","paths":{"1":{"n":0}},"prevalence":"264.95027498107","glossary":null}]

data/10-letters/1014.json

@@ -0,0 +1 @@
+[{"value":"snuffliest","paths":{"2":{"i":1}},"prevalence":"0","glossary":null},{"value":"sniffliest","paths":{"2":{"u":0}},"prevalence":"0","glossary":null}]

data/10-letters/1015.json

@@ -0,0 +1 @@
+[{"value":"snowflicks","paths":{"6":{"e":1}},"prevalence":"0","glossary":null},{"value":"snowflecks","paths":{"6":{"i":0}},"prevalence":"0","glossary":null}]

data/10-letters/1016.json

@@ -0,0 +1 @@
+[{"value":"snowblades","paths":{"9":{"r":1}},"prevalence":"0","glossary":null},{"value":"snowblader","paths":{"9":{"s":0}},"prevalence":"0","glossary":null}]

data/10-letters/1017.json

@@ -0,0 +1 @@
+[{"value":"snippiness","paths":{"1":{"l":2},"2":{"a":1}},"prevalence":"34.578211546879","glossary":null},{"value":"snappiness","paths":{"2":{"i":0}},"prevalence":"63.1333115802","glossary":null},{"value":"slippiness","paths":{"2":{"o":3},"1":{"n":0}},"prevalence":"9.3804564263063","glossary":null},{"value":"sloppiness","paths":{"0":{"f":4},"2":{"i":2}},"prevalence":"1957.9276219595","glossary":"untidiness in personal appearance"},{"value":"floppiness","paths":[{"s":3}],"prevalence":"127.52564790986","glossary":null}]

data/10-letters/1018.json

@@ -0,0 +1 @@
+[{"value":"snaphaunch","paths":{"9":{"e":1}},"prevalence":"0","glossary":null},{"value":"snaphaunce","paths":{"9":{"h":0}},"prevalence":"34.488177821156","glossary":null}]

data/10-letters/1019.json

@@ -0,0 +1 @@
+[{"value":"smutchiest","paths":{"1":{"l":1}},"prevalence":"0","glossary":null},{"value":"slutchiest","paths":{"1":{"m":0}},"prevalence":"0","glossary":null}]

data/10-letters/102.json

@@ -0,0 +1 @@
+[{"value":"watchwords","paths":[{"c":1}],"prevalence":"2491.8687990933","glossary":null},{"value":"catchwords","paths":[{"w":0}],"prevalence":"1543.4320387121","glossary":null}]

data/10-letters/1020.json

@@ -0,0 +1 @@
+[{"value":"smouldered","paths":{"1":{"h":1}},"prevalence":"2197.9854468019","glossary":null},{"value":"shouldered","paths":{"1":{"m":0}},"prevalence":"23058.483754772","glossary":"having shoulders or shoulders as specified; usually used as a combining form; \"stoop-shouldered\"; \"broad-shouldered\""}]

data/10-letters/1021.json

@@ -0,0 +1 @@
+[{"value":"smelliness","paths":{"1":{"h":1}},"prevalence":"50.837965341598","glossary":null},{"value":"shelliness","paths":{"1":{"m":0}},"prevalence":"2.1347644453464","glossary":null}]

data/10-letters/1022.json

@@ -0,0 +1 @@
+[{"value":"smatterers","paths":{"1":{"c":2,"h":1}},"prevalence":"129.95820950477","glossary":null},{"value":"shatterers","paths":[{"c":3},{"c":2,"m":0}],"prevalence":"7.9404176784374","glossary":null},{"value":"scatterers","paths":{"1":{"h":1,"m":0}},"prevalence":"1230.2610782149","glossary":null},{"value":"chatterers","paths":{"3":{"r":8},"1":{"l":4},"0":{"s":1}},"prevalence":"517.00884726746","glossary":null},{"value":"clatterers","paths":{"1":{"h":3},"0":{"f":5}},"prevalence":"2.4807452488108","glossary":null},{"value":"flatterers","paths":{"0":{"c":4},"6":{"n":7},"2":{"u":6}},"prevalence":"4068.2421086713","glossary":null},{"value":"flutterers","paths":{"2":{"a":5}},"prevalence":"74.117036830739","glossary":null},{"value":"flatteners","paths":{"6":{"r":5}},"prevalence":"99.439576149374","glossary":null},{"value":"charterers","paths":{"3":{"t":3}},"prevalence":"585.23908644569","glossary":null}]

data/10-letters/1023.json

@@ -0,0 +1 @@
+[{"value":"smashingly","paths":{"1":{"l":1}},"prevalence":"108.90020685954","glossary":"with a loud crash; \"the car went smash through the fence\""},{"value":"slashingly","paths":[{"c":2},{"m":0}],"prevalence":"21.591005465943","glossary":null},{"value":"clashingly","paths":{"1":{"r":3},"0":{"s":1}},"prevalence":"2.8698120946611","glossary":null},{"value":"crashingly","paths":{"1":{"l":2},"2":{"u":4}},"prevalence":"100.93881168384","glossary":null},{"value":"crushingly","paths":{"2":{"a":3}},"prevalence":"998.88041054698","glossary":"in a crushing manner; \"the team was crushingly defeated\""}]

data/10-letters/1024.json

@@ -0,0 +1 @@
+[{"value":"smartasses","paths":{"6":{"r":1}},"prevalence":"32.024663778491","glossary":null},{"value":"smartarses","paths":{"9":{"d":2},"6":{"s":0}},"prevalence":"7.3584159126078","glossary":null},{"value":"smartarsed","paths":{"9":{"s":1}},"prevalence":"2.856707884781","glossary":null}]

data/10-letters/1025.json

@@ -0,0 +1 @@
+[{"value":"smarminess","paths":{"3":{"l":1}},"prevalence":"47.780655262299","glossary":"smug self-serving earnestness"},{"value":"smalminess","paths":{"3":{"r":0}},"prevalence":"0","glossary":null}]

data/10-letters/1026.json

@@ -0,0 +1 @@
+[{"value":"smaragdite","paths":{"8":{"n":1}},"prevalence":"16.13905926774","glossary":null},{"value":"smaragdine","paths":{"8":{"t":0}},"prevalence":"19.388683410133","glossary":null}]

data/10-letters/1027.json

@@ -0,0 +1 @@
+[{"value":"slushiness","paths":[{"p":1}],"prevalence":"11.197308179882","glossary":null},{"value":"plushiness","paths":[{"s":0}],"prevalence":"1.6548181294992","glossary":null}]

data/10-letters/1028.json

@@ -0,0 +1 @@
+[{"value":"slungshots","paths":{"2":{"i":1}},"prevalence":"5.5283576404877","glossary":null},{"value":"slingshots","paths":{"2":{"u":0}},"prevalence":"705.96588779524","glossary":null}]