NAME

Games::Solitaire::Verify::Solution - verify an entire solution of Freecell Solver (or a similar solve)

VERSION

version 0.1900

SYNOPSIS

use Games::Solitaire::Verify::Solution;

my $input_filename = "freecell-24-solution.txt";

open (my $input_fh, "<", $input_filename)
    or die "Cannot open file $!";

# Initialise a column
my $solution = Games::Solitaire::Verify::Solution->new(
    {
        input_fh => $input_fh,
        variant => "freecell",
    },
);

my $ret = $solution->verify();

close($input_fh);

if ($ret)
{
    die $ret;
}
else
{
    print "Solution is OK";
}

VERSION

version 0.1900

METHODS

Games::Solitaire::Verify::Solution->new({variant => $variant, input_fh => $input_fh})

Constructs a new solution verifier with the variant $variant (see Games::Solitaire::Verify::VariantsMap ), and the input file handle $input_fh.

If $variant is "custom", then the constructor also requires a 'variant_params' key which should be a populated Games::Solitaire::Verify::VariantParams object.

One can specify a numeric 'max_rank' argument to be lower than 13 (new in 0.1900).

$solution->verify()

Traverse the solution verifying it.

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/fc-solve/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.

SUPPORT

Perldoc

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

perldoc Games::Solitaire::Verify::Solution

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-solitaire-verify at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Games-Solitaire-Verify. 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/fc-solve

git clone git://github.com/shlomif/fc-solve.git