Marcel Grünauer == hanekomu (跳ね込む) > Games-Go-Coordinate-0.04 > Games::Go::Coordinate

Download:
Games-Go-Coordinate-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 0.04   Source  

NAME ^

Games::Go::Coordinate - represents a board coordinate in the game of Go

SYNOPSIS ^

    use Games::Go::Coordinate;

    my $c1 = Games::Go::Coordinate->new(x => 4, y => 3);
    my $c2 = Games::Go::Coordinate->new(x => 4, y => 10);
    if ($c2 gt $c1) { ... }

DESCRIPTION ^

This class represents a board coordinate in the game of Go. Coordinate objects can be compared (as strings) to see whether two ranks are equal or whether one rank is higher than the other. Coordinate objects stringify to the SGF notation (for example, (4,10) stringifies to dj.

METHODS ^

set_sgf_coordinate
    $coord->set_sgf_coordinate('cf');

Takes a coordinate in SGF notation and sets x() and y() from it.

new_from_sgf_coordinate
    my $cord = Games::Go::Coordinate->new_from_sgf_coordinate('cf');

Alternative constructor that accepts an SGF coordinate and sets x() and y() from it.

to_sgf

Returns the coordinate in SGF notation. This is also how the coordinate object stringifies.

as_list

Returns the coordinate in (x,y) notation. For example, it might return a string (16,17).

translate
    $coord->translate(2, -3);

Takes as arguments - in that order - a horizontal delta and a vertical delta and translates the coordinate by those deltas.

Games::Go::Coordinate inherits from Moose::Object.

The superclass Moose::Object defines these methods and functions:

    new(), BUILDALL(), DEMOLISHALL(), DESTROY(), does(), dump()

TAGS ^

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the gamesgocoordinate tag.

VERSION ^

This document describes version 0.04 of Games::Go::Coordinate.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to <bug-games-go-coordinate@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHORS ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007-2008 by the authors.

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