.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Games::Bingo::Column 3" .TH Games::Bingo::Column 3 "2008-01-05" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Games::Bingo::Column \- a column class used for generating bingo cards .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $c = Games::Bingo::Column-Enew(); .Ve .PP .Vb 3 \& foreach my $number(@numbers) { \& $c-Epopulate($number); \& } .Ve .PP .Vb 1 \& my @numbers = qw(1 2 3 4 5 6 7 8 9); .Ve .PP .Vb 1 \& my $c = Games::Bingo::Column-Enew(@numbers); .Ve .PP .Vb 1 \& my $number = $c-Eget_highest_number(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Column is used when building the bingo cards and is a temporary data structure. .PP The class has two attributes: .IP "\(bu" 4 _array .Sp \&\fB_array\fR is a list of numbers for containment in the class, since the class actually is nothing but an array with a status flag. .IP "\(bu" 4 label .Sp The label being the group to which the numbers in the array belong. .SH "METHODS" .IX Header "METHODS" .Sh "new" .IX Subsection "new" The contructor optionally takes an array as an argument, and sets the \&\fB_array\fR attribute to point to this. .Sh "populate" .IX Subsection "populate" \&\fBpopulate\fR 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. .Sh "get_highest_number" .IX Subsection "get_highest_number" The \fBget_highest_number\fR is also a simple accessor, it returns the highest number from the list contained in the class. .PP If the optional parameter is set to true, it splices the list contained in the class, meaning the class shrinks by \fB1\fR. Default behaviour is not shrinking. .Sh "get_random_number" .IX Subsection "get_random_number" The \fBget_random_\|_number\fR is also a simple accessor, it returns a random number from the list contained in the class. .PP If the optional parameter is set to true, it splices the list contained in the class, meaning the class shrinks by \fB1\fR. Default behaviour is not shrinking. See also \fBget_highest_number\fR. .Sh "_reverse" .IX Subsection "_reverse" The method used by Perls sort to sort the list .Sh "get_label" .IX Subsection "get_label" Accessor returning the label of the G::B::Column object. .Sh "count_numbers" .IX Subsection "count_numbers" Returns the number of numbers contained in a G::B::Column object. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "Games::Bingo" 4 .IX Item "Games::Bingo" .PD 0 .IP "Games::Bingo::ColumnCollection" 4 .IX Item "Games::Bingo::ColumnCollection" .PD .SH "TODO" .IX Header "TODO" The \s-1TODO\s0 file contains a complete list for the whole Games::Bingo project. .SH "AUTHOR" .IX Header "AUTHOR" jonasbn .SH "ACKNOWLEDGEMENTS" .IX Header "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. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Games::Bingo and related modules are free software and is released under the Artistic License. See for details. .PP Games::Bingo is (C) 2003 Jonas B. Nielsen (jonasbn)