File: RNG.pm.2.0

package info (click to toggle)
libmath-gsl-perl 0.45-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 192,156 kB
  • sloc: ansic: 895,524; perl: 24,682; makefile: 12
file content (982 lines) | stat: -rw-r--r-- 37,475 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
# This file was automatically generated by SWIG (https://www.swig.org).
# Version 4.2.0
#
# Do not make changes to this file unless you know what you are doing - modify
# the SWIG interface file instead.

package Math::GSL::RNG;
use base qw(Exporter);
use base qw(DynaLoader);
package Math::GSL::RNGc;
bootstrap Math::GSL::RNG;
package Math::GSL::RNG;
@EXPORT = qw();

# ---------- BASE METHODS -------------

package Math::GSL::RNG;

sub TIEHASH {
    my ($classname,$obj) = @_;
    return bless $obj, $classname;
}

sub CLEAR { }

sub FIRSTKEY { }

sub NEXTKEY { }

sub FETCH {
    my ($self,$field) = @_;
    my $member_func = "swig_${field}_get";
    $self->$member_func();
}

sub STORE {
    my ($self,$field,$newval) = @_;
    my $member_func = "swig_${field}_set";
    $self->$member_func($newval);
}

sub this {
    my $ptr = shift;
    return tied(%$ptr);
}


# ------- FUNCTION WRAPPERS --------

package Math::GSL::RNG;

*gsl_error = *Math::GSL::RNGc::gsl_error;
*gsl_stream_printf = *Math::GSL::RNGc::gsl_stream_printf;
*gsl_strerror = *Math::GSL::RNGc::gsl_strerror;
*gsl_set_error_handler = *Math::GSL::RNGc::gsl_set_error_handler;
*gsl_set_error_handler_off = *Math::GSL::RNGc::gsl_set_error_handler_off;
*gsl_set_stream_handler = *Math::GSL::RNGc::gsl_set_stream_handler;
*gsl_set_stream = *Math::GSL::RNGc::gsl_set_stream;
*gsl_rng_types_setup = *Math::GSL::RNGc::gsl_rng_types_setup;
*gsl_rng_alloc = *Math::GSL::RNGc::gsl_rng_alloc;
*gsl_rng_memcpy = *Math::GSL::RNGc::gsl_rng_memcpy;
*gsl_rng_clone = *Math::GSL::RNGc::gsl_rng_clone;
*gsl_rng_free = *Math::GSL::RNGc::gsl_rng_free;
*gsl_rng_set = *Math::GSL::RNGc::gsl_rng_set;
*gsl_rng_max = *Math::GSL::RNGc::gsl_rng_max;
*gsl_rng_min = *Math::GSL::RNGc::gsl_rng_min;
*gsl_rng_name = *Math::GSL::RNGc::gsl_rng_name;
*gsl_rng_fread = *Math::GSL::RNGc::gsl_rng_fread;
*gsl_rng_fwrite = *Math::GSL::RNGc::gsl_rng_fwrite;
*gsl_rng_size = *Math::GSL::RNGc::gsl_rng_size;
*gsl_rng_state = *Math::GSL::RNGc::gsl_rng_state;
*gsl_rng_print_state = *Math::GSL::RNGc::gsl_rng_print_state;
*gsl_rng_env_setup = *Math::GSL::RNGc::gsl_rng_env_setup;
*gsl_rng_get = *Math::GSL::RNGc::gsl_rng_get;
*gsl_rng_uniform = *Math::GSL::RNGc::gsl_rng_uniform;
*gsl_rng_uniform_pos = *Math::GSL::RNGc::gsl_rng_uniform_pos;
*gsl_rng_uniform_int = *Math::GSL::RNGc::gsl_rng_uniform_int;

############# Class : Math::GSL::RNG::gsl_rng_type ##############

