forked from OSVVM/OSVVM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRandomPkg2019.vhd
2396 lines (2178 loc) · 113 KB
/
RandomPkg2019.vhd
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
--
-- File Name : RandomPkg2019.vhd
-- Design Unit Name : RandomPkg2019
-- Revision : STANDARD VERSION
--
-- Maintainer : Jim Lewis email : [email protected]
-- Contributor(s) :
-- Jim Lewis email: [email protected]
-- Lars Asplund email: [email protected] - RandBool, RandSl, RandBit, DistBool, DistSl, DistBit
-- *
--
-- * In writing procedures normal, poisson, the following sources were referenced :
-- Wikipedia
-- package rnd2 written by John Breen and Ken Christensen
-- package RNG written by Gnanasekaran Swaminathan
--
--
-- Description :
-- RandomPType, a protected type, defined to hold randomization RandomSeeds and
-- function methods to facilitate randomization with uniform and weighted
-- distributions
--
-- Developed for :
-- SynthWorks Design Inc.
-- VHDL Training Classes
-- 11898 SW 128th Ave. Tigard, Or 97223
-- http ://www.SynthWorks.com
--
-- Revision History :
-- Date Version Description
-- 11/2024 2024.11 Added Scalar Exclude values to most (except RandIntV without unique value)
-- 09/2024 2024.09 Derived from RandomPkg
--
-- This file is part of OSVVM.
--
-- Copyright (c) 2006 - 2024 by SynthWorks Design Inc.
-- Copyright (C) 2021 - 2024 by OSVVM Authors
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- https://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
use work.OsvvmGlobalPkg.all ;
use work.AlertLogPkg.all ;
use work.RandomBasePkg.all ;
use work.SortListPkg_int.all ;
use work.OsvvmSettingsPkg.all ;
use work.OsvvmTypesPkg.all ;
use std.textio.all ;
library ieee ;
use ieee.std_logic_1164.all ;
use ieee.numeric_std.all ;
use ieee.numeric_std_unsigned.all ;
use ieee.math_real.all ;
package RandomPkg2019 is
-- Supports DistValInt functionality
type DistRecType is record
Value : integer ;
Weight : integer ;
end record ;
type DistType is array (natural range <>) of DistRecType ;
type RandomType is record
Seed : RandomSeedType ;
Param : RandomParamType ;
end record ;
-- Weight vectors not indexed by integers
type NaturalVBoolType is array (boolean range <>) of natural;
type NaturalVSlType is array (std_logic range <>) of natural;
type NaturalVBitType is array (bit range <>) of natural;
procedure InitSeed (variable RV : inout RandomType ; S : string ) ;
procedure InitSeed (variable RV : inout RandomType ; I : integer ) ;
procedure InitSeed (variable RV : inout RandomType ; T : time ) ;
procedure InitSeed (variable RV : inout RandomType ; IV : integer_vector) ;
impure function InitSeed ( S : string ) return RandomType ;
impure function InitSeed ( I : integer ) return RandomType ;
impure function InitSeed ( T : time ) return RandomType ;
impure function InitSeed ( IV : integer_vector ) return RandomType ;
alias InitSeed is GenRandSeed[string return RandomSeedType] ;
alias InitSeed is GenRandSeed[integer return RandomSeedType] ;
alias InitSeed is GenRandSeed[time return RandomSeedType] ;
alias InitSeed is GenRandSeed[integer_vector return RandomSeedType] ;
-- Save and restore seed values
impure function SetSeed (RandomSeedIn : RandomSeedType) return RandomType ;
procedure SetSeed (variable RV : inout RandomType ; RandomSeedIn : RandomSeedType ) ;
impure function GetSeed (RV : RandomType) return RandomSeedType ;
alias SeedRandom is SetSeed [RandomSeedType return RandomType] ;
alias SeedRandom is GetSeed [RandomType return RandomSeedType] ;
------------------------------------------------------------
-- Setting Randomization Parameters
------------------------------------------------------------
procedure SetRandomParam (variable RV : inout RandomType ; RandomParamIn : RandomParamType) ;
procedure SetRandomParam (
variable RV : inout RandomType ;
Distribution : RandomDistType ;
Mean : Real := 0.0 ;
Deviation : Real := 0.0
) ;
impure function GetRandomParam (variable RV : inout RandomType) return RandomParamType ;
impure function GetRandomParam (variable RV : inout RandomType) return RandomDistType ;
-- For compatibility with previous version - replace with alias
alias SetRandomParm is SetRandomParam [RandomType, RandomParamType] ;
alias SetRandomParm is SetRandomParam [RandomType, RandomDistType, Real, Real] ;
alias GetRandomParm is GetRandomParam [RandomType return RandomParamType] ;
alias GetRandomParm is GetRandomParam [RandomType return RandomDistType] ;
alias SetRandomMode is SetRandomParam [RandomType, RandomDistType, Real, Real] ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Base Randomization Distributions
---
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
--
-- Uniform
-- Generate a random number with a Uniform distribution
--
------------------------------------------------------------
impure function Uniform (variable RV : inout RandomType ; Min, Max : in real) return real ;
impure function Uniform (variable RV : inout RandomType ; Min, Max : integer) return integer ;
impure function Uniform (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer ;
------------------------------------------------------------
--
-- FavorSmall
-- Generate random numbers with a greater number of small
-- values than large values
--
------------------------------------------------------------
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : real) return real ;
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : integer) return integer ;
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer ;
------------------------------------------------------------
--
-- FavorBig
-- Generate random numbers with a greater number of large
-- values than small values
--
------------------------------------------------------------
impure function FavorBig (variable RV : inout RandomType ; Min, Max : real) return real ;
impure function FavorBig (variable RV : inout RandomType ; Min, Max : integer) return integer ;
impure function FavorBig (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer ;
-----------------------------------------------------------------
--
-- Normal
-- Generate a random number with a normal distribution
-- Uses Box Muller, per Wikipedia
--
------------------------------------------------------------
impure function Normal (variable RV : inout RandomType ; Mean, StdDeviation : real) return real ;
impure function Normal (variable RV : inout RandomType ; Mean, StdDeviation, Min, Max : real) return real ;
impure function Normal (
variable RV : inout RandomType ;
Mean : real ;
StdDeviation : real ;
Min : integer ;
Max : integer ;
Exclude : integer_vector := NULL_INTV
) return integer ;
-----------------------------------------------------------------
-- Poisson
-- Generate a random number with a poisson distribution
-- Discrete distribution = only generates integral values
-- Uses knuth method, per Wikipedia
--
------------------------------------------------------------
impure function Poisson (variable RV : inout RandomType ; Mean : real) return real ;
impure function Poisson (variable RV : inout RandomType ; Mean, Min, Max : real) return real ;
impure function Poisson (
variable RV : inout RandomType ;
Mean : real ;
Min : integer ;
Max : integer ;
Exclude : integer_vector := NULL_INTV
) return integer ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomization with range.
-- Uses internal settings of RandomParm to deterimine distribution.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandInt (variable RV : inout RandomType ; Min, Max : integer) return integer ;
impure function RandReal (variable RV : inout RandomType ; Min, Max : Real) return real ;
impure function RandTime (variable RV : inout RandomType ; Min, Max : time ; Unit : time := ns) return time ;
impure function RandSlv (variable RV : inout RandomType ; Min, Max, Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; Min, Max, Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; Min, Max : integer ; Size : natural) return Signed ;
impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandRealV (variable RV : inout RandomType ; Min, Max : real ; Size : natural) return real_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Size : natural ; Unit : time := ns) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Unique : natural ; Size : natural ; Unit : time := ns) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomization with range and exclude vector.
-- Uses internal settings of RandomParm to deterimine distribution.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandInt (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector ) return integer ;
impure function RandTime (variable RV : inout RandomType ; Min, Max : time ; Exclude : time_vector ; Unit : time := ns) return time ;
impure function RandSlv (variable RV : inout RandomType ; Min, Max : natural ; Exclude : integer_vector ; Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; Min, Max : natural ; Exclude : integer_vector ; Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector ; Size : natural) return Signed ;
impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Exclude : time_vector ; Size : natural ; Unit : in time := ns) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Exclude : time_vector ; Unique : natural ; Size : natural ; Unit : in time := ns) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomly select a value within a set of values
-- Uses internal settings of RandomParm to deterimine distribution.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandInt (variable RV : inout RandomType ; A : integer_vector ) return integer ;
impure function RandReal (variable RV : inout RandomType ; A : real_vector ) return real ;
impure function RandTime (variable RV : inout RandomType ; A : time_vector ) return time ;
impure function RandSlv (variable RV : inout RandomType ; A : integer_vector ; Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; A : integer_vector ; Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; A : integer_vector ; Size : natural) return Signed ;
impure function RandIntV (variable RV : inout RandomType ; A : integer_vector ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; A : integer_vector ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandRealV (variable RV : inout RandomType ; A : real_vector ; Size : natural) return real_vector ;
impure function RandRealV (variable RV : inout RandomType ; A : real_vector ; Unique : natural ; Size : natural) return real_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A : time_vector ; Size : natural) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A : time_vector ; Unique : natural ; Size : natural) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomly select a value within a set of values with exclude values (so can skip last or last n)
-- Uses internal settings of RandomParm to deterimine distribution.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandInt (variable RV : inout RandomType ; A, Exclude : integer_vector ) return integer ;
impure function RandReal (variable RV : inout RandomType ; A, Exclude : real_vector ) return real ;
impure function RandTime (variable RV : inout RandomType ; A, Exclude : time_vector ) return time ;
impure function RandSlv (variable RV : inout RandomType ; A, Exclude : integer_vector ; Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; A, Exclude : integer_vector ; Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; A, Exclude : integer_vector ; Size : natural ) return Signed ;
impure function RandIntV (variable RV : inout RandomType ; A, Exclude : integer_vector ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; A, Exclude : integer_vector ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandRealV (variable RV : inout RandomType ; A, Exclude : real_vector ; Size : natural) return real_vector ;
impure function RandRealV (variable RV : inout RandomType ; A, Exclude : real_vector ; Unique : natural ; Size : natural) return real_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A, Exclude : time_vector ; Size : natural) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A, Exclude : time_vector ; Unique : natural ; Size : natural) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Basic Discrete Distributions
-- Randomly select between 0 and N-1 based on the specified weight.
-- where N = number values in weight array
-- Always uses Uniform
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function DistInt (variable RV : inout RandomType ; Weight : integer_vector ) return integer ;
impure function DistSlv (variable RV : inout RandomType ; Weight : integer_vector ; Size : natural ) return std_logic_vector ;
impure function DistUnsigned (variable RV : inout RandomType ; Weight : integer_vector ; Size : natural ) return unsigned ;
impure function DistSigned (variable RV : inout RandomType ; Weight : integer_vector ; Size : natural ) return signed ;
impure function DistBool (variable RV : inout RandomType ; Weight : NaturalVBoolType ) return boolean ;
impure function DistSl (variable RV : inout RandomType ; Weight : NaturalVSlType ) return std_logic ;
impure function DistBit (variable RV : inout RandomType ; Weight : NaturalVBitType ) return bit ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Basic Distributions with exclude values (so can skip last or last n)
-- Always uses Uniform via DistInt
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function DistInt (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer_vector ) return integer ;
impure function DistSlv (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer_vector ; Size : natural ) return std_logic_vector ;
impure function DistUnsigned (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer_vector ; Size : natural ) return unsigned ;
impure function DistSigned (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer_vector ; Size : natural ) return signed ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Distribution for sparse values
-- Specify weight and value
-- Always uses Uniform via DistInt
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function DistValInt (variable RV : inout RandomType ; A : DistType ) return integer ;
impure function DistValSlv (variable RV : inout RandomType ; A : DistType ; Size : natural) return std_logic_vector ;
impure function DistValUnsigned (variable RV : inout RandomType ; A : DistType ; Size : natural) return unsigned ;
impure function DistValSigned (variable RV : inout RandomType ; A : DistType ; Size : natural) return signed ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Distribution for sparse values with exclude values (so can skip last or last n)
-- Specify weight and value
-- Always uses Uniform via DistInt
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function DistValInt (variable RV : inout RandomType ; A : DistType ; Exclude : integer_vector ) return integer ;
impure function DistValSlv (variable RV : inout RandomType ; A : DistType ; Exclude : integer_vector ; Size : natural) return std_logic_vector ;
impure function DistValUnsigned (variable RV : inout RandomType ; A : DistType ; Exclude : integer_vector ; Size : natural) return unsigned ;
impure function DistValSigned (variable RV : inout RandomType ; A : DistType ; Exclude : integer_vector ; Size : natural) return signed ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Large vector handling.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandUnsigned (variable RV : inout RandomType ; Size : natural) return unsigned ;
impure function RandUnsigned (variable RV : inout RandomType ; Size : natural ; Exclude : uv_vector) return unsigned ;
--!! impure function RandUnsigned (variable RV : inout RandomType ; Size : natural ; Exclude : unsigned) return unsigned ;
impure function RandUnsigned (variable RV : inout RandomType ; Max : Unsigned) return unsigned ;
impure function RandUnsigned (variable RV : inout RandomType ; Min, Max : unsigned) return unsigned ;
impure function RandUnsigned (variable RV : inout RandomType ; Min, Max : unsigned ; Exclude : uv_vector) return unsigned ;
--!! impure function RandUnsigned (variable RV : inout RandomType ; Min, Max : unsigned ; Exclude : unsigned) return unsigned ;
impure function RandSlv (variable RV : inout RandomType ; Size : natural) return std_logic_vector ;
impure function RandSlv (variable RV : inout RandomType ; Size : natural ; Exclude : slv_vector) return std_logic_vector ;
--!! impure function RandSlv (variable RV : inout RandomType ; Size : natural ; Exclude : std_logic_vector) return std_logic_vector ;
impure function RandSlv (variable RV : inout RandomType ; Max : std_logic_vector) return std_logic_vector ;
impure function RandSlv (variable RV : inout RandomType ; Min, Max : std_logic_vector) return std_logic_vector ;
impure function RandSlv (variable RV : inout RandomType ; Min, Max : std_logic_vector ; Exclude : slv_vector) return std_logic_vector ;
--!! impure function RandSlv (variable RV : inout RandomType ; Min, Max : std_logic_vector ; Exclude : std_logic_vector) return std_logic_vector ;
impure function RandSigned (variable RV : inout RandomType ; Size : natural) return signed ;
impure function RandSigned (variable RV : inout RandomType ; Size : natural ; Exclude : sv_vector) return signed ;
--!! impure function RandSigned (variable RV : inout RandomType ; Size : natural ; Exclude : signed) return signed ;
impure function RandSigned (variable RV : inout RandomType ; Max : signed) return signed ;
impure function RandSigned (variable RV : inout RandomType ; Min, Max : signed) return signed ;
impure function RandSigned (variable RV : inout RandomType ; Min, Max : signed ; Exclude : sv_vector) return signed ;
--!! impure function RandSigned (variable RV : inout RandomType ; Min, Max : signed ; Exclude : signed) return signed ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Convenience Functions. Resolve into calls into the other functions
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandReal (variable RV : inout RandomType ) return real ; -- 0.0 to 1.0
impure function RandReal (variable RV : inout RandomType ; Max : Real) return real ; -- 0.0 to Max
impure function RandInt (variable RV : inout RandomType ) return integer ;
impure function RandInt (variable RV : inout RandomType ; Max : integer) return integer ;
impure function RandSlv (variable RV : inout RandomType ; Max, Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; Max, Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; Max : integer ; Size : natural ) return Signed ;
impure function RandBool (variable RV : inout RandomType ) return boolean;
impure function RandSl (variable RV : inout RandomType ) return std_logic;
impure function RandBit (variable RV : inout RandomType ) return bit;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Convenience Functions with Exclude as an scalar rather than a _vector
-- Calls the version with _vector
--
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
---
--- Base Randomization Distributions
---
--- ///////////////////////////////////////////////////////////////////////////
impure function Uniform (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer) return integer ;
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer) return integer ;
impure function FavorBig (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer) return integer ;
impure function Normal (variable RV : inout RandomType ; Mean, StdDeviation : real; Min, Max, Exclude : integer) return integer ;
impure function Poisson (variable RV : inout RandomType ; Mean : real; Min, Max, Exclude : integer) return integer ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomization with range and exclude
--
--- ///////////////////////////////////////////////////////////////////////////
impure function RandInt (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer ) return integer ;
-- ambiguous if Unit has a default
-- impure function RandTime (variable RV : inout RandomType ; Min, Max : time ; Exclude : time ; Unit : time := ns) return time ;
impure function RandTime (variable RV : inout RandomType ; Min, Max : time ; Exclude : time ; Unit : time) return time ;
impure function RandSlv (variable RV : inout RandomType ; Min, Max : natural ; Exclude : integer ; Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; Min, Max : natural ; Exclude : integer ; Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer ; Size : natural) return Signed ;
-- ambiguous with RandIntV(RV, Min, Max, Unique, Size) return integer_vector ;
-- impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Exclude : time ; Size : natural ; Unit : in time := ns) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; Min, Max : time ; Exclude : time ; Unique : natural ; Size : natural ; Unit : in time := ns) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Randomly select a value within a set of values with exclude values (so can skip last or last n)
-- Uses internal settings of RandomParm to deterimine distribution.
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function RandInt (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ) return integer ;
impure function RandReal (variable RV : inout RandomType ; A : real_vector ; Exclude : real ) return real ;
impure function RandTime (variable RV : inout RandomType ; A : time_vector ; Exclude : time ) return time ;
impure function RandSlv (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ; Size : natural) return std_logic_vector ;
impure function RandUnsigned (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ; Size : natural) return Unsigned ;
impure function RandSigned (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ; Size : natural ) return Signed ;
-- ambiguous with RandIntV(RV, A, Unique, Size) return integer_vector ;
-- impure function RandIntV (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ; Size : natural) return integer_vector ;
impure function RandIntV (variable RV : inout RandomType ; A : integer_vector ; Exclude : integer ; Unique : natural ; Size : natural) return integer_vector ;
impure function RandRealV (variable RV : inout RandomType ; A : real_vector ; Exclude : real ; Size : natural) return real_vector ;
impure function RandRealV (variable RV : inout RandomType ; A : real_vector ; Exclude : real ; Unique : natural ; Size : natural) return real_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A : time_vector ; Exclude : time ; Size : natural) return time_vector ;
impure function RandTimeV (variable RV : inout RandomType ; A : time_vector ; Exclude : time ; Unique : natural ; Size : natural) return time_vector ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Basic Distributions with exclude values (so can skip last or last n)
-- Always uses Uniform via DistInt
--
--- ///////////////////////////////////////////////////////////////////////////
impure function DistInt (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer ) return integer ;
impure function DistSlv (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer ; Size : natural ) return std_logic_vector ;
impure function DistUnsigned (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer ; Size : natural ) return unsigned ;
impure function DistSigned (variable RV : inout RandomType ; Weight : integer_vector ; Exclude : integer ; Size : natural ) return signed ;
--- ///////////////////////////////////////////////////////////////////////////
--
-- Distribution for sparse values with exclude values (so can skip last or last n)
-- Specify weight and value
-- Always uses Uniform via DistInt
--
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
impure function DistValInt (variable RV : inout RandomType ; A : DistType ; Exclude : integer ) return integer ;
impure function DistValSlv (variable RV : inout RandomType ; A : DistType ; Exclude : integer ; Size : natural) return std_logic_vector ;
impure function DistValUnsigned (variable RV : inout RandomType ; A : DistType ; Exclude : integer ; Size : natural) return unsigned ;
impure function DistValSigned (variable RV : inout RandomType ; A : DistType ; Exclude : integer ; Size : natural) return signed ;
end RandomPkg2019 ;
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
package body RandomPkg2019 is
-----------------------------------------------------------------
-- Local Randomization Support
-----------------------------------------------------------------
constant NULL_SLV : std_logic_vector (NULL_RANGE_TYPE) := (others => '0') ;
constant NULL_UV : unsigned (NULL_RANGE_TYPE) := (others => '0') ;
constant NULL_SV : signed (NULL_RANGE_TYPE) := (others => '0') ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Base Call to Uniform. Use this one rather than RandomBasePkg
---
--- ///////////////////////////////////////////////////////////////////////////
--!! -----------------------------------------------------------------
--!! impure function Uniform return real is
--!! -----------------------------------------------------------------
--!! variable rRandom : real ;
--!! begin
--!! ieee.math_real.Uniform (RandomSeed(RandomSeed'left), RandomSeed(RandomSeed'right), rRandom) ;
--!! return rRandom ;
--!! end function Uniform ;
-----------------------------------------------------------------
impure function Uniform (variable RV : inout RandomType) return real is
-----------------------------------------------------------------
variable Result : real ;
begin
ieee.math_real.Uniform (RV.Seed(RV.Seed'left), RV.Seed(RV.Seed'right), Result) ;
return result ;
end function Uniform ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Seed Manipulation
---
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
procedure InitSeed ( variable RV : inout RandomType ; S : string ) is
------------------------------------------------------------
begin
RV.Seed := GenRandSeed(S) ;
end procedure InitSeed ;
------------------------------------------------------------
procedure InitSeed ( variable RV : inout RandomType ; I : integer ) is
------------------------------------------------------------
begin
RV.Seed := GenRandSeed(I) ;
end procedure InitSeed ;
------------------------------------------------------------
procedure InitSeed ( variable RV : inout RandomType ; T : time ) is
------------------------------------------------------------
begin
RV.Seed := GenRandSeed(T) ;
end procedure InitSeed ;
------------------------------------------------------------
procedure InitSeed ( variable RV : inout RandomType ; IV : integer_vector ) is
------------------------------------------------------------
begin
RV.Seed := GenRandSeed(IV) ;
end procedure InitSeed ;
------------------------------------------------------------
impure function InitSeed ( S : string ) return RandomType is
------------------------------------------------------------
variable RV : RandomType ;
begin
RV.Seed := GenRandSeed(S) ;
return RV ;
end function InitSeed ;
------------------------------------------------------------
impure function InitSeed ( I : integer ) return RandomType is
------------------------------------------------------------
variable RV : RandomType ;
begin
RV.Seed := GenRandSeed(I) ;
return RV ;
end function InitSeed ;
------------------------------------------------------------
impure function InitSeed ( T : time ) return RandomType is
------------------------------------------------------------
variable RV : RandomType ;
begin
RV.Seed := GenRandSeed(T) ;
return RV ;
end function InitSeed ;
------------------------------------------------------------
impure function InitSeed ( IV : integer_vector ) return RandomType is
------------------------------------------------------------
variable RV : RandomType ;
begin
RV.Seed := GenRandSeed(IV) ;
return RV ;
end function InitSeed ;
------------------------------------------------------------
impure function SetSeed (RandomSeedIn : RandomSeedType) return RandomType is
------------------------------------------------------------
variable RV : RandomType ;
begin
RV.Seed := RandomSeedIn ;
return RV ;
end function SetSeed ;
------------------------------------------------------------
procedure SetSeed (variable RV : inout RandomType ; RandomSeedIn : RandomSeedType ) is
------------------------------------------------------------
begin
RV.Seed := RandomSeedIn ;
end procedure SetSeed ;
------------------------------------------------------------
impure function GetSeed (RV : RandomType) return RandomSeedType is
------------------------------------------------------------
begin
return RV.Seed ;
end function GetSeed ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Setting Randomization Parameters
---
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
procedure SetRandomParam (variable RV : inout RandomType ; RandomParamIn : RandomParamType) is
------------------------------------------------------------
begin
RV.Param := RandomParamIn ;
end procedure SetRandomParam ;
------------------------------------------------------------
procedure SetRandomParam (
------------------------------------------------------------
variable RV : inout RandomType ;
Distribution : RandomDistType ;
Mean : Real := 0.0 ;
Deviation : Real := 0.0
) is
begin
RV.Param := RandomParmType'(Distribution, Mean, Deviation) ;
end procedure SetRandomParam ;
------------------------------------------------------------
impure function GetRandomParam (variable RV : inout RandomType) return RandomParamType is
------------------------------------------------------------
begin
return RV.Param ;
end function GetRandomParam ;
------------------------------------------------------------
impure function GetRandomParam (variable RV : inout RandomType) return RandomDistType is
------------------------------------------------------------
begin
return RV.Param.Distribution ;
end function GetRandomParam ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Check ranges for Randomization and Generate FAILURE
---
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
-- PT Local
impure function CheckMinMax(
------------------------------------------------------------
constant Name : in string ;
constant Min : in real ;
constant Max : in real
) return real is
begin
if Min > Max then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019." & Name &
": Min: " & to_string(Min, 2) &
" > Max: " & to_string(Max, 2),
FAILURE ) ;
return Min ;
else
return Max ;
end if;
end function CheckMinMax ;
------------------------------------------------------------
-- PT Local
impure function CheckMinMax(
------------------------------------------------------------
constant Name : in string ;
constant Min : in integer ;
constant Max : in integer
) return integer is
begin
if Min > Max then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019." & Name &
": Min: " & to_string(Min) &
" > Max: " & to_string(Max),
FAILURE ) ;
return Min ;
else
return Max ;
end if;
end function CheckMinMax ;
------------------------------------------------------------
-- PT Local
impure function CheckMinMax(
------------------------------------------------------------
constant Name : in string ;
constant Min : in time ;
constant Max : in time
) return time is
begin
if Min > Max then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019." & Name &
": Min: " & to_string(Min, ns) &
" > Max: " & to_string(Max, ns),
FAILURE ) ;
return Min ;
else
return Max ;
end if;
end function CheckMinMax ;
--- ///////////////////////////////////////////////////////////////////////////
---
--- Base Randomization Distributions
---
--- ///////////////////////////////////////////////////////////////////////////
------------------------------------------------------------
--
-- Uniform
-- Generate a random number with a Uniform distribution
--
------------------------------------------------------------
impure function LocalUniform (variable RV : inout RandomType ; Min, Max : in real) return real is
------------------------------------------------------------
begin
return scale(Uniform(RV), Min, Max) ;
end function LocalUniform ;
------------------------------------------------------------
impure function Uniform (variable RV : inout RandomType ; Min, Max : in real) return real is
------------------------------------------------------------
constant CkMax : real := CheckMinMax("Uniform", Min, Max) ;
begin
return LocalUniform(RV, Min, CkMax) ;
end function Uniform ;
------------------------------------------------------------
impure function LocalUniform (variable RV : inout RandomType ; Min, Max : integer) return integer is
------------------------------------------------------------
begin
return scale(Uniform(RV), Min, Max) ;
end function LocalUniform ;
------------------------------------------------------------
impure function Uniform (variable RV : inout RandomType ; Min, Max : integer) return integer is
------------------------------------------------------------
constant CkMax : integer := CheckMinMax("Uniform", Min, Max) ;
begin
return LocalUniform(RV, Min, CkMax) ;
end function Uniform ;
------------------------------------------------------------
impure function LocalUniform (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer is
------------------------------------------------------------
variable iRandomVal : integer ;
variable ExcludeList : SortListPType ;
variable count : integer ;
begin
ExcludeList.add(Exclude, Min, Max) ;
count := ExcludeList.count ;
iRandomVal := Uniform(RV, Min, Max - count) ;
-- adjust count, note iRandomVal changes while checking.
for i in 1 to count loop
exit when iRandomVal < ExcludeList.Get(i) ;
iRandomVal := iRandomVal + 1 ;
end loop ;
ExcludeList.erase ;
return iRandomVal ;
end function LocalUniform ;
------------------------------------------------------------
impure function Uniform (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer is
------------------------------------------------------------
constant CkMax : integer := CheckMinMax("Uniform", Min, Max) ;
begin
return LocalUniform (RV, Min, CkMax, Exclude) ;
end function Uniform ;
------------------------------------------------------------
--
-- FavorSmall
-- Generate random numbers with a greater number of small
-- values than large values
--
------------------------------------------------------------
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : real) return real is
------------------------------------------------------------
constant CkMax : real := CheckMinMax("FavorSmall", Min, Max) ;
begin
return scale(FavorSmall(Uniform(RV)), Min, CkMax) ; -- real
end function FavorSmall ;
------------------------------------------------------------
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : integer) return integer is
------------------------------------------------------------
constant CkMax : integer := CheckMinMax("FavorSmall", Min, Max) ;
begin
return scale(FavorSmall(Uniform(RV)), Min, CkMax) ; -- integer
end function FavorSmall ;
------------------------------------------------------------
impure function FavorSmall (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer is
------------------------------------------------------------
variable iRandomVal : integer ;
variable ExcludeList : SortListPType ;
variable count : integer ;
constant CkMax : integer := CheckMinMax("FavorSmall", Min, Max) ;
begin
ExcludeList.add(Exclude, Min, CkMax) ;
count := ExcludeList.count ;
iRandomVal := FavorSmall(RV, Min, CkMax - count) ;
-- adjust count, note iRandomVal changes while checking.
for i in 1 to count loop
exit when iRandomVal < ExcludeList.Get(i) ;
iRandomVal := iRandomVal + 1 ;
end loop ;
ExcludeList.erase ;
return iRandomVal ;
end function FavorSmall ;
------------------------------------------------------------
--
-- FavorBig
-- Generate random numbers with a greater number of large
-- values than small values
--
------------------------------------------------------------
impure function FavorBig (variable RV : inout RandomType ; Min, Max : real) return real is
------------------------------------------------------------
constant CkMax : real := CheckMinMax("FavorBig", Min, Max) ;
begin
return scale(FavorBig(Uniform(RV)), Min, CkMax) ; -- real
end function FavorBig ;
------------------------------------------------------------
impure function FavorBig (variable RV : inout RandomType ; Min, Max : integer) return integer is
------------------------------------------------------------
constant CkMax : integer := CheckMinMax("FavorBig", Min, Max) ;
begin
return scale(FavorBig(Uniform(RV)), Min, CkMax) ; -- integer
end function FavorBig ;
------------------------------------------------------------
impure function FavorBig (variable RV : inout RandomType ; Min, Max : integer ; Exclude : integer_vector) return integer is
------------------------------------------------------------
variable iRandomVal : integer ;
variable ExcludeList : SortListPType ;
variable count : integer ;
constant CkMax : integer := CheckMinMax("FavorBig", Min, Max) ;
begin
ExcludeList.add(Exclude, Min, CkMax) ;
count := ExcludeList.count ;
iRandomVal := FavorBig(RV, Min, CkMax - count) ;
-- adjust count, note iRandomVal changes while checking.
for i in 1 to count loop
exit when iRandomVal < ExcludeList.Get(i) ;
iRandomVal := iRandomVal + 1 ;
end loop ;
ExcludeList.erase ;
return iRandomVal ;
end function FavorBig ;
-----------------------------------------------------------------
--
-- Normal
-- Generate a random number with a normal distribution
--
-- Use Box Muller, per Wikipedia :
-- http ://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform
--
------------------------------------------------------------
impure function Normal (variable RV : inout RandomType ; Mean, StdDeviation : real) return real is
------------------------------------------------------------
variable x01, y01 : real ;
variable StdNormalDist : real ; -- mean 0, variance 1
begin
-- add this check to set parameters?
if StdDeviation < 0.0 then
Alert(OSVVM_RANDOM_ALERTLOG_ID, "RandomPkg2019.Normal: Standard deviation must be >= 0.0", FAILURE) ;
return -1.0 ;
end if ;
-- Box Muller
-- Uniform (x01, RandomSeed) ;
-- Uniform (y01, RandomSeed) ;
x01 := Uniform(RV) ;
y01 := Uniform(RV) ;
StdNormalDist := sqrt(-2.0 * log(x01)) * cos(math_2_pi*y01) ;
-- Polar form rejected due to mean 50.0, std deviation = 5 resulted
-- in a median of 49
-- -- find two Uniform distributed values with range -1 to 1
-- -- that satisify S = X **2 + Y**2 < 1.0
-- loop
-- Uniform (x01, RandomSeed) ;
-- Uniform (y01, RandomSeed) ;
-- x := 2.0 * x01 - 1.0 ; -- scale to -1 to 1
-- y := 2.0 * y01 - 1.0 ;
-- s := x*x + y*y ;
-- exit when s < 1.0 and s > 0.0 ;
-- end loop ;
-- -- Calculate Standard Normal Distribution
-- StdNormalDist := x * sqrt((-2.0 * log(s)) / s) ;
-- Convert to have Mean and StdDeviation
return StdDeviation * StdNormalDist + Mean ;
end function Normal ;
------------------------------------------------------------
-- Normal + RandomVal >= Min and RandomVal <= Max
impure function Normal (variable RV : inout RandomType ; Mean, StdDeviation, Min, Max : real) return real is
------------------------------------------------------------
variable rRandomVal : real ;
begin
if Max < Min then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019.Normal: Min: " & to_string(Min, 2) &
" > Max: " & to_string(Max, 2),
FAILURE) ;
return Mean ;
else
loop
rRandomVal := Normal (RV, Mean, StdDeviation) ;
exit when rRandomVal >= Min and rRandomVal <= Max ;
end loop ;
end if ;
return rRandomVal ;
end function Normal ;
------------------------------------------------------------
-- Normal + RandomVal >= Min and RandomVal <= Max
impure function Normal (
------------------------------------------------------------
variable RV : inout RandomType ;
Mean : real ;
StdDeviation : real ;
Min : integer ;
Max : integer ;
Exclude : integer_vector := NULL_INTV
) return integer is
variable iRandomVal : integer ;
begin
if Max < Min then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019.Normal: Min: " & to_string(Min) &
" > Max: " & to_string(Max),
FAILURE) ;
return integer(round(Mean)) ;
else
loop
iRandomVal := integer(round( Normal(RV, Mean, StdDeviation) )) ;
exit when iRandomVal >= Min and iRandomVal <= Max and
not inside(iRandomVal, Exclude) ;
end loop ;
end if ;
return iRandomVal ;
end function Normal ;
-----------------------------------------------------------------
-- Poisson
-- Generate a random number with a poisson distribution
-- Discrete distribution = only generates integral values
--
-- Use knuth method, per Wikipedia :
-- http ://en.wikipedia.org/wiki/Poisson_distribution
--
------------------------------------------------------------
impure function Poisson (variable RV : inout RandomType ; Mean : real) return real is
------------------------------------------------------------
variable Product : Real := 1.0 ;
variable Bound : Real := 0.0 ;
variable UniformRand : Real := 0.0 ;
variable PoissonRand : Real := 0.0 ;
begin
Bound := exp(-1.0 * Mean) ;
Product := 1.0 ;
-- add this check to set parameters?
if Mean <= 0.0 or Bound <= 0.0 then
Alert(OSVVM_RANDOM_ALERTLOG_ID, "RandomPkg2019.Poisson: Mean < 0 or too large. Mean = " & real'image(Mean), FAILURE) ;
return Mean ;
end if ;
while (Product >= Bound) loop
PoissonRand := PoissonRand + 1.0 ;
UniformRand := Uniform(RV) ;
Product := Product * UniformRand ;
end loop ;
return PoissonRand ;
end function Poisson ; -- no range
------------------------------------------------------------
-- Poisson + RandomVal >= Min and RandomVal < Max
impure function Poisson (variable RV : inout RandomType ; Mean, Min, Max : real) return real is
------------------------------------------------------------
variable rRandomVal : real ;
begin
if Max < Min then
Alert(OSVVM_RANDOM_ALERTLOG_ID,
"RandomPkg2019.Poisson: Min: " & to_string(Min, 2) &
" > Max: " & to_string(Max, 2),
FAILURE) ;