$Random Seed: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
{{DISPLAYTITLE:$Random_Seed}}
{{DISPLAYTITLE:$Random_Seed}}
<span class="pageSubtitle">Build seed specifying series of $RANDOM results</span>
<span class="pageSubtitle">Build seed specifying series of <var>$RANDOM</var> results</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Random_Seed function is the [[RandomNumberGenerator class]].</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$Random_Seed</var> function is the [[RandomNumberGenerator class]].</p>


This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible.  
This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by <var>$Random</var> is reproducible.  


<var>$Random_Seed</var> accepts two required arguments and returns zero.  
<var>$Random_Seed</var> accepts two required arguments and returns zero.  
Line 10: Line 10:
The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144.  
The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144.  


The second argument specifies a number that determines the $Random series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.
The second argument specifies a number that determines the <var>$Random</var> series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.


==Syntax==
==Syntax==
Line 17: Line 17:
<p class="caption">$Random_Seed Function
<p class="caption">$Random_Seed Function
</p>
</p>
<p class="caption">%SEED is initialized for a series of $Random results that depends on '''seed_value'''.</p>
<p class="caption">%SEED is initialized for a series of <var>$Random</var> results that depends on '''seed_value'''.</p>


If any argument is invalid or omitted, the request is cancelled.  
If any argument is invalid or omitted, the request is cancelled.  


See the description of $Random for examples of the use of $Random_Seed.
See the description of <var>$Random</var> for examples of the use of $Random_Seed.


<ul class="smallAndTightList">
<ul class="smallAndTightList">

Revision as of 17:43, 19 October 2012

Build seed specifying series of $RANDOM results

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Random_Seed function is the RandomNumberGenerator class.

This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible.

$Random_Seed accepts two required arguments and returns zero.

The first argument is a %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144.

The second argument specifies a number that determines the $Random series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000.

Syntax

<section begin="syntax" /> %RESULT = $Random_Seed(%SEED, seed_value) <section end="syntax" />

$Random_Seed Function

%SEED is initialized for a series of $Random results that depends on seed_value.

If any argument is invalid or omitted, the request is cancelled.

See the description of $Random for examples of the use of $Random_Seed.

Products authorizing $Random_Seed