view release on metacpan or  search on metacpan

lib/Acme/MathProfessor/RandomPrime.pm  view on Meta::CPAN

package Acme::MathProfessor::RandomPrime;

use 5.006;
use strict;
use warnings;
no  warnings 'syntax';

use Exporter ();

our $VERSION = '2009121001';
our @ISA     = qw [Exporter];
our @EXPORT  = qw [random_prime];

sub random_prime {rand () < .75 ? 17 : 23}


1;

__END__

=head1 NAME

Acme::MathProfessor::RandomPrime - Pick a random prime number

=head1 SYNOPSIS
 
 use Acme::MathProfessor::RandomPrime;

 say 'Let $N be a random prime'; $N = random_prime;

=head1 DESCRIPTION

Math professors often pick a random prime to work out an example. 
This module mimics the algorithm the typical math professor uses.
This allows you to be a math professor!

=head1 REFERENCES

=over 2

=item *

L<< http://en.wikipedia.org/wiki/17_(number) >>

=item * 

L << http://www.catb.org/jargon/html/R/random-numbers.html >>

=back

=head1 DEVELOPMENT

The current sources of this module are found on github,
L<< git://github.com/Abigail/Acme--MathProfessor--RandomPrime.git >>.

=head1 AUTHOR

Abigail, L<< mailto:cpan@abigail.be >>.

=head1 COPYRIGHT and LICENSE

Copyright (C) 2009 by Abigail.

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 AUTHOR 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.

=head1 INSTALLATION

To install this module, run, after unpacking the tar-ball, the 
following commands:

   perl Makefile.PL
   make
   make test