Difference between revisions of "LlFrand"

From Second Life Wiki
Jump to navigation Jump to search
(Edited the code and text to reflect Jodi's verification of the bracket notation)
Line 28: Line 28:


// Sometimes it is useful to get a random integer over a given range.  This is a suprisingly tricky and emotive subject
// Sometimes it is useful to get a random integer over a given range.  This is a suprisingly tricky and emotive subject
// and has caused endless discussion on the scripting groups.
// The primary cause of probability errors when employing llFrand is to have a varying bin size on the edges of the range.
//
// As the bracket notation indicates, [0.0,'''mag'''), the function is inclusive of the 0.0 and exclusive of the entered value.
// Because an LSL floating point number is only a subset of real numbers and does not have infinite granularity, this schema
// will work for any float greater than float t = 0.000000000000000000000000000000000000000000001; at which value the function will
// return only zero.  At a float beyond this, a math error occurs.
// The non-inclusion of the entered value has also been verified impirically by Jody Palmer in a 215,000,000 case trial.
 
// Random integer generator
// Contributed by Mephistopheles Thalheimer, original function posited by Hg Beeks


// The random number given by llFrand(); does NOT include the stated float.
// and has caused endless discussion on the scripting groups. 
// Because an LSL floating point number is only a subset of real numbers and does not have infinite granularity,
// in most solutions one integer output will be over-represented by a tiny amount or else an integer will be produced
// outside of the range.  The probability of over-representation or over extension for a given call, is inversely
// proportional to the range and is typically a maximum of 1 / 8388608 when the range is 1.
// Here are some solutions.
// Random integer generator
// Contributed by Mephistopheles Thalheimer
// Returns a psuedo-random integer in the range of min to max inclusive.
// Returns a psuedo-random integer in the range of min to max inclusive.


// Rationale: Expands the range by 1.0 to ensure equal bin spacing on ends relative to the middle of  
// Rationale: Expands the range by 1.0 to ensure equal bin spacing on ends relative to the middle of  
// the range and then uses an integer cast to round towards zero.  The while loop discards the
// the range and then uses an integer cast to round towards zero.   
// improbable outlier that occurs when llFrand( n ) == n.


// Caveats:  This function is not range checked and will fail if max < min
// Caveats:  This function is not range checked and will fail if max < min
//          It is serious overkill as per Hg discussion below.


integer random_integer( integer min, integer max )
integer random_integer( integer min, integer max )
{
{
   integer r;
   return min + (integer)( llFrand( max - min + 1 ) );
  do { r = min + (integer)( llFrand( max - min + 1 ) ); } while( r == max + 1 ) ;  // Non recursive catch of the improbable
  return r;
}
}
// Random integer generator and discussion
// Contributed by Hg Beeks
// Returns a psuedo-random integer in the range of min to max inclusive but is slightly more efficient ( but with risk ) to Mephs above.
// While it IS technically possible to get the maximum value in llFrand and cause this to return a value above the range,
// the likelyhood of this occuring is 1:1,000,000 for every whole number in the range - You will have a 1:5,000,000 chance of
// getting 5 if doing llFrand(5), at the very least likelyhood. Testing also seems to imply that llFrand goes past the six-digit
// lead that float returns, which means that the likelyhood could, in fact, be lower than this. However, decreasing
// the +1 to .999999 in fact affects the probability and would make the highest value you want just a smidgen less likely.
integer fast_random_integer( integer min, integer max )
{
  return min + (integer)llFrand( max - min + 1 );
}


default
default
Line 86: Line 65:
         integer n1 = random_integer( 2, 8 ); // Return a random number between 2 and 8
         integer n1 = random_integer( 2, 8 ); // Return a random number between 2 and 8
         llSay( PUBLIC_CHANNEL, "I chose a " + (string)n1 );
         llSay( PUBLIC_CHANNEL, "I chose a " + (string)n1 );
        integer n2 = fast_random_integer( 3, 10 ); // Returns a (slightly faster) random integer between 3 and 10.
        llSay( PUBLIC_CHANNEL, "I chose a " + (string)n2 );
   
   
     }
     }
Line 111: Line 87:




integer fast_random_integer( integer min, integer max )
integer random_integer( integer min, integer max )
{
{
   return min + (integer)llFrand( max - min + 1 );
   return min + (integer)llFrand( max - min + 1 );
Line 130: Line 106:
integer    MAX            = 5;        // The maximum integer you want
integer    MAX            = 5;        // The maximum integer you want


integer    NUMBER_OF_TRYS = 10000;    // The bigger the better.. but slower
integer    NUMBER_OF_TRIES = 10000;    // The bigger the better.. but slower


default
default
Line 163: Line 139:
                                                     // Note the output on this one has about 0.5 expected hits on the first and last bin
                                                     // Note the output on this one has about 0.5 expected hits on the first and last bin
             //r = random_integer( MIN, MAX );
             //r = random_integer( MIN, MAX );
            //r = fast_random_integer( MIN, MAX );
              
              
             if( r > MAX || r < MIN )
             if( r > MAX || r < MIN )

Revision as of 07:36, 10 February 2009

Summary

Function: float llFrand( float mag );
0.0 Forced Delay
10.0 Energy

Returns a float that is pseudo random number in the range [0.0,mag) or (mag, 0.0].
The sign of mag matches the return.

• float mag Any valid float value

Specification

returns a pseudo random number in range [0.0, mag) or (mag, 0.0], depending upon the sign of mag.


llFrand(); generates a random number, between 0.000000 and the preset float minus 0.000001. Example : llFrand(2); will generate a float between 0.000000 (this one included) and 1.999999. So 2.000000 is NOT included !!! I ran a test and uses llFrand 215,000,000 times to check out. --Jody Palmer--

Caveats

The random number generator is not a source of entropy.

Examples

<lsl>

// Tosses a coin, giving a *near* 50:50 chance of a result.

integer coin_toss() {

 if( llFrand(1.) < .5 ) return TRUE;
 return FALSE;

}

// Sometimes it is useful to get a random integer over a given range. This is a suprisingly tricky and emotive subject // and has caused endless discussion on the scripting groups. // The primary cause of probability errors when employing llFrand is to have a varying bin size on the edges of the range. // // As the bracket notation indicates, [0.0,mag), the function is inclusive of the 0.0 and exclusive of the entered value. // Because an LSL floating point number is only a subset of real numbers and does not have infinite granularity, this schema // will work for any float greater than float t = 0.000000000000000000000000000000000000000000001; at which value the function will // return only zero. At a float beyond this, a math error occurs. // The non-inclusion of the entered value has also been verified impirically by Jody Palmer in a 215,000,000 case trial.

// Random integer generator // Contributed by Mephistopheles Thalheimer, original function posited by Hg Beeks

// Returns a psuedo-random integer in the range of min to max inclusive.

// Rationale: Expands the range by 1.0 to ensure equal bin spacing on ends relative to the middle of // the range and then uses an integer cast to round towards zero.

// Caveats: This function is not range checked and will fail if max < min

integer random_integer( integer min, integer max ) {

 return min + (integer)( llFrand( max - min + 1 ) );

}

default {

   touch_start(integer total_number)
   {
       // When touched, say "Heads" with probability 0.5, 
       // otherwise, say "Tails."
       if ( coin_toss() )
           llSay(0, "Heads");
       else
           llSay(0, "Tails");

       integer n1 = random_integer( 2, 8 ); // Return a random number between 2 and 8
       llSay( PUBLIC_CHANNEL, "I chose a " + (string)n1 );

   }

}

</lsl>

<lsl>

// Simple integer random number tester // Contributed by Mephistopheles Thalheimer

// This is a random number tester designed to give a quick visual explanation and proof of why some // random integer functions just do not work. // In general, with any random number generator, if you can see a pattern emerging, then chances are, // the function is not random.

// The test case given "silly_random_integer( .. )" shows the type of pitfalls that can happen. Superficially, // it would seem like a good candidate. I thought so, and in fact mooted it in a discussion, however, a bit of thought reveals // that the first and last bin are only collecting rounded results from half the float space as the rest of the integers. // They are therefore under-represented in output, and the generator is flawed.


integer random_integer( integer min, integer max ) {

 return min + (integer)llFrand( max - min + 1 );

}

integer silly_random_integer( integer min, integer max ) {

 return min + (integer)( llRound( llFrand( max - min ) ) );  // Looks good, but does not work

}


// Simple integer random number tester // Contributed by Mephistopheles Thalheimer

list bins;

integer MIN = 2; // The minimum integer you want integer MAX = 5; // The maximum integer you want

integer NUMBER_OF_TRIES = 10000; // The bigger the better.. but slower

default {

   state_entry()
   {
       llSay( PUBLIC_CHANNEL, "Bin tester ready.");
       bins = [];
   }
   touch_start(integer total_number)
   {
       
       llSay( PUBLIC_CHANNEL, "Started, be patient" );
       
       integer i;
       integer r;
       
       integer range = MAX - MIN;
       
       for( i = 0; i <= range; ++i )
       {
           bins += [ 0 ];    
       }
       
       integer v;
       integer out_of_range;
       
       for( i = 0; i < NUMBER_OF_TRYS; ++i )
       {
           r = silly_random_integer( MIN, MAX );   // Replace this with the function you are testing
                                                   // Note the output on this one has about 0.5 expected hits on the first and last bin
           //r = random_integer( MIN, MAX );
           
if( r > MAX

Useful Snippets

Pseudo-random_Number_Generator - Suitable for apps which require repeatable results that feel random.

Notes

The random number generator is not a source of entropy.

The sequence of random numbers are shared across the entire process, and not independently seeded. Therefore, the pseudo random number generation is not suitable for any application which requires completely predictable or completely unpredictable results.

See Also

Functions

•  llListRandomize

Deep Notes

Signature

function float llFrand( float mag );

--Jody Palmer 17:14, 19 January 2009 (UTC)