.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::Random::ISAAC::XS 3pm"
.TH Math::Random::ISAAC::XS 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::Random::ISAAC::XS \- C implementation of the ISAAC PRNG algorithm
.SH VERSION
.IX Header "VERSION"
version 1.004
.SH SYNOPSIS
.IX Header "SYNOPSIS"
This module implements the same interface as \f(CW\*(C`Math::Random::ISAAC\*(C'\fR and can
be used as a drop-in replacement. This is the recommended implementation of
the module, based on Bob Jenkins' reference implementation in C.
.PP
Selecting the backend to use manually really only has two uses:
.IP \(bu 4
If you are trying to avoid the small overhead incurred with dispatching
method calls to the appropriate backend modules.
.IP \(bu 4
If you are testing the module for performance and wish to explicitly decide
which module you would like to use.
.PP
Example code:
.PP
.Vb 3
\&  # With Math::Random::ISAAC
\&  my $rng = Math::Random::ISAAC\->new(time);
\&  my $rand = $rng\->rand();
\&
\&  # With Math::Random::ISAAC::XS
\&  my $rng = Math::Random::ISAAC::XS\->new(time);
\&  my $rand = $rng\->rand();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
See Math::Random::ISAAC for the full description.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\&  Math::Random::ISAAC::XS\->new( @seeds )
.Ve
.PP
Implements the interface as specified in \f(CW\*(C`Math::Random::ISAAC\*(C'\fR
.SS rand
.IX Subsection "rand"
.Vb 1
\&  $rng\->rand()
.Ve
.PP
Implements the interface as specified in \f(CW\*(C`Math::Random::ISAAC\*(C'\fR
.SS irand
.IX Subsection "irand"
.Vb 1
\&  $rng\->irand()
.Ve
.PP
Implements the interface as specified in \f(CW\*(C`Math::Random::ISAAC\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Math::Random::ISAAC
.PP
1;
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Math\-Random\-ISAAC\-XS
.PP
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.
.SH AUTHOR
.IX Header "AUTHOR"
Jonathan Yu <jawnsy@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Legally speaking, this package and its contents are:
.PP
.Vb 1
\&  Copyright (c) 2011 by Jonathan Yu <jawnsy@cpan.org>.
.Ve
.PP
But this is really just a legal technicality that allows the author to
offer this package under the public domain and also a variety of licensing
options. For all intents and purposes, this is public domain software,
which means you can do whatever you want with it.
.PP
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.