Jeffrey Hayes Anderson

NAME

Encode::Wechsler - Just another Wechsler encoder/decoder

THIS MODULE IS AN ALPHA RELEASE!

SYNOPSIS

Object oriented interface:

  use Encode::Wechsler;

  my $wechsler = Encode::Wechsler->new;
  my @array  = $wechsler->decode( 'xp3_0ggmligkcz32w46' );
  my $string = scalar $wechsler->decode( 'xp3_0ggmligkcz32w46' );

DESCRIPTION

Wechsler encoding is used to describe game boards for Conway's Game of Life.

THIS MODULE IS AN ALPHA RELEASE!

Interface will most likely change. Also, there is no encode() method for this release. This release only provides decode(). No procedural interface is currently available but should be in a future release, as well as an encode() method. (The author's current needs only require decoding.) :D

METHODS

new( %params )
  my $wechsler = Encode::Wechsler->new();

Constructs object. Accepts the following named parameters:

  • pad

    Integer. Ensure resulting game grid has empty cells on all four edges: the top and bottom rows and left most and right most columns will all be "turned off." The amount of padding determines how many rows/cols of padding will be added.

      my $wechsler = Encode::Wechsler->new( pad => 4 );

    Some codes require additional padding in order to sustain properly.

encode( $string or $array_ref )

Not currently implemented.

decode( $string )

Attempts to decode the string argument. Returns a list of array references (2d array) when called in list context:

  my @array  = $wechsler->decode( 'xp3_0ggmligkcz32w46' );

Or returns a text representation of the game board in scalar context:

  my $string = scalar $wechsler->decode( 'xp3_0ggmligkcz32w46' );

Throws exception if code is invalid.

BUGS AND LIMITATIONS

Please report any bugs or feature requests to either

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 Encode::Wechsler

The Github project is https://github.com/jeffa/Encode-Wechsler

You can also look for information at:

ACKNOWLEDGEMENTS

Pattern notion developed by Allan Wechsler 1992. https://catagolue.appspot.com/help/wechsler.txt

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2017 Jeff Anderson.

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.