The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Algorithm-MasterMind-v0.4.5
River stage zero No dependents
2 ++
/ Algorithm::MasterMind::Secret

NAME

Algorithm::MasterMind::Secret - Minimal framework for MM secrets

SYNOPSIS

    use Algorithm::MasterMind::Secret;

    my $sikrit = new Algorithm::MasterMind::Secret 'ABCD';

    my $blacks_whites = $sikrit->check('BBBB'}

DESCRIPTION

Basically a string and a hash, caches the string in a hash so that it is faster to check against it in mastermind. This class is heavily optimized for speed, which might result in some inconvenients.

INTERFACE

new ( $string )

A string in an arbitrary alphabet, but should be the same as the ones you will use to solve

check( $string )

Checks a combination against the secret code, returning a hashref with the number of blacks (correct in position) and whites (correct in color, not position). The string must be a variable. So don't count on the variable after the call.

check_secret( $secret )

Same as above, but the argument must be a Algorithm::Mastermind::Secret.

string()

Returns the string corresponding to this secret.

CONFIGURATION AND ENVIRONMENT

Algorithm::MasterMind requires no configuration files or environment variables.

DEPENDENCIES

Algorithm::Evolutionary, but only for one of the strategies. Algorithm::Combinatorics, used to generate combinations and for exhaustive search strategies.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-algorithm-mastermind@rt.cpan.org, or through the web interface at http://rt.cpan.org.

SEE ALSO

Other modules in CPAN which you might find more useful than this one are at Games::Mastermind::Solver, which I didn't use and extend for no reason, although I should. Also Games::Mastermind::Cracker

You can try and play this game at http://geneura.ugr.es/~jmerelo/GenMM/mm-eda.cgi, restricted to 4 pegs and 6 colors. The program mm-eda.cgi should also be available in the apps directory of this distribution.

The development of this projects is hosted at sourceforge, https://sourceforge.net/projects/opeal/develop, check it out for the latest bleeding edge release.

If you use any of these modules for your own research, we would very grateful if you would reference the papers that describe this, such as this one:

 @article{merelo2010finding,
  title={{Finding Better Solutions to the Mastermind Puzzle Using Evolutionary Algorithms}},
  author={Merelo-Guerv{\'o}s, J. and Runarsson, T.},
  journal={Applications of Evolutionary Computation},
  pages={121--130},
  year={2010},
  publisher={Springer}
 }

AUTHOR

JJ Merelo <jj@merelo.net>

LICENCE AND COPYRIGHT

Copyright (c) 2009, JJ Merelo <jj@merelo.net>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.