The Perl Advent Calendar needs more articles for 2022. Submit your idea today!

NAME

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

VERSION

version 0.6.2

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 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.

my $board = Games::ABC_Path::Solver::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.

my $board = Games::ABC_Path::Solver::Board->input_from_v1_string($layout_string)

This is a class method that inputs a version 1 string (as specified in input_from_file only without the opening magic line.)

$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>

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-games-abc_path-solver at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Games-ABC_Path-Solver. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/abc-path

  git clone https://github.com/shlomif/abc-path

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/abc-path/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License