NAME

Games::LMSolve - base class for LM-Solve solvers factories

VERSION

version 0.14.2

SYNOPSIS

    package MyReg;
    use Games::LMSolve;
    @ISA = qw(Games::LMSolve);
    use MyPuzzle::Solver;
    sub register_all_solvers
    {
        my $self = shift;
        $self->register_solvers({ 'mypuzzle' => "MyPuzzle::Solver"});
        $self->set_default_variant("mypuzzle");
        return 0;
    }
    package main;
    my $r = MyReg->new();
    $r->main();

DESCRIPTION

This class is a registry of Games::LMSolve::Base-derived solvers. It maps variants IDs to the classes. To use it, sub-class it and over-ride the register_all_solvers() function. In it use register_solvers while passing a reference to a hash that contains the variant IDs as keys and the class names, or constructor functions as values.

You can also use set_default_variant() to set the default variant.

After all that, in your main script initialize a registry object, and call the main() method.

METHODS

new

The constructor. Accepts the following named arguments:

•: 'default_variant'
The default variant for the registry to be used in case one is not specified.

$registry->set_default_variant($variant)

Sets the default variant to $variant.

$self->register_solvers(\%solvers)

Adds the %solvers map of names to class names to the registry.

$self->register_all_solvers()

To be sub-classes to register all the solvers that the registry wants to register. Does nothing here.

$self->main()

the main function that handles the command line arguments and runs the program.

AUTHORS

Shlomi Fish, <http://www.shlomifish.org/>

COPYRIGHT & LICENSE

This program is released under the following license: MIT / Expat.

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.

MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.

<https://metacpan.org/release/Games-LMSolve>
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<https://rt.cpan.org/Public/Dist/Display.html?Name=Games-LMSolve>
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/Games-LMSolve>
CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/G/Games-LMSolve>
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Games-LMSolve>
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Games::LMSolve>

Bugs / Feature Requests

Please report any bugs or feature requests by email to "bug-games-lmsolve at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Games-LMSolve>. 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/lm-solve-source>

  git clone git://github.com/shlomif/lm-solve-source.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/lm-solve-source/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 is free software, licensed under:

  The MIT (X11) License