Subversion Repositories rng_lib

/trunk/bench/vhdl/math_lib.vhd File deleted

/trunk/bench/vhdl/tb_rng.vhd File deleted

/trunk/bench/vhdl/rng_lib.vhd File deleted

/trunk/doc/random_ug.pdf Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream

/trunk/doc/random_ug.pdf

trunk/doc/random_ug.pdf Property changes : Deleted: svn:mime-type ## -1 +0,0 ## -application/octet-stream \ No newline at end of property Index: trunk/doc/copying.txt =================================================================== --- trunk/doc/copying.txt (revision 7) +++ trunk/doc/copying.txt (nonexistent) @@ -1,281 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - Index: trunk/doc/src/random_ug.doc =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/random_ug.doc =================================================================== --- trunk/doc/src/random_ug.doc (revision 7) +++ trunk/doc/src/random_ug.doc (nonexistent)

trunk/doc/src/random_ug.doc Property changes : Deleted: svn:mime-type ## -1 +0,0 ## -application/octet-stream \ No newline at end of property Index: rng_lib/trunk/bench/vhdl/math_lib.vhd =================================================================== --- rng_lib/trunk/bench/vhdl/math_lib.vhd (nonexistent) +++ rng_lib/trunk/bench/vhdl/math_lib.vhd (revision 8) @@ -0,0 +1,232 @@ +---------------------------------------------------------------------- +---- ---- +---- Math function library. ---- +---- ---- +---- This file is part of the Random Number Generator project ---- +---- http://www.opencores.org/cores/rng_lib/ ---- +---- ---- +---- Description ---- +---- These math function are copied from the draft version of the ---- +---- IEEE MATH_REAL package. ---- +---- ---- +---- To Do: ---- +---- - ---- +---- ---- +---- Author(s): ---- +---- - Geir Drange, gedra@opencores.org ---- +---- ---- +---------------------------------------------------------------------- +---- ---- +---- Copyright (C) 2004 Authors and OPENCORES.ORG ---- +---- ---- +---- This source file may be used and distributed without ---- +---- restriction provided that this copyright statement is not ---- +---- removed from the file and that any derivative work contains ---- +---- the original copyright notice and the associated disclaimer. ---- +---- ---- +---- This source file is free software; you can redistribute it ---- +---- and/or modify it under the terms of the GNU General ---- +---- Public License as published by the Free Software Foundation; ---- +---- either version 2.0 of the License, or (at your option) any ---- +---- later version. ---- +---- ---- +---- This source is distributed in the hope that it will be ---- +---- useful, but WITHOUT ANY WARRANTY; without even the implied ---- +---- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR ---- +---- PURPOSE. See the GNU General Public License for more details.---- +---- ---- +---- You should have received a copy of the GNU General ---- +---- Public License along with this source; if not, download it ---- +---- from http://www.gnu.org/licenses/gpl.txt ---- +---- ---- +---------------------------------------------------------------------- +-- +-- CVS Revision History +-- +-- $Log: not supported by cvs2svn $ +-- Revision 1.1 2004/09/28 15:02:56 gedra +-- Math functions library. +-- +-- +-- + +library ieee; +use ieee.std_logic_1164.all; +use ieee.numeric_std.all; + +package math_lib is + + function sqrt(x : real) return real; -- returns square root + function ln(x : real) return real; -- natural logarithm + function log(x : real) return real; -- base 10 logarithm + function exp(x : real) return real; -- exponential function + + -- Some mathematical constants + constant MATH_E : real := 2.71828_18284_59045_23536; + +end math_lib; + +package body math_lib is + +-- Square root calculation + function sqrt (x : real) return real is + -- returns square root of X; X >= 0 + -- + -- Computes square root using the Newton-Raphson approximation: + -- F(n+1) = 0.5*[F(n) + x/F(n)]; + -- + + constant inival : real := 1.5; + constant eps : real := 0.000001; + constant relative_err : real := eps*X; + + variable oldval : real; + variable newval : real; + + begin + -- check validity of argument + if x < 0.0 then + report "x < 0 in sqrt(x)" + severity failure; + return (0.0); + end if; + + -- get the square root for special cases + if x = 0.0 then + return 0.0; + else + if x = 1.0 then + return 1.0; -- return exact value + end if; + end if; + + -- get the square root for general cases + oldval := inival; + newval := (X/oldval + oldval)/2.0; + + while (abs(newval -oldval) > relative_err) loop + oldval := newval; + newval := (X/oldval + oldval)/2.0; + end loop; + + return newval; + end sqrt; + +-- Natural logarithm calculation + function ln (x : real) return real is + -- returns natural logarithm of X; X > 0 + -- + -- This function computes the exponential using the following series: + -- log(x) = 2[ (x-1)/(x+1) + (((x-1)/(x+1))**3)/3.0 + ...] ; x > 0 + -- + + constant eps : real := 0.000001; -- precision criteria + + variable xlocal : real; -- following variables are + variable oldval : real; -- used to evaluate the series + variable xlocalsqr : real; + variable factor : real; + variable count : integer; + variable newval : real; + + begin + -- check validity of argument + if x <= 0.0 then + report "x <= 0 in ln(x)" + severity failure; + return(real'low); + end if; + + -- compute value for special cases + if x = 1.0 then + return 0.0; + else + if x = MATH_E then + return 1.0; + end if; + end if; + + -- compute value for general cases + xlocal := (x - 1.0)/(x + 1.0); + oldval := xlocal; + xlocalsqr := xlocal*xlocal; + factor := xlocal*xlocalsqr; + count := 3; + newval := oldval + (factor/real(count)); + + while (abs(newval - oldval) > eps) loop + oldval := newval; + count := count +2; + factor := factor * xlocalsqr; + newval := oldval + factor/real(count); + end loop; + + newval := newval * 2.0; + return newval; + end ln; + +-- Base 10 logarithm calculation + function log (x : real) return real is + -- returns logarithm base 10 of x; x > 0 + begin + -- check validity of argument + if x <= 0.0 then + assert false report "x <= 0.0 in log(x)" + severity error; + return(real'low); + end if; + + -- compute the value + return (ln(x)/2.30258509299); + end log; + +-- Calculate e**x + function exp (x : real) return real is + -- returns e**X; where e = MATH_E + -- + -- This function computes the exponential using the following series: + -- exp(x) = 1 + x + x**2/2! + x**3/3! + ... ; x > 0 + -- + constant eps : real := 0.000001; -- precision criteria + + variable reciprocal : boolean := x < 0.0; -- check sign of argument + variable xlocal : real := abs(x); -- use positive value + variable oldval : real; -- following variables are + variable num : real; -- used for series evaluation + variable count : integer; + variable denom : real; + variable newval : real; + + begin + -- compute value for special cases + if x = 0.0 then + return 1.0; + else + if x = 1.0 then + return MATH_E; + end if; + end if; + + -- compute value for general cases + oldval := 1.0; + num := xlocal; + count := 1; + denom := 1.0; + newval := oldval + num/denom; + + while (abs(newval - oldval) > eps) loop + oldval := newval; + num := num*xlocal; + count := count +1; + denom := denom*(real(count)); + newval := oldval + num/denom; + end loop; + + if reciprocal then + newval := 1.0/newval; + end if; + + return newval; + end exp; + +end math_lib; Index: rng_lib/trunk/bench/vhdl/tb_rng.vhd =================================================================== --- rng_lib/trunk/bench/vhdl/tb_rng.vhd (nonexistent) +++ rng_lib/trunk/bench/vhdl/tb_rng.vhd (revision 8) @@ -0,0 +1,158 @@ +---------------------------------------------------------------------- +---- ---- +---- Testbench for Rand number generator library. ---- +---- ---- +---- This file is part of the Random Number Generator project ---- +---- http://www.opencores.org/cores/rng_lib/ ---- +---- ---- +---- Description ---- +---- The test bench will generate 10000 random numbers from each ---- +---- distribution and do a simple plot of the distributions. ---- +---- ---- +---- To Do: ---- +---- - ---- +---- ---- +---- Author(s): ---- +---- - Geir Drange, gedra@opencores.org ---- +---- ---- +---------------------------------------------------------------------- +---- ---- +---- Copyright (C) 2004 Authors and OPENCORES.ORG ---- +---- ---- +---- This source file may be used and distributed without ---- +---- restriction provided that this copyright statement is not ---- +---- removed from the file and that any derivative work contains ---- +---- the original copyright notice and the associated disclaimer. ---- +---- ---- +---- This source file is free software; you can redistribute it ---- +---- and/or modify it under the terms of the GNU General ---- +---- Public License as published by the Free Software Foundation; ---- +---- either version 2.0 of the License, or (at your option) any ---- +---- later version. ---- +---- ---- +---- This source is distributed in the hope that it will be ---- +---- useful, but WITHOUT ANY WARRANTY; without even the implied ---- +---- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR ---- +---- PURPOSE. See the GNU General Public License for more details.---- +---- ---- +---- You should have received a copy of the GNU General ---- +---- Public License along with this source; if not, download it ---- +---- from http://www.gnu.org/licenses/gpl.txt ---- +---- ---- +---------------------------------------------------------------------- +-- +-- CVS Revision History +-- +-- $Log: not supported by cvs2svn $ +-- Revision 1.1 2004/09/28 15:12:52 gedra +-- Test bench for random numbers. +-- +-- +-- + +library ieee; +use ieee.std_logic_1164.all; +use ieee.numeric_std.all; +use std.textio.all; +use work.rng_lib.all; + +entity tb_rng is + +end tb_rng; + +architecture behav of tb_rng is + + constant BIN_COUNT : integer := 15; + constant PLOT_HEIGHT : real := 40.0; + constant RAND_COUNT : integer := 10000; + + type rand_array is array (0 to RAND_COUNT - 1) of real; -- array used for plot + type bin_array is array (0 to BIN_COUNT - 1) of integer; + +-- Plot a distribution of the numbers that are between lo,hi values + impure function plot_dist (numbs : rand_array; lo, hi : real) return integer is + variable bins : bin_array; + variable bin_size, height : real; + variable idx, max : integer; + variable bar : line; + begin + -- reset bins + for i in 0 to BIN_COUNT - 1 loop + bins(i) := 0; + end loop; + -- sort numbers into bins + bin_size := (hi - lo) / real(BIN_COUNT); + for i in 0 to RAND_COUNT - 1 loop + if numbs(i) > lo and numbs(i) < hi then + idx := integer(((numbs(i) - lo) / bin_size) - 0.5); + if idx > BIN_COUNT - 1 then + idx := BIN_COUNT - 1; + elsif idx < 0 then + idx := 0; + end if; + bins(idx) := bins(idx) + 1; + end if; + end loop; + -- find largest bin + max := 0; + for i in 0 to BIN_COUNT - 1 loop + if bins(i) > max then + max := bins(i); + end if; + end loop; + -- plot bins + for i in 0 to BIN_COUNT - 1 loop + height := PLOT_HEIGHT * real(bins(i)) / real(max); + for j in 1 to integer(height) loop + write(bar, string'("*")); + end loop; + writeline(OUTPUT, bar); + end loop; + return 0; + end plot_dist; + +begin + + p1 : process + variable r_uni, r_gauss, r_exp : rand_var; + variable r_poisson : rand_var; + variable txt : line; + variable a : integer; + variable numbs : rand_array; + begin + -- Test the uniform distribution + r_uni := init_uniform(0, 0, 0, 0.0, 10.0); -- range 0 to 10 + t1 : for i in 0 to RAND_COUNT - 1 loop + r_uni := rand(r_uni); + numbs(i) := r_uni.rnd; + end loop t1; + write(txt, string'("Uniform distribution:")); + writeline(OUTPUT, txt); + a := plot_dist (numbs, 0.0, 10.0); + -- Test the gaussian distribution + r_gauss := init_gaussian(0, 0, 0, 0.0, 10.0); -- mean=0, stdev=10 + t2 : for i in 0 to RAND_COUNT - 1 loop + r_gauss := rand(r_gauss); + numbs(i) := r_gauss.rnd; + end loop t2; + write(txt, string'("Gaussian distribution:")); + writeline(OUTPUT, txt); + a := plot_dist (numbs, -20.0, 20.0); + -- Test the exponential distribution + r_exp := init_exponential(0, 0, 0, 10.0); -- mean=10 + t3 : for i in 0 to RAND_COUNT - 1 loop + r_exp := rand(r_exp); + numbs(i) := r_exp.rnd; + end loop t3; + write(txt, string'("Exponential distribution:")); + writeline(OUTPUT, txt); + a := plot_dist (numbs, 0.0, 20.0); + + wait for 1 ns; + + report "End of simulation! (ignore this failure)" + severity failure; + wait; + end process p1; + +end behav; Index: rng_lib/trunk/bench/vhdl/rng_lib.vhd =================================================================== --- rng_lib/trunk/bench/vhdl/rng_lib.vhd (nonexistent) +++ rng_lib/trunk/bench/vhdl/rng_lib.vhd (revision 8) @@ -0,0 +1,255 @@ +---------------------------------------------------------------------- +---- ---- +---- Rand number generator library. ---- +---- ---- +---- This file is part of the Random Number Generator project ---- +---- http://www.opencores.org/cores/rng_lib/ ---- +---- ---- +---- Description ---- +---- This library has function for generation random numbers with ---- +---- the following distributions: ---- +---- - Uniform (continous) ---- +---- - Exponential (continous) ---- +---- - Gaussian (continous) ---- +---- ---- +---- Random numbers are produced with a combination of 3 ---- +---- Tausworthe generators which gives very good statistical ---- +---- properties. ---- +---- ---- +---- NOTE! These functions will NOT synthesize. They are for test ---- +---- bench use only! ---- +---- ---- +---- To Do: ---- +---- - ---- +---- ---- +---- Author(s): ---- +---- - Geir Drange, gedra@opencores.org ---- +---- ---- +---------------------------------------------------------------------- +---- ---- +---- Copyright (C) 2004 Authors and OPENCORES.ORG ---- +---- ---- +---- This source file may be used and distributed without ---- +---- restriction provided that this copyright statement is not ---- +---- removed from the file and that any derivative work contains ---- +---- the original copyright notice and the associated disclaimer. ---- +---- ---- +---- This source file is free software; you can redistribute it ---- +---- and/or modify it under the terms of the GNU General ---- +---- Public License as published by the Free Software Foundation; ---- +---- either version 2.0 of the License, or (at your option) any ---- +---- later version. ---- +---- ---- +---- This source is distributed in the hope that it will be ---- +---- useful, but WITHOUT ANY WARRANTY; without even the implied ---- +---- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR ---- +---- PURPOSE. See the GNU General Public License for more details.---- +---- ---- +---- You should have received a copy of the GNU General ---- +---- Public License along with this source; if not, download it ---- +---- from http://www.gnu.org/licenses/gpl.txt ---- +---- ---- +---------------------------------------------------------------------- +-- +-- CVS Revision History +-- +-- $Log: not supported by cvs2svn $ +-- Revision 1.1 2004/09/28 15:12:28 gedra +-- Random number library functions. +-- +-- +-- + +library ieee; +use ieee.std_logic_1164.all; +use ieee.numeric_std.all; +use std.textio.all; +use work.math_lib.all; + +package rng_lib is + + type distribution is (UNIFORM, GAUSSIAN, EXPONENTIAL); + type rand_var is record -- random variable record + rnd : real; -- random number + rnd_v : unsigned(31 downto 0); -- random number vector + dist : distribution; -- distribution type + y, z : real; -- distribution parameters + s1, s2, s3 : unsigned(31 downto 0); -- seeds + mask1, mask2, mask3 : unsigned(31 downto 0); + shft1, shft2, shft3 : natural; + end record; + + function rand (rnd : rand_var) return rand_var; + function init_uniform(constant a, b, c : natural; + constant lo, hi : real) return rand_var; + function init_gaussian(constant a, b, c : natural; + constant mean, stdev : real) return rand_var; + function init_exponential(constant a, b, c : natural; + constant mean : real) return rand_var; + + constant q1 : natural := 13; + constant q2 : natural := 2; + constant q3 : natural := 3; + constant p1 : natural := 12; + constant p2 : natural := 4; + constant p3 : natural := 17; + +end rng_lib; + +package body rng_lib is + +-- Function to convert 32bit unsigned vector to real +-- Integers only go to 2**31 (VHDL'87), so do it clever + function unsigned_2_real (constant a : unsigned(31 downto 0)) return real is + variable r : real; + begin + r := 2.0*real(to_integer(a(31 downto 1))); + if a(0) = '1' then + r := r + 1.0; + end if; + return(r); + end unsigned_2_real; + +-- Generate random number using a combination of 3 tausworthe generators +-- Source: Pierre L'Ecuyer, "Maximally Equidistributed Combined Tausworthe +-- Generators". Mathematics of Computation, vol.65, no.213(1996), pp203--213. + function rng (rnd : rand_var) return rand_var is + variable new_rnd : rand_var; + variable b : unsigned(31 downto 0); + begin + new_rnd := rnd; + b := ((new_rnd.s1 sll q1) xor new_rnd.s1) srl new_rnd.shft1; + new_rnd.s1 := ((new_rnd.s1 and new_rnd.mask1) sll p1) xor b; + b := ((new_rnd.s2 sll q2) xor new_rnd.s2) srl new_rnd.shft2; + new_rnd.s2 := ((new_rnd.s2 and new_rnd.mask2) sll p2) xor b; + b := ((new_rnd.s3 sll q3) xor new_rnd.s3) srl new_rnd.shft3; + new_rnd.s3 := ((new_rnd.s3 and new_rnd.mask3) sll p3) xor b; + new_rnd.rnd_v := new_rnd.s1 xor new_rnd.s2 xor new_rnd.s3; + -- normalize to range [0,1) + new_rnd.rnd := unsigned_2_real(new_rnd.rnd_v) / 65536.0; + new_rnd.rnd := new_rnd.rnd / 65536.0; + return (new_rnd); + end rng; + +-- rand function generates a random variable with different distributions + function rand (rnd : rand_var) return rand_var is + variable rnd_out : rand_var; + variable x, y, z : real; + variable t : real := 0.0; + begin + case rnd.dist is + -- Uniform distribution + when UNIFORM => + rnd_out := rng(rnd); + rnd_out.rnd := rnd.y + (rnd_out.rnd * (rnd.z - rnd.y)); + -- Gaussian distribution + when GAUSSIAN => -- Box-Mueller method + z := 2.0; + rnd_out := rnd; + while z > 1.0 or z = 0.0 loop + -- choose x,y in uniform square (-1,-1) to (+1,+1) + rnd_out := rng(rnd_out); + x := -1.0 + 2.0 * rnd_out.rnd; + rnd_out := rng(rnd_out); + y := -1.0 + 2.0 * rnd_out.rnd; + z := (x * x) + (y * y); + end loop; + -- Box-Mueller transform + rnd_out.rnd := rnd_out.y + rnd_out.z * y * sqrt(-2.0 * log(z)/z); + -- Exponential distribution + when EXPONENTIAL => + rnd_out := rng(rnd); + rnd_out.rnd := -rnd_out.y * log(1.0 - rnd_out.rnd); + when others => + report "rand() function encountered an error!" + severity failure; + end case; + return (rnd_out); + end rand; + +-- Initialize seeds, used by all init_ functions + function gen_seed (constant a, b, c : natural) return rand_var is + variable seeded : rand_var; + variable x : unsigned(31 downto 0) := "11111111111111111111111111111111"; + constant k1 : natural := 31; + constant k2 : natural := 29; + constant k3 : natural := 28; + begin + seeded.shft1 := k1-p1; + seeded.shft2 := k2-p2; + seeded.shft3 := k3-p3; + seeded.mask1 := x sll (32-k1); + seeded.mask2 := x sll (32-k2); + seeded.mask3 := x sll (32-k3); + seeded.s1 := to_unsigned(390451501, 32); + seeded.s2 := to_unsigned(613566701, 32); + seeded.s3 := to_unsigned(858993401, 32); + if to_unsigned(a, 32) > (to_unsigned(1, 32) sll (32-k1)) then + seeded.s1 := to_unsigned(a, 32); + end if; + if to_unsigned(b, 32) > (to_unsigned(1, 32) sll (32-k2)) then + seeded.s2 := to_unsigned(b, 32); + end if; + if to_unsigned(c, 32) > (to_unsigned(1, 32) sll (32-k3)) then + seeded.s3 := to_unsigned(c, 32); + end if; + return(seeded); + end gen_seed; + +-- Uniform distribution random variable initialization +-- a,b,c are seeds +-- lo,hi is the range for the uniform distribution + function init_uniform(constant a, b, c : natural; + constant lo, hi : real) return rand_var is + variable rnd, rout : rand_var; + begin + if lo >= hi then + report "Uniform parameter error: 'hi' must be > 'lo'!" + severity failure; + end if; + rnd := gen_seed(a, b, c); + rnd.dist := UNIFORM; + rnd.y := lo; + rnd.z := hi; + rout := rand(rnd); + return(rout); + end init_uniform; + +-- Gaussian distribution random variable initialization +-- a,b,c are seeds +-- mean,stdev is mean and standard deviation + function init_gaussian(constant a, b, c : natural; + constant mean, stdev : real) return rand_var is + variable rnd, rout : rand_var; + begin + if stdev = 0.0 then + report "Gaussian parameter error: 'stdev' must be non-zero!" + severity failure; + end if; + rnd := gen_seed(a, b, c); + rnd.dist := GAUSSIAN; + rnd.y := mean; + rnd.z := stdev; + rout := rand(rnd); + return(rout); + end init_gaussian; + +-- Exponential distribution random variable initialization +-- a,b,c are seeds +-- mean: mean value + function init_exponential(constant a, b, c : natural; + constant mean : real) return rand_var is + variable rnd, rout : rand_var; + begin + if mean <= 0.0 then + report "Exponential parameter error: 'mean' must be > 0!" + severity failure; + end if; + rnd := gen_seed(a, b, c); + rnd.dist := EXPONENTIAL; + rnd.y := mean; + rout := rand(rnd); + return(rout); + end init_exponential; + +end rng_lib; Index: rng_lib/trunk/doc/random_ug.pdf =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: rng_lib/trunk/doc/random_ug.pdf =================================================================== --- rng_lib/trunk/doc/random_ug.pdf (nonexistent) +++ rng_lib/trunk/doc/random_ug.pdf (revision 8)

