View on
MetaCPAN
Shlomi Fish > Games-LMSolve > Games::LMSolve

Download:
Games-LMSolve-0.10.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v0.10.1   Source  

NAME ^

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

VERSION ^

version 0.10.1

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.

VERSION ^

version 0.10.1

METHODS ^

new

The constructor. Accepts the following named arguments:

$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.

SEE ALSO ^

Games::LMSolve::Base

http://www.shlomifish.org/lm-solve/ - the LM-Solve homepage.

BUGS ^

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

You can also look for information at:

AUTHORS ^

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

COPYRIGHT & LICENSE ^

Copyright 2002 Shlomi Fish, all rights reserved.

This program is released under the following license: MIT X11.

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 http://rt.cpan.org/Public/Dist/Display.html?Name=Games-LMSolve or by email to bug-games-lmsolve@rt.cpan.org.

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

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-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 https://github.com/shlomif/lm-solve-source.git
syntax highlighting: