Showing pcg32.pl (raw)

  1. #!/usr/bin/env perl
  2.  
  3. ###############################################################################
  4. # Two implementations of PCG32. One in native Perl with no dependencies, and
  5. # one that uses Math::Int64. Surprisingly the native version is significantly
  6. # faster.
  7. #
  8. # A lot of work was done here to mimic how C handles overflow multiplication
  9. # on large uint64_t numbers. Perl converts scalars that are larger than 2^64-1
  10. # to floating point on the backend. We do *NOT* want that for PCG, because
  11. # PCG (and more PRNGs) rely on overflow math to do their magic. We utilize
  12. # 'use integer' to force Perl to do all math with regular 64bit values. When
  13. # overflow occurs Perl likes to convert large values to negative numbers. In
  14. # the original C all math is done with uint64_t, so we have to convert the
  15. # IV/negative numbers back into UV/unsigned (positive) values. PCG also uses
  16. # some uint32_t variables internally, so we mimic that by doing the math in
  17. # 64bit and then masking down to only the 32bit number.
  18. #
  19. ###############################################################################
  20. #
  21. # Original C code from: https://www.pcg-random.org/download.html
  22. #
  23. # typedef struct { uint64_t state;  uint64_t inc; } pcg32_random_t;
  24. #
  25. # uint32_t pcg32_random_r(pcg32_random_t* rng) {
  26. #     uint64_t oldstate = rng->state;
  27. #     // Advance internal state
  28. #     rng->state = oldstate * 6364136223846793005ULL + (rng->inc|1);
  29. #     // Calculate output function (XSH RR), uses old state for max ILP
  30. #     uint32_t xorshifted = ((oldstate >> 18u) ^ oldstate) >> 27u;
  31. #     uint32_t rot = oldstate >> 59u;
  32. #     return (xorshifted >> rot) | (xorshifted << ((-rot) & 31));
  33. # }
  34. #
  35. ###############################################################################
  36.  
  37. use strict;
  38. use warnings;
  39. use v5.16;
  40. use Math::Int64 qw(uint64 uint64_to_number);
  41. use Getopt::Long;
  42. use Test::More;
  43.  
  44. ###############################################################################
  45. ###############################################################################
  46.  
  47. my $debug = 0;
  48. my $s1    = 15939250660798104135; # Default 64bit seed1
  49. my $s2    = 3988331200502121509;  # Default 64bit seed2
  50. my $seeds = [];
  51.  
  52. GetOptions(
  53.     'debug'      => \$debug,
  54.     'seed1=i'    => \$s1,
  55.     'seed2=i'    => \$s2,
  56.     'random'     => \&randomize_seeds,
  57.     'unit-tests' => \&run_unit_tests,
  58. );
  59.  
  60. # We build two sets of seeds from the 32bit seeds
  61. my $seeds64 = [[$s1, 1], [$s2, 1]];
  62.  
  63. my $num = $ARGV[0] || 8;
  64. my ($seed1, $seed2);
  65.  
  66. print color('yellow', "Seeding PRNG with: $s1 / $s2\n\n");
  67.  
  68. $seeds = [$s1, $s2];
  69. for (my $i = 1; $i <= $num; $i++) {
  70.     my $num32 = pcg32_perl($seeds);
  71.     my $num64 = pcg64_perl($seeds64);
  72.     printf("%2d) %10u / %20u\n", $i, $num32, $num64);
  73. }
  74.  
  75. ################################################################################
  76. ################################################################################
  77. ################################################################################
  78.  
  79. #my $seeds = [12, 34];
  80. #my $rand  = pcg32_perl($seeds);
  81. sub pcg32_perl {
  82.     # state/inc are passed in by reference
  83.     my ($seeds)  = @_;
  84.     my $oldstate = $seeds->[0]; # Save original state
  85.  
  86.     # We use interger math because Perl converts to floats any scalar
  87.     # larger than 2^64 - 1. PCG *requires* 64bit uint64_t math, with overflow,
  88.     # to calculate correctly. We have to unconvert the overflowed signed integer (IV)
  89.     # to an unsigned integer (UV) using bitwise or against zero. (weird hack)
  90.     use integer;
  91.     $seeds->[0]  = ($oldstate * 6364136223846793005 + ($seeds->[1] | 1)) | 0;
  92.     no integer;
  93.  
  94.     my $xorshifted = ((($oldstate >> 18) ^ $oldstate) >> 27) & 0xFFFFFFFF;
  95.  
  96.     # -$rot on a uint32_t is the same as (2^32 - $rot)
  97.     my $rot    = ($oldstate >> 59);
  98.     my $invrot = 4294967296 - $rot;
  99.     my $ret    = (($xorshifted >> $rot) | ($xorshifted << ($invrot & 31))) & 0xFFFFFFFF;
  100.  
  101.     if (defined($debug) && $debug > 0) {
  102.         # $oldstate is the state at the start of the function and $inc
  103.         # doesn't change so we can print out the initial values here
  104.         print color('orange', "State : " . ($oldstate | 0) . "/" . ($seeds->[1] | 0) . "\n");
  105.         print color('orange', "State2: " . ($seeds->[0] | 0) . "\n");
  106.         print color('orange', "Xor   : $xorshifted\n");
  107.         print color('orange', "Rot   : $rot\n");
  108.     }
  109.  
  110.     return $ret;
  111. }
  112.  
  113. # Based on the C algorithm: https://chatgpt.com/share/693cc99c-8068-800d-858e-be16ec1d7521
  114. #my $seeds = [12, 34];
  115. #my $rand  = pcg64_perl($seeds);
  116. sub pcg64_perl {
  117.     my $seeds = $_[0];
  118.     my $ret   = (($seeds->[0] >> (($seeds->[0] >> 59) + 5)) ^ $seeds->[0]);
  119.  
  120.     use integer;
  121.     $ret *= 12605985483714917081;
  122.     $seeds->[0] = $seeds->[0] * 6364136223846793005 + $seeds->[1];
  123.     no integer;
  124.  
  125.     $ret = ($ret >> 43) ^ $ret;
  126.  
  127.     return $ret;
  128. }
  129.  
  130. # To get a 64bit number from PCG32 you create two different generators
  131. # and combine the results into a single 64bit value. All the examples
  132. # online show 1 for the inc/seed2 value. I'm not sure why that is, but
  133. # I copied it for my implementation.
  134. #
  135. #my $seeds = [[12, 1], [34,1]];
  136. #my $rand  = pcg64_perl($seeds);
  137. sub pcg64_perl_chained {
  138.     my ($seeds) = @_;
  139.  
  140.     # Get two 32bit ints
  141.     my $high = pcg32_perl($seeds->[0]);
  142.     my $low  = pcg32_perl($seeds->[1]);
  143.  
  144.     # Combine the two 32bits into one 64bit int
  145.     my $ret = ($high << 32) | $low;
  146.  
  147.     return $ret;
  148. }
  149.  
  150. #my $seeds = [uint64(12), uint64(34)];
  151. #my $rand  = pcg32_math64($seeds);
  152. sub pcg32_math64 {
  153.     # state/inc are passed in by reference
  154.     my ($s) = @_;
  155.  
  156.     my $oldstate = $s->[0];
  157.     $s->[0]      = $oldstate * 6364136223846793005 + ($s->[1] | 1);
  158.  
  159.     my $xorshifted = (($oldstate >> 18) ^ $oldstate) >> 27;
  160.     $xorshifted    = $xorshifted & 0xFFFFFFFF; # Convert to uint32_t
  161.  
  162.     my $rot    = $oldstate >> 59;
  163.     my $invrot = 4294967296 - $rot;
  164.  
  165.     my $ret = ($xorshifted >> $rot) | ($xorshifted << ($invrot & 31));
  166.     $ret    = $ret & 0xFFFFFFFF; # Convert to uint32_t
  167.  
  168.     $ret = uint64_to_number($ret);
  169.  
  170.     if ($debug) {
  171.         # $oldstate is the state at the start of the function and $inc
  172.         # doesn't change so we can print out the initial values here
  173.         print color('orange', "State : $oldstate/$s->[1]\n");
  174.         print color('orange', "State2: $s->[0]\n");
  175.         print color('orange', "Xor   : $xorshifted\n");
  176.         print color('orange', "Rot   : $rot\n");
  177.     }
  178.  
  179.     return $ret;
  180. }
  181.  
  182. ###############################################################################
  183. ###############################################################################
  184.  
  185. # String format: '115', '165_bold', '10_on_140', 'reset', 'on_173', 'red', 'white_on_blue'
  186. sub color {
  187.     my ($str, $txt) = @_;
  188.  
  189.     # If we're NOT connected to a an interactive terminal don't do color
  190.     if (-t STDOUT == 0) { return $txt || ""; }
  191.  
  192.     # No string sent in, so we just reset
  193.     if (!length($str) || $str eq 'reset') { return "\e[0m"; }
  194.  
  195.     # Some predefined colors
  196.     my %color_map = qw(red 160 blue 27 green 34 yellow 226 orange 214 purple 93 white 15 black 0);
  197.     $str =~ s|([A-Za-z]+)|$color_map{$1} // $1|eg;
  198.  
  199.     # Get foreground/background and any commands
  200.     my ($fc,$cmd) = $str =~ /^(\d{1,3})?_?(\w+)?$/g;
  201.     my ($bc)      = $str =~ /on_(\d{1,3})$/g;
  202.  
  203.     if (defined($fc) && int($fc) > 255) { $fc = undef; } # above 255 is invalid
  204.  
  205.     # Some predefined commands
  206.     my %cmd_map = qw(bold 1 italic 3 underline 4 blink 5 inverse 7);
  207.     my $cmd_num = $cmd_map{$cmd // 0};
  208.  
  209.     my $ret = '';
  210.     if ($cmd_num)      { $ret .= "\e[${cmd_num}m"; }
  211.     if (defined($fc))  { $ret .= "\e[38;5;${fc}m"; }
  212.     if (defined($bc))  { $ret .= "\e[48;5;${bc}m"; }
  213.     if (defined($txt)) { $ret .= $txt . "\e[0m";   }
  214.  
  215.     return $ret;
  216. }
  217.  
  218. sub randomize_seeds {
  219.     print color(51, "Using random seeds\n");
  220.  
  221.     $s1 = perl_rand64();
  222.     $s2 = perl_rand64();
  223. }
  224.  
  225. sub perl_rand64 {
  226.     my $low  = int(rand() * (2**32-1));
  227.     my $high = int(rand() * (2**32-1));
  228.  
  229.     my $ret = ($high << 32) | $low;
  230.  
  231.     return $ret;
  232. }
  233.  
  234. # Creates methods k() and kd() to print, and print & die respectively
  235. BEGIN {
  236.     if (eval { require Data::Dump::Color }) {
  237.         *k = sub { Data::Dump::Color::dd(@_) };
  238.     } else {
  239.         require Data::Dumper;
  240.         *k = sub { print Data::Dumper::Dumper(\@_) };
  241.     }
  242.  
  243.     sub kd {
  244.         k(@_);
  245.  
  246.         printf("Died at %2\$s line #%3\$s\n",caller());
  247.         exit(15);
  248.     }
  249. }
  250.  
  251. # Run a test with a given seed and return a string of the results
  252. sub quick_test32 {
  253.     my $seed = $_[0];
  254.  
  255.     my @data = ();
  256.     for (my $i = 0; $i < 4; $i++) {
  257.         my $num = pcg32_perl($seed);
  258.         push(@data, $num);
  259.     }
  260.  
  261.     my $ret = join(", ", @data);
  262.     return $ret;
  263. }
  264.  
  265. sub quick_test64 {
  266.     my ($seed) = @_;
  267.  
  268.     my @data = ();
  269.     for (my $i = 0; $i < 4; $i++) {
  270.         my $num = pcg64_perl($seed);
  271.         push(@data, $num);
  272.     }
  273.  
  274.     my $ret = join(", ", @data);
  275.     return $ret;
  276. }
  277.  
  278. sub run_unit_tests {
  279.     # Seeds < 2**32
  280.     cmp_ok(quick_test32([11   , 22])      , 'eq', '0, 1425092920, 3656087653, 1104107026');
  281.     cmp_ok(quick_test32([33   , 44])      , 'eq', '0, 3850707138, 2930351490, 1110209703');
  282.     cmp_ok(quick_test32([55   , 66])      , 'eq', '0, 1725101930, 224698313, 2870828486');
  283.     cmp_ok(quick_test32([12345, 67890])   , 'eq', '0, 8251198, 44679150, 3046830521');
  284.     cmp_ok(quick_test32([9999 , 9999])    , 'eq', '0, 521292032, 3698775557, 199399470');
  285.  
  286.     cmp_ok(quick_test64([[11   , 1], [22   , 1]]), 'eq', '0, 6120727489207695446, 7904312005358798897, 14733674221366828425');
  287.     cmp_ok(quick_test64([[33   , 1], [44   , 1]]), 'eq', '0, 16538661225628040268, 5269891931295187491, 5495286771333204711');
  288.     cmp_ok(quick_test64([[55   , 1], [66   , 1]]), 'eq', '0, 7409256372025208996, 8212781881022671801, 8831782971077082788');
  289.     cmp_ok(quick_test64([[12345, 1], [67890, 1]]), 'eq', '0, 35438628484449140, 42862460907032573, 519456495312580246');
  290.     cmp_ok(quick_test64([[9999 , 1], [9999 , 1]]), 'eq', '0, 2238932229626677504, 14236525402126437484, 10387246122801752400');
  291.  
  292.     # Seeds > 2**32
  293.     cmp_ok(quick_test32([42862460907032573  , 519456495312580246])  , 'eq', '319349001, 562730850, 2229409754, 561058538');
  294.     cmp_ok(quick_test32([6120727489207695446, 7904312005358798897]) , 'eq', '635930912, 2099303707, 1638577555, 1426136496');
  295.     cmp_ok(quick_test32([4841811808465514507, 7141191103728083377]) , 'eq', '1986408540, 4264878569, 3066617590, 731859269');
  296.  
  297.     cmp_ok(quick_test64([[42862460907032573  , 1], [519456495312580246 , 1]]) , 'eq', '1371593519175525487, 17623029558467823369, 17850014000156247978, 768534907509427587');
  298.     cmp_ok(quick_test64([[6120727489207695446, 1], [7904312005358798897, 1]]) , 'eq', '2731302471965979098, 3465889473135782122, 4841811808465514507, 7141191103728083377');
  299.     cmp_ok(quick_test64([[4841811808465514507, 1], [7141191103728083377, 1]]) , 'eq', '8531559717926221063, 6031125200978744796, 3704366926003160989, 5594521440717127703');
  300.  
  301.     done_testing();
  302.     exit(0);
  303. }
  304.  
  305. # vim: tabstop=4 shiftwidth=4 noexpandtab autoindent softtabstop=4