package Math::GSL::RNG::gsl_rng_type;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::RNG );
%OWNER = ();
%ITERATORS = ();
*swig_name_get = *Math::GSL::RNGc::gsl_rng_type_name_get;
*swig_name_set = *Math::GSL::RNGc::gsl_rng_type_name_set;
*swig_max_get = *Math::GSL::RNGc::gsl_rng_type_max_get;
*swig_max_set = *Math::GSL::RNGc::gsl_rng_type_max_set;
*swig_min_get = *Math::GSL::RNGc::gsl_rng_type_min_get;
*swig_min_set = *Math::GSL::RNGc::gsl_rng_type_min_set;
*swig_size_get = *Math::GSL::RNGc::gsl_rng_type_size_get;
*swig_size_set = *Math::GSL::RNGc::gsl_rng_type_size_set;
*swig_set_get = *Math::GSL::RNGc::gsl_rng_type_set_get;
*swig_set_set = *Math::GSL::RNGc::gsl_rng_type_set_set;
*swig_get_get = *Math::GSL::RNGc::gsl_rng_type_get_get;
*swig_get_set = *Math::GSL::RNGc::gsl_rng_type_get_set;
*swig_get_double_get = *Math::GSL::RNGc::gsl_rng_type_get_double_get;
*swig_get_double_set = *Math::GSL::RNGc::gsl_rng_type_get_double_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::RNGc::new_gsl_rng_type(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::RNGc::delete_gsl_rng_type($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


############# Class : Math::GSL::RNG::gsl_rng ##############

package Math::GSL::RNG::gsl_rng;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::RNG );
%OWNER = ();
%ITERATORS = ();
*swig_type_get = *Math::GSL::RNGc::gsl_rng_type_get;
*swig_type_set = *Math::GSL::RNGc::gsl_rng_type_set;
*swig_state_get = *Math::GSL::RNGc::gsl_rng_state_get;
*swig_state_set = *Math::GSL::RNGc::gsl_rng_state_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::RNGc::new_gsl_rng(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::RNGc::delete_gsl_rng($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


# ------- VARIABLE STUBS --------

package Math::GSL::RNG;

*GSL_VERSION = *Math::GSL::RNGc::GSL_VERSION;
*GSL_MAJOR_VERSION = *Math::GSL::RNGc::GSL_MAJOR_VERSION;
*GSL_MINOR_VERSION = *Math::GSL::RNGc::GSL_MINOR_VERSION;
*GSL_POSZERO = *Math::GSL::RNGc::GSL_POSZERO;
*GSL_NEGZERO = *Math::GSL::RNGc::GSL_NEGZERO;
*GSL_SUCCESS = *Math::GSL::RNGc::GSL_SUCCESS;
*GSL_FAILURE = *Math::GSL::RNGc::GSL_FAILURE;
*GSL_CONTINUE = *Math::GSL::RNGc::GSL_CONTINUE;
*GSL_EDOM = *Math::GSL::RNGc::GSL_EDOM;
*GSL_ERANGE = *Math::GSL::RNGc::GSL_ERANGE;
*GSL_EFAULT = *Math::GSL::RNGc::GSL_EFAULT;
*GSL_EINVAL = *Math::GSL::RNGc::GSL_EINVAL;
*GSL_EFAILED = *Math::GSL::RNGc::GSL_EFAILED;
*GSL_EFACTOR = *Math::GSL::RNGc::GSL_EFACTOR;
*GSL_ESANITY = *Math::GSL::RNGc::GSL_ESANITY;
*GSL_ENOMEM = *Math::GSL::RNGc::GSL_ENOMEM;
*GSL_EBADFUNC = *Math::GSL::RNGc::GSL_EBADFUNC;
*GSL_ERUNAWAY = *Math::GSL::RNGc::GSL_ERUNAWAY;
*GSL_EMAXITER = *Math::GSL::RNGc::GSL_EMAXITER;
*GSL_EZERODIV = *Math::GSL::RNGc::GSL_EZERODIV;
*GSL_EBADTOL = *Math::GSL::RNGc::GSL_EBADTOL;
*GSL_ETOL = *Math::GSL::RNGc::GSL_ETOL;
*GSL_EUNDRFLW = *Math::GSL::RNGc::GSL_EUNDRFLW;
*GSL_EOVRFLW = *Math::GSL::RNGc::GSL_EOVRFLW;
*GSL_ELOSS = *Math::GSL::RNGc::GSL_ELOSS;
*GSL_EROUND = *Math::GSL::RNGc::GSL_EROUND;
*GSL_EBADLEN = *Math::GSL::RNGc::GSL_EBADLEN;
*GSL_ENOTSQR = *Math::GSL::RNGc::GSL_ENOTSQR;
*GSL_ESING = *Math::GSL::RNGc::GSL_ESING;
*GSL_EDIVERGE = *Math::GSL::RNGc::GSL_EDIVERGE;
*GSL_EUNSUP = *Math::GSL::RNGc::GSL_EUNSUP;
*GSL_EUNIMPL = *Math::GSL::RNGc::GSL_EUNIMPL;
*GSL_ECACHE = *Math::GSL::RNGc::GSL_ECACHE;
*GSL_ETABLE = *Math::GSL::RNGc::GSL_ETABLE;
*GSL_ENOPROG = *Math::GSL::RNGc::GSL_ENOPROG;
*GSL_ENOPROGJ = *Math::GSL::RNGc::GSL_ENOPROGJ;
*GSL_ETOLF = *Math::GSL::RNGc::GSL_ETOLF;
*GSL_ETOLX = *Math::GSL::RNGc::GSL_ETOLX;
*GSL_ETOLG = *Math::GSL::RNGc::GSL_ETOLG;
*GSL_EOF = *Math::GSL::RNGc::GSL_EOF;

my %__gsl_rng_borosh13_hash;
tie %__gsl_rng_borosh13_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_borosh13;
$gsl_rng_borosh13= \%__gsl_rng_borosh13_hash;
bless $gsl_rng_borosh13, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_coveyou_hash;
tie %__gsl_rng_coveyou_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_coveyou;
$gsl_rng_coveyou= \%__gsl_rng_coveyou_hash;
bless $gsl_rng_coveyou, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_cmrg_hash;
tie %__gsl_rng_cmrg_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_cmrg;
$gsl_rng_cmrg= \%__gsl_rng_cmrg_hash;
bless $gsl_rng_cmrg, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_fishman18_hash;
tie %__gsl_rng_fishman18_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_fishman18;
$gsl_rng_fishman18= \%__gsl_rng_fishman18_hash;
bless $gsl_rng_fishman18, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_fishman20_hash;
tie %__gsl_rng_fishman20_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_fishman20;
$gsl_rng_fishman20= \%__gsl_rng_fishman20_hash;
bless $gsl_rng_fishman20, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_fishman2x_hash;
tie %__gsl_rng_fishman2x_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_fishman2x;
$gsl_rng_fishman2x= \%__gsl_rng_fishman2x_hash;
bless $gsl_rng_fishman2x, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_gfsr4_hash;
tie %__gsl_rng_gfsr4_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_gfsr4;
$gsl_rng_gfsr4= \%__gsl_rng_gfsr4_hash;
bless $gsl_rng_gfsr4, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_knuthran_hash;
tie %__gsl_rng_knuthran_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_knuthran;
$gsl_rng_knuthran= \%__gsl_rng_knuthran_hash;
bless $gsl_rng_knuthran, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_knuthran2_hash;
tie %__gsl_rng_knuthran2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_knuthran2;
$gsl_rng_knuthran2= \%__gsl_rng_knuthran2_hash;
bless $gsl_rng_knuthran2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_knuthran2002_hash;
tie %__gsl_rng_knuthran2002_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_knuthran2002;
$gsl_rng_knuthran2002= \%__gsl_rng_knuthran2002_hash;
bless $gsl_rng_knuthran2002, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_lecuyer21_hash;
tie %__gsl_rng_lecuyer21_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_lecuyer21;
$gsl_rng_lecuyer21= \%__gsl_rng_lecuyer21_hash;
bless $gsl_rng_lecuyer21, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_minstd_hash;
tie %__gsl_rng_minstd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_minstd;
$gsl_rng_minstd= \%__gsl_rng_minstd_hash;
bless $gsl_rng_minstd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_mrg_hash;
tie %__gsl_rng_mrg_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_mrg;
$gsl_rng_mrg= \%__gsl_rng_mrg_hash;
bless $gsl_rng_mrg, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_mt19937_hash;
tie %__gsl_rng_mt19937_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_mt19937;
$gsl_rng_mt19937= \%__gsl_rng_mt19937_hash;
bless $gsl_rng_mt19937, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_mt19937_1999_hash;
tie %__gsl_rng_mt19937_1999_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_mt19937_1999;
$gsl_rng_mt19937_1999= \%__gsl_rng_mt19937_1999_hash;
bless $gsl_rng_mt19937_1999, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_mt19937_1998_hash;
tie %__gsl_rng_mt19937_1998_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_mt19937_1998;
$gsl_rng_mt19937_1998= \%__gsl_rng_mt19937_1998_hash;
bless $gsl_rng_mt19937_1998, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_r250_hash;
tie %__gsl_rng_r250_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_r250;
$gsl_rng_r250= \%__gsl_rng_r250_hash;
bless $gsl_rng_r250, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ran0_hash;
tie %__gsl_rng_ran0_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ran0;
$gsl_rng_ran0= \%__gsl_rng_ran0_hash;
bless $gsl_rng_ran0, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ran1_hash;
tie %__gsl_rng_ran1_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ran1;
$gsl_rng_ran1= \%__gsl_rng_ran1_hash;
bless $gsl_rng_ran1, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ran2_hash;
tie %__gsl_rng_ran2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ran2;
$gsl_rng_ran2= \%__gsl_rng_ran2_hash;
bless $gsl_rng_ran2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ran3_hash;
tie %__gsl_rng_ran3_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ran3;
$gsl_rng_ran3= \%__gsl_rng_ran3_hash;
bless $gsl_rng_ran3, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_rand_hash;
tie %__gsl_rng_rand_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_rand;
$gsl_rng_rand= \%__gsl_rng_rand_hash;
bless $gsl_rng_rand, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_rand48_hash;
tie %__gsl_rng_rand48_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_rand48;
$gsl_rng_rand48= \%__gsl_rng_rand48_hash;
bless $gsl_rng_rand48, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random128_bsd_hash;
tie %__gsl_rng_random128_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random128_bsd;
$gsl_rng_random128_bsd= \%__gsl_rng_random128_bsd_hash;
bless $gsl_rng_random128_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random128_glibc2_hash;
tie %__gsl_rng_random128_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random128_glibc2;
$gsl_rng_random128_glibc2= \%__gsl_rng_random128_glibc2_hash;
bless $gsl_rng_random128_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random128_libc5_hash;
tie %__gsl_rng_random128_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random128_libc5;
$gsl_rng_random128_libc5= \%__gsl_rng_random128_libc5_hash;
bless $gsl_rng_random128_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random256_bsd_hash;
tie %__gsl_rng_random256_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random256_bsd;
$gsl_rng_random256_bsd= \%__gsl_rng_random256_bsd_hash;
bless $gsl_rng_random256_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random256_glibc2_hash;
tie %__gsl_rng_random256_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random256_glibc2;
$gsl_rng_random256_glibc2= \%__gsl_rng_random256_glibc2_hash;
bless $gsl_rng_random256_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random256_libc5_hash;
tie %__gsl_rng_random256_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random256_libc5;
$gsl_rng_random256_libc5= \%__gsl_rng_random256_libc5_hash;
bless $gsl_rng_random256_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random32_bsd_hash;
tie %__gsl_rng_random32_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random32_bsd;
$gsl_rng_random32_bsd= \%__gsl_rng_random32_bsd_hash;
bless $gsl_rng_random32_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random32_glibc2_hash;
tie %__gsl_rng_random32_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random32_glibc2;
$gsl_rng_random32_glibc2= \%__gsl_rng_random32_glibc2_hash;
bless $gsl_rng_random32_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random32_libc5_hash;
tie %__gsl_rng_random32_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random32_libc5;
$gsl_rng_random32_libc5= \%__gsl_rng_random32_libc5_hash;
bless $gsl_rng_random32_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random64_bsd_hash;
tie %__gsl_rng_random64_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random64_bsd;
$gsl_rng_random64_bsd= \%__gsl_rng_random64_bsd_hash;
bless $gsl_rng_random64_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random64_glibc2_hash;
tie %__gsl_rng_random64_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random64_glibc2;
$gsl_rng_random64_glibc2= \%__gsl_rng_random64_glibc2_hash;
bless $gsl_rng_random64_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random64_libc5_hash;
tie %__gsl_rng_random64_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random64_libc5;
$gsl_rng_random64_libc5= \%__gsl_rng_random64_libc5_hash;
bless $gsl_rng_random64_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random8_bsd_hash;
tie %__gsl_rng_random8_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random8_bsd;
$gsl_rng_random8_bsd= \%__gsl_rng_random8_bsd_hash;
bless $gsl_rng_random8_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random8_glibc2_hash;
tie %__gsl_rng_random8_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random8_glibc2;
$gsl_rng_random8_glibc2= \%__gsl_rng_random8_glibc2_hash;
bless $gsl_rng_random8_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random8_libc5_hash;
tie %__gsl_rng_random8_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random8_libc5;
$gsl_rng_random8_libc5= \%__gsl_rng_random8_libc5_hash;
bless $gsl_rng_random8_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random_bsd_hash;
tie %__gsl_rng_random_bsd_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random_bsd;
$gsl_rng_random_bsd= \%__gsl_rng_random_bsd_hash;
bless $gsl_rng_random_bsd, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random_glibc2_hash;
tie %__gsl_rng_random_glibc2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random_glibc2;
$gsl_rng_random_glibc2= \%__gsl_rng_random_glibc2_hash;
bless $gsl_rng_random_glibc2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_random_libc5_hash;
tie %__gsl_rng_random_libc5_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_random_libc5;
$gsl_rng_random_libc5= \%__gsl_rng_random_libc5_hash;
bless $gsl_rng_random_libc5, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_randu_hash;
tie %__gsl_rng_randu_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_randu;
$gsl_rng_randu= \%__gsl_rng_randu_hash;
bless $gsl_rng_randu, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranf_hash;
tie %__gsl_rng_ranf_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranf;
$gsl_rng_ranf= \%__gsl_rng_ranf_hash;
bless $gsl_rng_ranf, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlux_hash;
tie %__gsl_rng_ranlux_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlux;
$gsl_rng_ranlux= \%__gsl_rng_ranlux_hash;
bless $gsl_rng_ranlux, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlux389_hash;
tie %__gsl_rng_ranlux389_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlux389;
$gsl_rng_ranlux389= \%__gsl_rng_ranlux389_hash;
bless $gsl_rng_ranlux389, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlxd1_hash;
tie %__gsl_rng_ranlxd1_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlxd1;
$gsl_rng_ranlxd1= \%__gsl_rng_ranlxd1_hash;
bless $gsl_rng_ranlxd1, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlxd2_hash;
tie %__gsl_rng_ranlxd2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlxd2;
$gsl_rng_ranlxd2= \%__gsl_rng_ranlxd2_hash;
bless $gsl_rng_ranlxd2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlxs0_hash;
tie %__gsl_rng_ranlxs0_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlxs0;
$gsl_rng_ranlxs0= \%__gsl_rng_ranlxs0_hash;
bless $gsl_rng_ranlxs0, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlxs1_hash;
tie %__gsl_rng_ranlxs1_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlxs1;
$gsl_rng_ranlxs1= \%__gsl_rng_ranlxs1_hash;
bless $gsl_rng_ranlxs1, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranlxs2_hash;
tie %__gsl_rng_ranlxs2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranlxs2;
$gsl_rng_ranlxs2= \%__gsl_rng_ranlxs2_hash;
bless $gsl_rng_ranlxs2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_ranmar_hash;
tie %__gsl_rng_ranmar_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_ranmar;
$gsl_rng_ranmar= \%__gsl_rng_ranmar_hash;
bless $gsl_rng_ranmar, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_slatec_hash;
tie %__gsl_rng_slatec_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_slatec;
$gsl_rng_slatec= \%__gsl_rng_slatec_hash;
bless $gsl_rng_slatec, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_taus_hash;
tie %__gsl_rng_taus_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_taus;
$gsl_rng_taus= \%__gsl_rng_taus_hash;
bless $gsl_rng_taus, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_taus2_hash;
tie %__gsl_rng_taus2_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_taus2;
$gsl_rng_taus2= \%__gsl_rng_taus2_hash;
bless $gsl_rng_taus2, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_taus113_hash;
tie %__gsl_rng_taus113_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_taus113;
$gsl_rng_taus113= \%__gsl_rng_taus113_hash;
bless $gsl_rng_taus113, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_transputer_hash;
tie %__gsl_rng_transputer_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_transputer;
$gsl_rng_transputer= \%__gsl_rng_transputer_hash;
bless $gsl_rng_transputer, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_tt800_hash;
tie %__gsl_rng_tt800_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_tt800;
$gsl_rng_tt800= \%__gsl_rng_tt800_hash;
bless $gsl_rng_tt800, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_uni_hash;
tie %__gsl_rng_uni_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_uni;
$gsl_rng_uni= \%__gsl_rng_uni_hash;
bless $gsl_rng_uni, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_uni32_hash;
tie %__gsl_rng_uni32_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_uni32;
$gsl_rng_uni32= \%__gsl_rng_uni32_hash;
bless $gsl_rng_uni32, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_vax_hash;
tie %__gsl_rng_vax_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_vax;
$gsl_rng_vax= \%__gsl_rng_vax_hash;
bless $gsl_rng_vax, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_waterman14_hash;
tie %__gsl_rng_waterman14_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_waterman14;
$gsl_rng_waterman14= \%__gsl_rng_waterman14_hash;
bless $gsl_rng_waterman14, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_zuf_hash;
tie %__gsl_rng_zuf_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_zuf;
$gsl_rng_zuf= \%__gsl_rng_zuf_hash;
bless $gsl_rng_zuf, Math::GSL::RNG::gsl_rng_type;

my %__gsl_rng_default_hash;
tie %__gsl_rng_default_hash,"Math::GSL::RNG::gsl_rng_type", $Math::GSL::RNGc::gsl_rng_default;
$gsl_rng_default= \%__gsl_rng_default_hash;
bless $gsl_rng_default, Math::GSL::RNG::gsl_rng_type;
*gsl_rng_default_seed = *Math::GSL::RNGc::gsl_rng_default_seed;


use Carp;

@EXPORT_OK = qw/
                 gsl_rng_alloc gsl_rng_set gsl_rng_get gsl_rng_free gsl_rng_memcpy
                 gsl_rng_fwrite gsl_rng_fread gsl_rng_clone gsl_rng_max gsl_rng_min
                 gsl_rng_name gsl_rng_size gsl_rng_state gsl_rng_print_state gsl_rng_uniform gsl_rng_uniform_pos gsl_rng_uniform_int
                $gsl_rng_default $gsl_rng_knuthran $gsl_rng_ran0 $gsl_rng_borosh13
                $gsl_rng_coveyou $gsl_rng_cmrg $gsl_rng_fishman18 $gsl_rng_fishman20 $gsl_rng_fishman2x
                $gsl_rng_gfsr4 $gsl_rng_knuthran $gsl_rng_knuthran2 $gsl_rng_knuthran2002 $gsl_rng_lecuyer21
                $gsl_rng_minstd $gsl_rng_mrg $gsl_rng_mt19937 $gsl_rng_mt19937_1999 $gsl_rng_mt19937_1998
                $gsl_rng_r250 $gsl_rng_ran0 $gsl_rng_ran1 $gsl_rng_ran2 $gsl_rng_ran3
                $gsl_rng_rand $gsl_rng_rand48 $gsl_rng_random128_bsd $gsl_rng_random128_gli $gsl_rng_random128_lib
                $gsl_rng_random256_bsd $gsl_rng_random256_gli $gsl_rng_random256_lib $gsl_rng_random32_bsd
                $gsl_rng_random32_glib $gsl_rng_random32_libc $gsl_rng_random64_bsd $gsl_rng_random64_glib
                $gsl_rng_random64_libc $gsl_rng_random8_bsd $gsl_rng_random8_glibc $gsl_rng_random8_libc5
                $gsl_rng_random_bsd $gsl_rng_random_glibc2 $gsl_rng_random_libc5 $gsl_rng_randu
                $gsl_rng_ranf $gsl_rng_ranlux $gsl_rng_ranlux389 $gsl_rng_ranlxd1 $gsl_rng_ranlxd2 $gsl_rng_ranlxs0
                $gsl_rng_ranlxs1 $gsl_rng_ranlxs2 $gsl_rng_ranmar $gsl_rng_slatec $gsl_rng_taus $gsl_rng_taus2
                $gsl_rng_taus113 $gsl_rng_transputer $gsl_rng_tt800 $gsl_rng_uni $gsl_rng_uni32 $gsl_rng_vax
                $gsl_rng_waterman14 $gsl_rng_zuf
              /;
%EXPORT_TAGS = ( all => [ @EXPORT_OK ] );

=encoding utf8

=head1 NAME

Math::GSL::RNG - Random Number Generators

=head1 SYNOPSIS

    use Math::GSL::RNG;
    my $rng     = Math::GSL::RNG->new;
    my @random  = $rng->get(100);

=head1 Object Oriented Interface

=head2 Math::GSL::RNG->new($type, $seed)

    my $rng = Math::GSL::RNG->new;
    my $rng = Math::GSL::RNG->new($gsl_rng_knuthran,5);

Creates a new RNG object of type $type, seeded with $seed. Both of these
parameters are optional. The type $gsl_rng_default is used when no $type
is given.

=cut

sub new {
    my ($class, $type, $seed) = @_;
    $type ||= $gsl_rng_default;
    $seed ||= int 100*rand;

    my $self = {};
    my $rng  = gsl_rng_alloc($type);
    gsl_rng_set($rng, $seed);

    $self->{_rng} = $rng;
    bless $self, $class;
}

=head2 copy()

    my $copy = $rng->copy;

Make a copy of a RNG object.

=cut

sub copy {
    my ($self)    = @_;
    my $copy      = Math::GSL::RNG->new;
    $copy->{_rng} = gsl_rng_clone($self->{_rng});

    return $copy;
}

=head2 free()

    $rng->free();

Free memory associated with RNG object.

=cut

sub free {
    my ($self)    = @_;
    gsl_rng_free($self->{_rng});
}

=head2 name()

   my $name = $rng->name();

Get the name of the RNG object as a string.

=cut

sub name {
    my ($self)    = @_;
    gsl_rng_name($self->{_rng});
}

=head2 get()

    my $nextval  = $rng->get;
    my (@values) = $rng->get(100);

Get the next random value from the RNG object. If given an integer N, returns the next N values.

=cut

sub get {
    my ($self, $num_values) = @_;
    $num_values ||= 1;

    return map { gsl_rng_get($self->{_rng}) } (1 .. $num_values);
}

=head2 raw()

    my $raw = $rng->raw();

Return the raw GSL RNG object, useful for functions which take a RNG,
such as the Monte Carlo integration functions or the random number
distribution functions in Math::GSL::Randist.

=cut

sub raw {
    my $self = shift;
    return $self->{_rng};
}

=head2 shuffle()

   my @array = $rng->shuffle(@other_array);

Given a RNG, shuffle an array.

=cut

sub shuffle {
    my ($self, @array) = @_;

    my $nr_elements = $#array;
    my $output = Math::GSL::Randist::our_gsl_ran_shuffle($self->raw,
                                                         [0..$nr_elements],
                                                         $nr_elements + 1);
    return map { $array[$_] } @$output;
}

=head2 choose()

   my @array = $rng->choose(4, @other_array);

This function fills the destination array with k objects taken
randomly from the n elements of the array argument.  The objects are
sampled without replacement, thus each object can only appear once in
destination array. It is required that k be less than or equal to n.

=cut

sub choose {
    my ($self, $k, @array) = @_;

    my $nr_elements = $#array;
    croak __PACKAGE__, "- choose method called with k greater than number of elements in the array"
      if $k > $nr_elements + 1;

    my $output = Math::GSL::Randist::our_gsl_ran_choose($self->raw, $k,
                                                        [0..$nr_elements],
                                                        $nr_elements + 1);
    return map { $array[$_] } @$output;
}


=head2 sample()

   my @array = $rng->sample(4, @other_array);

This method is like C<choose> but samples k items from the original
array of n items src with replacement, so the same object can appear
more than once in the output sequence dest. There is no requirement
that k be less than n in this case.

=cut

sub sample {
    my ($self, $k, @array) = @_;

    my $nr_elements = $#array;

    my $output = Math::GSL::Randist::our_gsl_ran_sample($self->raw, $k,
                                                        [0..$nr_elements],
                                                        $nr_elements + 1);
    return map { $array[$_] } @$output;
}


__END__


=head1 GSL API Interface

=over 1

=item gsl_rng_alloc($T) - This function returns a pointer to a newly-created instance of a random number generator of type $T. $T must be one of the constants below. The generator is automatically initialized with the default seed, $gsl_rng_default.

=item gsl_rng_set($r, $s) - This function initializes (or `seeds') the random number generator. If the generator is seeded with the same value of $s on two different runs, the same stream of random numbers will be generated by successive calls to the routines below. If different values of $s are supplied, then the generated streams of random numbers should be completely different. If the seed $s is zero then the standard seed from the original implementation is used instead. For example, the original Fortran source code for the ranlux generator used a seed of 314159265, and so choosing $s equal to zero reproduces this when using $gsl_rng_ranlux.

=item gsl_rng_get($r) - This function returns a random integer from the generator $r. The minimum and maximum values depend on the algorithm used, but all integers in the range [min,max] are equally likely. The values of min and max can determined using the auxiliary functions gsl_rng_max($r) and gsl_rng_min($r).

=item gsl_rng_free($r) - This function frees all the memory associated with the generator $r.

=item gsl_rng_memcpy($dest, $src) - This function copies the random number generator $src into the pre-existing generator $dest, making $dest into an exact copy of $src. The two generators must be of the same type.

=item gsl_rng_uniform($r) - This function returns a double precision floating point number uniformly distributed in the range [0,1). The range includes 0.0 but excludes 1.0. The value is typically obtained by dividing the result of gsl_rng_get($r) by gsl_rng_max($r) + 1.0 in double precision. Some generators compute this ratio internally so that they can provide floating point numbers with more than 32 bits of randomness (the maximum number of bits that can be portably represented in a single unsigned long int).

=item gsl_rng_uniform_pos($r) - This function returns a positive double precision floating point number uniformly distributed in the range (0,1), excluding both 0.0 and 1.0. The number is obtained by sampling the generator with the algorithm of gsl_rng_uniform until a non-zero value is obtained. You can use this function if you need to avoid a singularity at 0.0.

=item gsl_rng_uniform_int($r, $n) - This function returns a random integer from 0 to $n-1 inclusive by scaling down and/or discarding samples from the generator $r. All integers in the range [0,$n-1] are produced with equal probability. For generators with a non-zero minimum value an offset is applied so that zero is returned with the correct probability. Note that this function is designed for sampling from ranges smaller than the range of the underlying generator. The parameter $n must be less than or equal to the range of the generator $r. If $n is larger than the range of the generator then the function calls the error handler with an error code of $GSL_EINVAL and returns zero. In particular, this function is not intended for generating the full range of unsigned integer values [0,2^32-1]. Instead choose a generator with the maximal integer range and zero minimum value, such as $gsl_rng_ranlxd1, $gsl_rng_mt19937 or $gsl_rng_taus, and sample it directly using gsl_rng_get. The range of each generator can be found using the auxiliary functions described in the next section.

=item gsl_rng_fwrite($stream, $r) - This function writes the random number state of the random number generator $r to the stream $stream (opened with the gsl_fopen function from the Math::GSL module) in binary format. The return value is 0 for success and $GSL_EFAILED if there was a problem writing to the file. Since the data is written in the native binary format it may not be portable between different architectures.

=item gsl_rng_fread($stream, $r) - This function reads the random number state into the random number generator $r from the open stream $stream (opened with the gsl_fopen function from the Math::GSL module) in binary format. The random number generator $r must be preinitialized with the correct random number generator type since type information is not saved. The return value is 0 for success and $GSL_EFAILED if there was a problem reading from the file. The data is assumed to have been written in the native binary format on the same architecture.

=item gsl_rng_clone($r) - This function returns a pointer to a newly created generator which is an exact copy of the generator $r.

=item gsl_rng_max($r) - This function returns the largest value that gsl_rng_get can return.

=item gsl_rng_min($r) - gsl_rng_min returns the smallest value that gsl_rng_get can return. Usually this value is zero. There are some generators with algorithms that cannot return zero, and for these generators the minimum value is 1.

=item gsl_rng_name($r) - This function returns a pointer to the name of the generator. For example,

=over

=item print "r is a " . gsl_rng_name($r) . "generator\n";

=item would print something like r is a 'taus' generator.

=back

=item gsl_rng_size($r) - This function returns the size of the state of generator $r. You can use this information to access the state directly.

=item gsl_rng_state($r) - This function returns a pointer to the state of generator $r. You can use this information to access the state directly.

=item gsl_rng_print_state($r)

=back

=head1 Random Number Generator Types

=over 1

=item $gsl_rng_default

=item $gsl_rng_knuthran

=item $gsl_rng_ran0

=item $gsl_rng_borosh13

=item $gsl_rng_coveyou

=item $gsl_rng_cmrg

=item $gsl_rng_fishman18

=item $gsl_rng_fishman20

=item $gsl_rng_fishman2x - This is the L'Ecuyer-Fishman random number generator. It is taken from Knuth's Seminumerical Algorithms, 3rd Ed., page 108. Its sequence is, z_{n+1} = (x_n - y_n) mod m with m = 2^31 - 1. x_n and y_n are given by the fishman20 and lecuyer21 algorithms. The seed specifies the initial value, x_1.

=item $gsl_rng_gfsr4

=item $gsl_rng_knuthran

=item $gsl_rng_knuthran2

=item $gsl_rng_knuthran2002

=item $gsl_rng_lecuyer21

=item $gsl_rng_minstd

=item $gsl_rng_mrg

=item $gsl_rng_mt19937

=item $gsl_rng_mt19937_1999

=item $gsl_rng_mt19937_1998

=item $gsl_rng_r250

=item $gsl_rng_ran0

=item $gsl_rng_ran1

=item $gsl_rng_ran2

=item $gsl_rng_ran3

=item $gsl_rng_rand - This is the BSD rand generator. Its sequence is x_{n+1} = (a x_n + c) mod m with a = 1103515245, c = 12345 and m = 2^31. The seed specifies the initial value, x_1. The period of this generator is 2^31, and it uses 1 word of storage per generator.

=item $gsl_rng_rand48

=item $gsl_rng_random128_bsd

=item $gsl_rng_random128_gli

=item $gsl_rng_random128_lib

=item $gsl_rng_random256_bsd

=item $gsl_rng_random256_gli

=item $gsl_rng_random256_lib

=item $gsl_rng_random32_bsd

=item $gsl_rng_random32_glib

=item $gsl_rng_random32_libc

=item $gsl_rng_random64_bsd

=item $gsl_rng_random64_glib

=item $gsl_rng_random64_libc

=item $gsl_rng_random8_bsd

=item $gsl_rng_random8_glibc

=item $gsl_rng_random8_libc5

=item $gsl_rng_random_bsd

=item $gsl_rng_random_glibc2

=item $gsl_rng_random_libc5

=item $gsl_rng_randu

=item $gsl_rng_ranf

=item $gsl_rng_ranlux

=item $gsl_rng_ranlux389

=item $gsl_rng_ranlxd1

=item $gsl_rng_ranlxd2

=item $gsl_rng_ranlxs0

=item $gsl_rng_ranlxs1

=item $gsl_rng_ranlxs2

=item $gsl_rng_ranmar - This is the RANMAR lagged-fibonacci generator of Marsaglia, Zaman and Tsang. It is a 24-bit generator, originally designed for single-precision IEEE floating point numbers. It was included in the CERNLIB high-energy physics library.

=item $gsl_rng_slatec - This is the SLATEC random number generator RAND. It is ancient. The original source code is available from NETLIB.

=item $gsl_rng_taus

=item $gsl_rng_taus2

=item $gsl_rng_taus113

=item $gsl_rng_transputer

=item $gsl_rng_tt800

=item $gsl_rng_uni

=item $gsl_rng_uni32

=item $gsl_rng_vax - This is the VAX generator MTH$RANDOM. Its sequence is, x_{n+1} = (a x_n + c) mod m with a = 69069, c = 1 and m = 2^32. The seed specifies the initial value, x_1. The period of this generator is 2^32 and it uses 1 word of storage per generator.

=item $gsl_rng_waterman14

=item $gsl_rng_zuf - This is the ZUFALL lagged Fibonacci series generator of Peterson. Its sequence is,

=over

=item          t = u_{n-273} + u_{n-607}

=item          u_n  = t - floor(t)

=back

 The original source code is available from NETLIB. For more information see,

 * W. Petersen, “Lagged Fibonacci Random Number Generators for the NEC SX-3”, International Journal of High Speed Computing (1994).

=back

For more information on the functions, we refer you to the GSL official documentation:

L<http://www.gnu.org/software/gsl/manual/html_node/>



=head1 EXAMPLES

The following example will print out a list a random integers between certain
minimum and maximum values. The command line arguments are first the number of
random numbers wanted, the minimum and then maximum. The defaults are 10, 0 and
100, respectively.

    use Math::GSL::RNG qw/:all/;
    my $seed = int rand(100);
    my $rng  = Math::GSL::RNG->new($gsl_rng_knuthran, $seed );
    my ($num,$min,$max) = @ARGV;
    $num ||= 10;
    $min ||= 0;
    $max ||= 100;
    print join "\n", map { $min + $rng->get % ($max-$min+1)  } (1..$num);
    print "\n";

The C<$seed> argument is optional but encouraged. This program is available in
the B<examples/> directory that comes with the source of this module.

If you would like a series of random non-integer numbers, then you can generate one "scaling factor"
and multiple by that, such as

    use Math::GSL::RNG qw/:all/;
    my $scale= rand(10);
    my $seed = int rand(100);
    my $rng  = Math::GSL::RNG->new($gsl_rng_knuthran, $seed );
    my ($num,$min,$max) = (10,0,100);
    print join "\n", map { $scale*($min + $rng->get % ($max-$min+1))  } (1..$num);
    print "\n";

=head1 AUTHORS

Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2024 Jonathan "Duke" Leto and Thierry Moisan

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;