/ 
Freecell-App-0.01
River stage zero No dependents
/ Freecell::App

NAME

Freecell::App - A simple Freecell solver.

VERSION

Version 0.01

SYNOPSIS

Please run the script freecell-solver to call this module.

EXPORT

none.

SUBROUTINES/METHODS

solve()

The solver is a breadth-first search using an A* heuristic to score the tableau so that the number of positions on the stack can be trimmed to the maxnodes by their score. This is necessary to prevent out_of_memory.

  • First, pick all the positions for the current depth and sort by their score. Pick the mid_score at position maxnodes or last if not at maxnodes yet.

  • Second, push onto the stack all those positions up to mid_score.

  • Third, now using each position in the stack, backtrack to the initial position marking the level attribute with the current depth.

  • Forth, delete all entries in the position hash where level is not equal current to depth

  • Fifth, using the stack, search for all the new positions.

search()

Call generate_nodelist() then play() each node and append the autoplay() moves. Store the new Tableau in the position hash if it is not a duplicate. The key for the position hash is create by to_token() and the fields stored in the position hash are [ depth, token, node, score, 0 (place holder for level used later during trim) ] If one of the new positons solve the hand, then call backtrack() to build the solution array and then call out() to write the html. Set found to true.

generate_nodelist($win_xp)

Creates a node for all valid plays of a given Tableau.

backtrack($key)

This takes the final key and calls undo() until the initial position is reached and pushes each node onto the solutions array.

out(@solution)

Writes the html solution to disk.

AUTHOR

Shirl Hart, <shirha at cpan.org>

BUGS

Please report any bugs or feature requests to bug-freecell-app at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Freecell-App. 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 Freecell::App

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Shirl Hart.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.