/ 
Games-Bingo-0.18
River stage one • 1 direct dependent • 1 total dependent
/ Games::Bingo::Column

NAME

Games::Bingo::Column - a column class used for generating bingo cards

SYNOPSIS

my $c = Games::Bingo::Column-E<gt>new();

foreach my $number(@numbers) {
	$c-E<gt>populate($number);
}

my @numbers = qw(1 2 3 4 5 6 7 8 9);

my $c = Games::Bingo::Column-E<gt>new(@numbers);

my $number = $c-E<gt>get_highest_number();

DESCRIPTION

The Column is used when building the bingo cards and is a temporary data structure.

The class has two attributes:

  • _array

    _array is a list of numbers for containment in the class, since the class actually is nothing but an array with a status flag.

  • label

    The label being the group to which the numbers in the array belong.

METHODS

new

The contructor optionally takes an array as an argument, and sets the _array attribute to point to this.

populate

populate is a simple accessor which can be used to add additional number to the list of number contained in the class. This is a secondary use of the class, please refer to the description of the algoritms used in the program described in the Games::Bingo class.

get_highest_number

The get_highest_number is also a simple accessor, it returns the highest number from the list contained in the class.

If the optional parameter is set to true, it splices the list contained in the class, meaning the class shrinks by 1. Default behaviour is not shrinking.

get_random_number

The get_random__number is also a simple accessor, it returns a random number from the list contained in the class.

If the optional parameter is set to true, it splices the list contained in the class, meaning the class shrinks by 1. Default behaviour is not shrinking. See also get_highest_number.

_reverse

The method used by Perls sort to sort the list

get_label

Accessor returning the label of the G::B::Column object.

count_numbers

Returns the number of numbers contained in a G::B::Column object.

SEE ALSO

Games::Bingo
Games::Bingo::ColumnCollection

TODO

The TODO file contains a complete list for the whole Games::Bingo project.

ACKNOWLEDGEMENTS

My friend Allan helped me out with some of the algoritmic stuff and was in on the development when this class was thought up.

AUTHOR

Jonas B. Nielsen, (jonasbn) - <jonasbn@cpan.org>

COPYRIGHT

Games-Bingo is (C) by Jonas B. Nielsen, (jonasbn) 2003-2015

Games-Bingo is released under the artistic license 2.0