/ 
Games-Solitaire-Verify-0.1900
River stage one • 2 direct dependents • 4 total dependents
/ Games::Solitaire::Verify::State

NAME

Games::Solitaire::Verify::State - a class for Solitaire states (or positions) of the entire board.

VERSION

version 0.1900

SYNOPSIS

use Games::Solitaire::Verify::State;

my $board = <<"EOF";
Foundations: H-6 C-A D-A S-4
Freecells:  3D  8H  JH  9H
: 4C 2C 9C 8C QS JD
: KS QH
: QC 9S
: 5C
: 2D KD TH TC TD 8D 7C 6D 5S 4D 3C
: 7H JS KH TS KC QD JC
: 9D 8S
: 7S 6C 7D 6S 5D
EOF

# Initialise a board
my $board = Games::Solitaire::Verify::State->new(
    {
        string => $board,
        variant => "freecell",
    },
);

# Prints 8.
print $board->num_columns(), "\n";

# Prints ": QC 9S"
print $board->get_column(2)->to_string(), "\n"

VERSION

version 0.1900

FUNCTIONS

$self->set_freecells($freecells)

Sets the freecells' object, which should be a Games::Solitaire::Verify::Freecells object.

$self->add_column($columns)

Adds a new column of cards that should be an Games::Solitaire::Verify::Column object.

$self->set_foundations($foundations);

Sets the foundations to a value. Should be isa Games::Solitaire::Verify::Foundations .

$state->get_freecell($index)

Returns the contents of the freecell No. $index or undef() if it's empty.

$state->set_freecell($index, $card)

Assigns $card to the contents of the freecell No. $index .

$state->get_foundation_value($suit, $index)

Returns the foundation value for the suit $suit of the foundations No. $index .

$state->increment_foundation_value($suit, $index)

Increments the foundation value for the suit $suit of the foundations No. $index .

$board->num_decks()

Returns the number of decks that the variant has. Useful when querying the foundations.

$board->num_freecells()

Returns the number of Freecells in the board.

$board->num_empty_freecells()

Returns the number of empty Freecells on the board.

$board->num_columns()

The number of columns in the board.

$board->get_column($index)

Gets the column object for column No. $index.

$board->num_empty_columns()

Returns the number of completely unoccupied columns in the board.

$board->clone()

Returns a clone of the board, with all of its element duplicated.

my $verdict = $board->verify_and_perform_move($move);

Performs $move on the board. If successful, returns 0. Else returns a non-zero value. See Games::Solitaire::Verify::Move for more information.

$self->clear_freecell($index)

Clears/empties the freecell at position $pos .

$board->verify_contents({max_rank => 13});

Verify that all the cards inside the state are present and exactly once. 'max_rank' should be 13 unless you want to only include cards up to a lower rank.

This method either throws an exception object or returns normally.

(New in version 0.1900 .)

$self->to_string()

Stringifies the board into the Freecell Solver solution display notation.

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::State

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