Shlomi Fish

NAME

Math::RNG::Microsoft - a pseudo-random number generator compatible with Visual C.

VERSION

version 0.0.3

SYNOPSIS

    use Math::RNG::Microsoft;

    my $randomizer = Math::RNG::Microsoft->new(seed => 24);

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

DESCRIPTION

This is a random number generator used 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 ).

NOTE: This is not a cryptologically secure random number generator, nor is it a particularly good one, so its use is discouraged unless compatibility with the Windows C Run-time-library is needed.

VERSION

Version 0.0.3

SUBROUTINES/METHODS

new

The constructor. Accepts a numeric seed as an argument.

    my $randomizer = Math::RNG::Microsoft->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 <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/NoAuth/Bugs.html?Dist=Math-RNG-Microsoft or by email to bug-math-rng-microsoft@rt.cpan.org.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT

Perldoc

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

  perldoc Math::RNG::Microsoft

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-math-rng-microsoft at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Math-RNG-Microsoft. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

http://bitbucket.org/shlomif/abc-path

  hg clone ssh://hg@bitbucket.org/shlomif/abc-path