/usr/share/gtk-doc/html/libgwyddion/libgwyddion-GwyRandGenSet.html is in libgwyddion20-doc 2.50-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyRandGenSet: Gwyddion Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="GwyInventory.html" title="GwyInventory">
<link rel="next" href="GwyResource.html" title="GwyResource">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgwyddion-GwyRandGenSet.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="GwyInventory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyResource.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyddion-GwyRandGenSet"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-GwyRandGenSet.top_of_page"></a>GwyRandGenSet</span></h2>
<p>GwyRandGenSet — Set of random number generators</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="returnvalue">GwyRandGenSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-new" title="gwy_rand_gen_set_new ()">gwy_rand_gen_set_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-init" title="gwy_rand_gen_set_init ()">gwy_rand_gen_set_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-free" title="gwy_rand_gen_set_free ()">gwy_rand_gen_set_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Random-Numbers.html#GRand"><span class="returnvalue">GRand</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-rng" title="gwy_rand_gen_set_rng ()">gwy_rand_gen_set_rng</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-range" title="gwy_rand_gen_set_range ()">gwy_rand_gen_set_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-uniform" title="gwy_rand_gen_set_uniform ()">gwy_rand_gen_set_uniform</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-gaussian" title="gwy_rand_gen_set_gaussian ()">gwy_rand_gen_set_gaussian</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-exponential" title="gwy_rand_gen_set_exponential ()">gwy_rand_gen_set_exponential</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-triangular" title="gwy_rand_gen_set_triangular ()">gwy_rand_gen_set_triangular</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-multiplier" title="gwy_rand_gen_set_multiplier ()">gwy_rand_gen_set_multiplier</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-double" title="gwy_rand_gen_set_double ()">gwy_rand_gen_set_double</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-int" title="gwy_rand_gen_set_int ()">gwy_rand_gen_set_int</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-choose-shuffle" title="gwy_rand_gen_set_choose_shuffle ()">gwy_rand_gen_set_choose_shuffle</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet">GwyRandGenSet</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libgwyddion/gwyddion.h>
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.description"></a><h2>Description</h2>
<p><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> represents a set of pseudoradnom number generators
initialised together, but each producing a different sequence of numbers.
This is useful when you use pseudorandom number generators to optionally
randomize several different things. Using a common generator would require
always generating exactly the same number of random numbers, even for
quantities you do not want randomized, in order to keep the random number
sequences stable.</p>
<p><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> also provides functions sample a few common distributions
such as Gaussian or exponential. It should be noted that the individual
sampling functions may advance the generator state differently. This means</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">x </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-rand-gen-set-gaussian">gwy_rand_gen_set_gaussian</a></span><span class="symbol">(</span><span class="normal">rngset</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">);</span>
<span class="normal">y </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-rand-gen-set-gaussian">gwy_rand_gen_set_gaussian</a></span><span class="symbol">(</span><span class="normal">rngset</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
may produce a different value of <em class="parameter"><code>y</code></em>
than</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">x </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-rand-gen-set-exponential">gwy_rand_gen_set_exponential</a></span><span class="symbol">(</span><span class="normal">rngset</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">);</span>
<span class="normal">y </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-rand-gen-set-gaussian">gwy_rand_gen_set_gaussian</a></span><span class="symbol">(</span><span class="normal">rngset</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
even if the initial generator state was the same.</p>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-rand-gen-set-new"></a><h3>gwy_rand_gen_set_new ()</h3>
<pre class="programlisting"><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="returnvalue">GwyRandGenSet</span></a> *
gwy_rand_gen_set_new (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
<p>Creates a new set of pseudorandom number generators.</p>
<p>The generators are initialised to random states.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The number of generators.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-new.returns"></a><h4>Returns</h4>
<p> A new set of pseudorandom number generators.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-init"></a><h3>gwy_rand_gen_set_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_rand_gen_set_init (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> seed</code></em>);</pre>
<p>Initialises a set of pseudorandom number generators using an integer seed.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>seed</p></td>
<td class="parameter_description"><p>The seed used to initialise the generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-free"></a><h3>gwy_rand_gen_set_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_rand_gen_set_free (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>);</pre>
<p>Destroys a set of pseudorandom number generators.</p>
<p>If you obtained individual generators using <a class="link" href="libgwyddion-GwyRandGenSet.html#gwy-rand-gen-set-rng" title="gwy_rand_gen_set_rng ()"><code class="function">gwy_rand_gen_set_rng()</code></a> you may
not use them any more after calling this function.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-rng"></a><h3>gwy_rand_gen_set_rng ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Random-Numbers.html#GRand"><span class="returnvalue">GRand</span></a> *
gwy_rand_gen_set_rng (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>Obtains a single generator from a set of pseudorandom number generators.</p>
<p>The generator can be used to produce random numbers in any way for which you
find the provided methods insufficient. However, if you reseed it manually,
number sequence stability will be broken because sampling functions may keep
persistent information between calls.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-rng.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-rng.returns"></a><h4>Returns</h4>
<p> A pseudorandom number generator from <em class="parameter"><code>rngset</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-range"></a><h3>gwy_rand_gen_set_range ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_range (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> lower</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> upper</code></em>);</pre>
<p>Samples from a uniform distribution over given interval using one generator
from a pseudorandom number generator set.</p>
<p>The generated number always lies inside the interval, neither endpoint value
is ever returned. Note if there are no representable real numbers between
<em class="parameter"><code>lower</code></em>
and <em class="parameter"><code>upper</code></em>
this function will never terminate. You must ensure
<em class="parameter"><code>upper</code></em>
is sufficiently larger than <em class="parameter"><code>lower</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lower</p></td>
<td class="parameter_description"><p>Lower limit of the range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>upper</p></td>
<td class="parameter_description"><p>Upper limit of the range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-range.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-uniform"></a><h3>gwy_rand_gen_set_uniform ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_uniform (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> sigma</code></em>);</pre>
<p>Samples from a centered uniform distribution using one generator from a
pseudorandom number generator set.</p>
<p>The mean value of the distribution is zero, the rms value is given by
<em class="parameter"><code>sigma</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-uniform.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sigma</p></td>
<td class="parameter_description"><p>Rms of the distribution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-uniform.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-gaussian"></a><h3>gwy_rand_gen_set_gaussian ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_gaussian (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> sigma</code></em>);</pre>
<p>Samples from a centered Gaussian distribution using one generator from a
pseudorandom number generator set.</p>
<p>The mean value of the distribution is zero, the rms value is given by
<em class="parameter"><code>sigma</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-gaussian.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sigma</p></td>
<td class="parameter_description"><p>Rms of the distribution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-gaussian.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-exponential"></a><h3>gwy_rand_gen_set_exponential ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_exponential (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> sigma</code></em>);</pre>
<p>Samples from a centered exponential distribution using one generator from a
pseudorandom number generator set.</p>
<p>The mean value of the distribution is zero, the rms value is given by
<em class="parameter"><code>sigma</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-exponential.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sigma</p></td>
<td class="parameter_description"><p>Rms of the distribution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-exponential.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-triangular"></a><h3>gwy_rand_gen_set_triangular ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_triangular (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> sigma</code></em>);</pre>
<p>Samples from a centered triangular distribution using one generator from a
pseudorandom number generator set.</p>
<p>The mean value of the distribution is zero, the rms value is given by
<em class="parameter"><code>sigma</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-triangular.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sigma</p></td>
<td class="parameter_description"><p>Rms of the distribution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-triangular.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-multiplier"></a><h3>gwy_rand_gen_set_multiplier ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_multiplier (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> range</code></em>);</pre>
<p>Samples from a multiplier distribution using one generator from a
pseudorandom number generator set.</p>
<p>The multiplier distribution is triangular distribution centered at 1,
with values from [1-<em class="parameter"><code>range</code></em>
, 1+<em class="parameter"><code>range</code></em>
].</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-multiplier.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>range</p></td>
<td class="parameter_description"><p>Half-range of the distribution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-multiplier.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-double"></a><h3>gwy_rand_gen_set_double ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gwy_rand_gen_set_double (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>Samples uniform distribution over [0,1) using one generator from a
pseudorandom number generator set.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-double.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-double.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-int"></a><h3>gwy_rand_gen_set_int ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
gwy_rand_gen_set_int (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>Samples a 32bit integer using a generator from a pseudorandom number
generator set.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-int.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-int.returns"></a><h4>Returns</h4>
<p> A pseudorandom number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rand-gen-set-choose-shuffle"></a><h3>gwy_rand_gen_set_choose_shuffle ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *
gwy_rand_gen_set_choose_shuffle (<em class="parameter"><code><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> *rngset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> nchoose</code></em>);</pre>
<p>Chooses randomly a subset of indices, in random order.</p>
<p>The function creates an array containing integers from the set
{0, 1, 2, ..., n-1}, each at most once, in random order.</p>
<p>To generate a permutation, simply pass <em class="parameter"><code>nchoose</code></em>
equal to <em class="parameter"><code>n</code></em>
.</p>
<div class="refsect3">
<a name="gwy-rand-gen-set-choose-shuffle.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rngset</p></td>
<td class="parameter_description"><p>A set of pseudorandom number generators.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of a generator from the set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Total number of possible indices.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nchoose</p></td>
<td class="parameter_description"><p>Number of values to choose (at most equal to <em class="parameter"><code>n</code></em>
). It is permitted
to pass zero; the function returns <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-rand-gen-set-choose-shuffle.returns"></a><h4>Returns</h4>
<p> A newly allocated array of <em class="parameter"><code>nchoose</code></em>
integers.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-46.html#api-index-2.46">2.46</a></p>
</div>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyRandGenSet.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwyRandGenSet"></a><h3>GwyRandGenSet</h3>
<pre class="programlisting">typedef struct _GwyRandGenSet GwyRandGenSet;</pre>
<p><a class="link" href="libgwyddion-GwyRandGenSet.html#GwyRandGenSet" title="GwyRandGenSet"><span class="type">GwyRandGenSet</span></a> is an opaque data structure and should be only manipulated
with the functions below.</p>
<p class="since">Since: <a class="link" href="api-index-2-37.html#api-index-2.37">2.37</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|