/ 
Games-ABC_Path-Solver-v0.0.3
River stage zero No dependents
/ Games::ABC_Path::Solver::Board

NAME

Games::ABC_Path::Solver::Board - handles an ABC Path board.

VERSION

Version 0.0.3

SYNOPSIS

use strict;
use warnings;

my $board_fn = shift(@ARGV);

if (!defined ($board_fn))
{
    die "Filename not specified - usage: abc-path-solver.pl [filename]!";
}

my $solver = Games::ABC_Path::Solver::Board->input_from_file($board_fn);
# Now let's do a neighbourhood inferring of the board.

$solver->solve;

foreach my $move (@{$solver->get_moves})
{
    print +(' => ' x $move->get_depth()), $move->get_text(), "\n";
}

FUNCTIONS

new

The constructor.

get_successful_layouts()

Returns a copy of the successful layouts. Each one of them is a completed Games::ABC_Path::Solver::Board the successful layouts. Each one of them is a completed Games::ABC_Path::Solver::Board object.

$board->get_possible_letters_for_cell($x,$y)

Returns an array reference of the possible letters for the cell ($x,$y) where $x and $y are in the range 0..4 and the letters are their letter names.

$board->solve()

Performs the actual solution. Should be called after input.

$self->get_successes_text_tables()

This returns a textual representation of the successful layouts.

$board->input_from_file($filename)

Inputs the board from the $filename file path containing a representation of the initial board.

Sample boards can be found in the distribution under t/layouts/ .

Here is the description of their formats. The first line should be the magic string ABC Path Solver Layout Version 1: , and the next line should be a row of 7 letters, the first being a hint for the top-left-to-bottom-right perpendicular, the last being a hint for the top-right-to-bottom-left perpendicular and the rest of the letters being vertical hints.

After that, there are 5 rows of horizontal hints being a letter, 5 spaces and another letter. On one of the squares one can put a letter instead of a space, to indicate it must be there.

The last row is another row of vertical hints and perpendicular hints.

$board->get_moves()

Returns the moves performed by the board. Each move is an object of a Games::ABC_Path::Solver::Move sub-class.

AUTHOR

Shlomi Fish, <shlomif at cpan.org>

BUGS

Please report any bugs or feature requests to bug-games-abc_path-solver at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-ABC_Path-Solver. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Games::ABC_Path::Solver::Board

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2010 Shlomi Fish.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.