[Plplot-cvs] SF.net SVN: plplot:[9279] trunk/doc/docbook/src

[<and...@us...>]

Revision: 9279
          http://plplot.svn.sourceforge.net/plplot/?rev=9279&view=rev
Author:   andrewross
Date:     2009-01-08 14:49:09 +0000 (Thu, 08 Jan 2009)

Log Message:
-----------
Update documentation to include plrandd and plseed.

Modified Paths:
--------------
    trunk/doc/docbook/src/api.xml
    trunk/doc/docbook/src/plplotdoc.xml.in

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2009-01-08 14:30:16 UTC (rev 9278)
+++ trunk/doc/docbook/src/api.xml	2009-01-08 14:49:09 UTC (rev 9279)
@@ -8528,6 +8528,43 @@
 
   </sect1>
 
+  <sect1 id="plrandd" renderas="sect3">
+    <title>
+      <function>plrandd</function>: Random number generator 
+      returning a real random number in the range [0,1].
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plrandd</function>
+	  </funcdef>
+	  <paramdef></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Random number generator returning a real random number in the 
+      range [0,1]. The generator is based on the Mersenne Twister. 
+      Most languages / compilers provide their own random number generator, 
+      and so this is provided purely for convenience and to give a
+      consistent random number generator across all languages supported 
+      by PLplot. This is particularly useful for comparing results 
+      from the test suite of examples.
+    </para>
+
+    <para>
+      Redacted form: <function>plrandd()</function>
+    </para>
+
+    <para>
+      This function is used in examples 17,21.
+    </para>
+
+  </sect1>
+
   <sect1 id="plreplot" renderas="sect3">
     <title>
       <function>plreplot</function>: Replays contents of plot buffer to
@@ -10416,6 +10453,50 @@
 
   </sect1>
 
+  <sect1 id="plseed" renderas="sect3">
+    <title>
+      <function>plseed</function>: Set seed for internal random 
+      number generator.
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plseed</function>
+	  </funcdef>
+	  <paramdef><parameter>seed</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+    Set the seed for the internal random number generator. See &plrandd; 
+    for further details.
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>seed</parameter>
+	  (<literal>unsigned int</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Seed for random number generator.
+	  </para>
+	</listitem>
+      </varlistentry>
+    <para>
+      Redacted form: <function>plseed(seed)</function>
+    </para>
+
+    <para>
+      This function is used in example 21.
+    </para>
+
+  </sect1>
+
   <sect1 id="plsesc" renderas="sect3">
     <title>
       <function>plsesc</function>: Set the escape character for text strings

Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in	2009-01-08 14:30:16 UTC (rev 9278)
+++ trunk/doc/docbook/src/plplotdoc.xml.in	2009-01-08 14:49:09 UTC (rev 9279)
@@ -169,6 +169,7 @@
 <!ENTITY plprec '<link linkend="plprec"><function>plprec</function></link>'>
 <!ENTITY plpsty '<link linkend="plpsty"><function>plpsty</function></link>'>
 <!ENTITY plptex '<link linkend="plptex"><function>plptex</function></link>'>
+<!ENTITY plrandd '<link linkend="plrandd"><function>plrandd</function></link>'>
 <!ENTITY plreplot '<link linkend="plreplot"><function>plreplot</function></link>'>
 <!ENTITY plResetOpts '<link linkend="plResetOpts"><function>plResetOpts</function></link>'>
 <!ENTITY plrgbhls '<link linkend="plrgbhls"><function>plrgbhls</function></link>'>
@@ -189,6 +190,7 @@
 <!ENTITY plsdiori '<link linkend="plsdiori"><function>plsdiori</function></link>'>
 <!ENTITY plsdiplt '<link linkend="plsdiplt"><function>plsdiplt</function></link>'>
 <!ENTITY plsdiplz '<link linkend="plsdiplz"><function>plsdiplz</function></link>'>
+<!ENTITY plseed '<link linkend="plseed"><function>plseed</function></link>'>
 <!ENTITY plsesc '<link linkend="plsesc"><function>plsesc</function></link>'>
 <!ENTITY plsescfortran95 '<link linkend="plsescfortran95"><function>plsescfortran95</function></link>'>
 <!ENTITY plsescfortran77 '<link linkend="plsescfortran77"><function>plsescfortran77</function></link>'>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.