Difference between revisions of "LlListRandomize"

From Second Life Wiki
Jump to navigation Jump to search
(Example won't compile)
m (<lsl> tag to <source>)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/stride|stride}}
|sort=ListRandomize|func=llListRandomize
|sort=ListRandomize|func=llListRandomize
|func_id=197|func_sleep=0.0|func_energy=10.0
|func_id=197|func_sleep=0.0|func_energy=10.0
Line 7: Line 8:
|p2_type=integer
|p2_type=integer
|p2_name=stride
|p2_name=stride
|p2_desc=How many list entries to keep next to each other during the randomization.
|return_type=list
|return_type=list
|return_text=which is a randomized permutation of '''src'''.
|return_text=which is a randomized permutation of {{LSLP|src}}.
|spec=
|spec=
When you want to randomize the position of every list element, specify a stride of 1.
When you want to randomize the position of every list element, specify a stride of 1. This is perhaps the setting most used.


If the stride is not a factor of the list length, the '''src''' list is returned. In other words, src.length() % stride must be 0.
If the stride is not a factor of the list length, the {{LSLP|src}} list is returned. In other words, <code>llGetListLength({{LSLPT|src}}) % stride</code> must be 0.


Conceptually, the algorithm selects src.length()/stride buckets, and then for each bucket swaps it the contents with another bucket.
Conceptually, the algorithm selects <code>llGetListLength({{LSLPT|src}}) / stride</code> buckets, and then for each bucket swaps in the contents with another bucket.
|caveats=
|caveats=
|examples=
|examples=
<pre>
<source lang="lsl2">list dice = ["2", "4", "1", "6", "3", "5"];
list dice = ["2", "4", "1", "6", "3", "5"];
 
list shuffled = llListRandomize(dice, 1);
default
llOwnerSay(llList2CSV(shuffled));
{
</pre>
    touch_start(integer num_detected) {
        list shuffled = llListRandomize(dice, 1);
        llOwnerSay(llList2CSV(shuffled));
    }
}</source>
 
 
<source lang="lsl2">list list01 = ["Cold", "pizza", "in", "the", "early", "morning"];
 
list list_random = llListRandomize(list01, 2);</source>
 
<tt>list_random</tt> could be:
 
# ["Cold", "pizza", "in", "the", "early", "morning"]
# ["Cold", "pizza", "early", "morning", "in", "the"]
# ["in", "the", "Cold", "pizza", "early", "morning"]
# ["in", "the", "early", "morning", "Cold", "pizza"]
# ["early", "morning", "Cold", "pizza", "in", "the"]
# ["early", "morning", "in", "the", "Cold", "pizza"]
 
Notice that two adjacent elements from the original list are always kept together, because the stride of 2 was specified.
 
<source lang="lsl2">list list_random = llListRandomize(list01, 6);</source>
 
list_random in this instance is the original list, exactly in the order it already was, because we told it to keep every set of six elements together, and there are only six elements in the list.
|constants
|constants
|helpers
|helpers
Line 31: Line 55:
|also_articles
|also_articles
|also_footer
|also_footer
|notes
|notes=Bear in mind that the source list will remain unchanged. Instead, a new list will be produced. So, it's important that you capture this with a variable (unless you are acting directly on the results.)
|mode
|mode
|deprecated
|deprecated

Latest revision as of 11:15, 22 January 2015

Summary

Function: list llListRandomize( list src, integer stride );
0.0 Forced Delay
10.0 Energy

Returns a list which is a randomized permutation of src.

• list src A list you want to randomize.
• integer stride number of entries per stride, if less than 1 it is assumed to be 1

This function supports Strided Lists.

Specification

When you want to randomize the position of every list element, specify a stride of 1. This is perhaps the setting most used.

If the stride is not a factor of the list length, the src list is returned. In other words, llGetListLength(src) % stride must be 0.

Conceptually, the algorithm selects llGetListLength(src) / stride buckets, and then for each bucket swaps in the contents with another bucket.

Examples

list dice = ["2", "4", "1", "6", "3", "5"];

default
{
    touch_start(integer num_detected) {
        list shuffled = llListRandomize(dice, 1);
        llOwnerSay(llList2CSV(shuffled));
    }
}


list list01 = ["Cold", "pizza", "in", "the", "early", "morning"];

list list_random = llListRandomize(list01, 2);

list_random could be:

  1. ["Cold", "pizza", "in", "the", "early", "morning"]
  2. ["Cold", "pizza", "early", "morning", "in", "the"]
  3. ["in", "the", "Cold", "pizza", "early", "morning"]
  4. ["in", "the", "early", "morning", "Cold", "pizza"]
  5. ["early", "morning", "Cold", "pizza", "in", "the"]
  6. ["early", "morning", "in", "the", "Cold", "pizza"]

Notice that two adjacent elements from the original list are always kept together, because the stride of 2 was specified.

list list_random = llListRandomize(list01, 6);
list_random in this instance is the original list, exactly in the order it already was, because we told it to keep every set of six elements together, and there are only six elements in the list.

Notes

Bear in mind that the source list will remain unchanged. Instead, a new list will be produced. So, it's important that you capture this with a variable (unless you are acting directly on the results.)

See Also

Functions

•  llListSort
•  llFrand

Deep Notes

Source

lsa_randomize(): 'linden\indra\lscript\lscript_library\lscript_alloc.cpp'

Signature

function list llListRandomize( list src, integer stride );