/ 
Games-ABC_Path-Generator-v0.2.0
River stage zero No dependents
/ Games::ABC_Path::MicrosoftRand

NAME

Games::ABC_Path::MicrosoftRand - a pseudo-random number generator compatible with Visual C.

VERSION

Version 0.2.0

SYNOPSIS

use Games::ABC_Path::MicrosoftRand;

my $randomizer = Games::ABC_Path::MicrosoftRand->new(seed => 24);

my $random_digit = $randomizer->rand_max(10);

DESCRIPTION

This is a random number generator use by Games::ABC_Path::Generator, which emulates the one found in Microsoft's Visual C++. It was utilised here, out of familiarity and accessibility, because it is commonly used to generate Freecell layouts in the Freecell world (see http://en.wikipedia.org/wiki/FreeCell_%28Windows%29 ).

SUBROUTINES/METHODS

new

The constructor. Accepts a numeric seed as an argument.

my $randomizer = Games::ABC_Path::MicrosoftRand->new(seed => 1);

$randomizer->rand()

Returns a random integer from 0 up to 0x7fff - 1.

my $n = $randomizer->rand()

$randomizer->max_rand($max)

Returns a random integer in the range 0 to ($max-1).

my $n = $randomizer->max_rand($max);
# $n is now between 0 and $max - 1.

$randomizer->seed($seed)

Can be used to re-assign the seed of the randomizer (though not recommended).

my $array_ref = $randomizer->shuffle(\@array)

Shuffles the array reference of the first argument, destroys it and returns it. This is using the fisher-yates shuffle.

AUTHOR

Shlomi Fish, http://www.shlomifish.org/ .

BUGS

Please report any bugs or feature requests to bug-games-abc_path-generator at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-ABC_Path-Generator. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Games::ABC_Path::MicrosoftRand

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2011 Shlomi Fish.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.