ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/CEERAN0.htm

180 lines
5.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Basic Random Number Generation (CEERAN0) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- ILE5A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 25 Feb 1999 at 15:07:42 -->
<!-- YYMMDD USERID Change description -->
<!--Edited by Kersten Oct 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>Basic Random Number Generation (CEERAN0) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top">1</td>
<td align="left" valign="top" width="30%">seed</td>
<td align="left" valign="top" width="30%">I/O</td>
<td align="left" valign="top" width="30%">INT4</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">random_no</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">FLOAT8</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="30%">fc</td>
<td align="left" valign="top" width="30%">Output</td>
<td align="left" valign="top" width="30%">FEEDBACK</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QLEMF<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Basic Random Number Generation (CEERAN0) API generates a sequence of
uniform pseudorandom numbers between 0 and 1 using the multiplicative
congruential method with a user-specified seed.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>seed (I/O)</strong></dt>
<dd>A 32-bit binary integer representing an initial value used to generate
random numbers. It must be a variable; that is, it cannot be an input-only
parameter. The valid range is 0 to 2&nbsp;147&nbsp;483&nbsp;646.
<p>If the value of the seed parameter is 0, the seed is generated from the
current Greenwich Mean Time.</p>
<p>On return, CEERAN0 changes the value of <em>seed</em> so that it may be used
as the new seed in the next call.</p>
</dd>
<dt><strong>random_no (output)</strong></dt>
<dd>A 64-bit double floating-point pseudorandom number with a value between 0
and 1, exclusive. If <em>seed</em> is not valid, <em>random_no</em> is set to
-1 and CEERAN0 ends with a nonzero feedback code.</dd>
</dl>
<br>
<h3>Omissible Parameter</h3>
<dl>
<dt><strong>fc (output)</strong></dt>
<dd>A 12-byte feedback code passed by reference. If specified as an argument,
feedback information (a condition token) is returned to the calling procedure.
If not specified, and the requested operation was not successfully completed,
the condition is signaled to the condition manager.</dd>
</dl>
<br>
<h3>Feedback Codes and Conditions</h3>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">CEE0000</td>
<td align="left" valign="top">The API completed successfully</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 00</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE2523</td>
<td align="left" valign="top">UTC not available to generate random seed from
system time</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 10</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE2524</td>
<td align="left" valign="top">Seed value for &amp;1 is not valid</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href="ile1a1.htm">ILE
CEE APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>