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.
Games::Go::Coordinate inherits from Class::Accessor::Complex.
The superclass Class::Accessor::Complex defines these methods and functions:
carp(), cluck(), croak(), flatten(), mk_abstract_accessors(),
mk_array_accessors(), mk_boolean_accessors(),
mk_class_array_accessors(), mk_class_hash_accessors(),
mk_class_scalar_accessors(), mk_concat_accessors(),
mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
mk_new(), mk_object_accessors(), mk_scalar_accessors(),
mk_set_accessors(), mk_singleton()The superclass Class::Accessor defines these methods and functions:
_carp(), _croak(), _mk_accessors(), accessor_name_for(),
best_practice_accessor_name_for(), best_practice_mutator_name_for(),
follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
mk_wo_accessors(), mutator_name_for(), set()The superclass Class::Accessor::Installer defines these methods and functions:
install_accessor(), subname()METHODS
- new
-
my $obj = Games::Go::Coordinate->new; my $obj = Games::Go::Coordinate->new(%args);Creates and returns a new object. The constructor will accept as arguments a list of pairs, from component name to initial value. For each pair, the named component is initialized by calling the method of the same name with the given value. If called with a single hash reference, it is dereferenced and its key/value pairs are set as described before.
- set_sgf_coordinate
-
$coord->set_sgf_coordinate('cf');Takes a coordinate in SGF notation and sets
x()andy()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()andy()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.
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.03 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/>.
AUTHOR
Marcel Grünauer, <marcel@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2007 by Marcel Grünauer
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.