.\" 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::LMSolve::Input 3" .TH Games::LMSolve::Input 3 "2007-08-27" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Games::LMSolve::Input \- input class for LM\-Solve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Games::LMSolve::Input; .Ve .PP .Vb 1 \& my $input_obj = Games::LMSolve::Input->new(); .Ve .PP .Vb 1 \& my $file_spec = "board.txt"; .Ve .PP .Vb 8 \& my $spec = \& { \& 'dims' => { 'type' => "xy(integer)", 'required' => 1, }, \& 'planks' => { 'type' => "array(start_end(xy(integer)))", \& 'required' => 1, \& }, \& 'layout' => { 'type' => "layout", 'required' => 1,}, \& }; .Ve .PP .Vb 1 \& my $input_fields = $input_obj->input_board($filename, $spec); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class implements the \f(CW\*(C`input_board\*(C'\fR method, which enables to read boards in \*(L"key = value\*(R" format. Several types of values are supported. .Sh "\s-1METHODS\s0" .IX Subsection "METHODS" .Sh "$self\->\fInew()\fP" .IX Subsection "$self->new()" Constrcuts a new object. Accepts no meaningful arguments. .ie n .Sh "$self\->input_board($file_spec, $spec);" .el .Sh "$self\->input_board($file_spec, \f(CW$spec\fP);" .IX Subsection "$self->input_board($file_spec, $spec);" This method accepts two arguments. \f(CW$file_spec\fR which is the filename, reference to a filehandle, or reference to the text containing the board specification. .PP $spec is a specification of the board given as a reference to a hash. The keys are the keys inside the file. The values are references to hashes containing parameters. The 'required' parameter is given to specify that an exception should be thrown if this key was not specified. The other parameter (a mandatory one) is type which specified the type of the value. Available types are: .IP "integer" 8 .IX Item "integer" A simple integer (will be returned as a scalar) .IP "xy(integer)" 8 .IX Item "xy(integer)" An (X,Y) pair. Will be returned as { 'x' => \f(CW$x\fR, 'y' => \f(CW$y\fR }. .IP "array(xy(integer))" 8 .IX Item "array(xy(integer))" An array of [(X1,Y1),(X2,Y2),(X3,Y3)...] pairs. Will be returned as a reference to an array of (X,Y) pairs. .IP "array(start_end(xy(integer)))" 8 .IX Item "array(start_end(xy(integer)))" An array of [((\s-1SX1\s0,SX2)\->(\s-1EX1\s0,EX2)), ((\s-1SX1\s0,SX2)\->(\s-1EX1\s0,EX2))...] pairs of (X,Y) pairs. Will be returned as a reference to an array of .Sp .Vb 4 \& { \& 'start' => { 'x' => $start_x, 'y' => $start_y }, \& 'end' => { 'x' => $end_x, 'y' => $end_y }, \& } .Ve .IP "layout" 8 .IX Item "layout" This is a generic layout that comes inside a here\-document. It is returned as an array of lines that later have to be processed by another routine. .ie n .Sh "$self\->input_horiz_vert_walls_layout($width, $height, \e@lines)" .el .Sh "$self\->input_horiz_vert_walls_layout($width, \f(CW$height\fP, \e@lines)" .IX Subsection "$self->input_horiz_vert_walls_layout($width, $height, @lines)" Input a horizontal-vertical line layout as exists in a maze. .SH "AUTHORS" .IX Header "AUTHORS" Written by Shlomi Fish ( )