rng_lib/trunk/doc/random_ug.pdf Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: rng_lib/trunk/doc/src/random_ug.doc =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: rng_lib/trunk/doc/src/random_ug.doc =================================================================== --- rng_lib/trunk/doc/src/random_ug.doc (nonexistent) +++ rng_lib/trunk/doc/src/random_ug.doc (revision 8)

rng_lib/trunk/doc/src/random_ug.doc Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: rng_lib/trunk/doc/copying.txt =================================================================== --- rng_lib/trunk/doc/copying.txt (nonexistent) +++ rng_lib/trunk/doc/copying.txt (revision 8) @@ -0,0 +1,281 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + Index: rng_lib/trunk =================================================================== --- rng_lib/trunk (nonexistent) +++ rng_lib/trunk (revision 8)

rng_lib/trunk Property changes : Added: svn:mergeinfo ## -0,0 +0,0 ## Index: rng_lib/web_uploads =================================================================== --- rng_lib/web_uploads (nonexistent) +++ rng_lib/web_uploads (revision 8)

rng_lib/web_uploads Property changes : Added: svn:mergeinfo ## -0,0 +0,0 ## Index: rng_lib/branches =================================================================== --- rng_lib/branches (nonexistent) +++ rng_lib/branches (revision 8)

rng_lib/branches Property changes : Added: svn:mergeinfo ## -0,0 +0,0 ## Index: rng_lib/tags =================================================================== --- rng_lib/tags (nonexistent) +++ rng_lib/tags (revision 8)

rng_lib/tags Property changes : Added: svn:mergeinfo ## -0,0 +0,0 ##