Difference between revisions of "LlList2ListStrided"

From Second Life Wiki
Jump to: navigation, search
m (lsl code tagging)
(added more examples)
Line 4: Line 4:
 
|func_footnote
 
|func_footnote
 
|func_desc
 
|func_desc
|return_text=of all the entries whose index is a multiple of '''stride''' in the range '''start''' to '''end'''.
+
|return_text=of all the entries in the [[List#Strided_lists|strided list]] whose index is a multiple of '''stride''' in the range '''start''' to '''end'''.
 
|spec
 
|spec
 
|caveats
 
|caveats
 
|constants
 
|constants
 
|examples=
 
|examples=
 +
 +
list mylist = [0,1,2,3,4,5,6];
 +
 +
 +
llList2ListStrided(mylist,0,-1,2); //start at first item in list, go to the end, return every 2nd item
 +
 +
returns: [0,2,4,6]
 +
 +
 +
llList2ListStrided(mylist,1,-1,2); //start at second item in list, go to the end, return every 2nd item
 +
 +
returns: [2,4,6];
 +
 +
 +
llList2ListStrided(mylist,2,-1,2); //start at third item in list, go to the end, return every 2nd item
 +
 +
returns: [2,4,6];
 +
 
<lsl>
 
<lsl>
 
list menu = ["1", "one", "2", "two", "3", "three"];
 
list menu = ["1", "one", "2", "two", "3", "three"];
Line 37: Line 55:
 
|also_tests
 
|also_tests
 
|also_articles
 
|also_articles
|notes
+
|notes=
 +
 
 +
To get every first element in a "collection of data" in a strided list:
 +
 
 +
<pre>list ListStridedFirstElement(list src, integer start, integer end, integer stride) {
 +
    return llList2ListStrided(llList2List(src, start, end), 0, end, stride);
 +
}</pre>
 +
 
 +
 
 +
To get every second element in a "collection of data" in a strided list:
 +
 
 +
llList2ListStrided(llDeleteSubList(src, 0, 0), 0, -1, 3);
 +
 
 +
 
 +
To get every second element in a "collection of data" in a strided list:
 +
 
 +
llList2ListStrided(llDeleteSubList(src, 0, 1), 0, -1, 3);
 +
 
 
|permission
 
|permission
 
|negative_index
 
|negative_index

Revision as of 11:06, 13 July 2008

Summary

Function: list llList2ListStrided( list src, integer start, integer end, integer stride );

Returns a list of all the entries in the strided list whose index is a multiple of stride in the range start to end.

• list src
• integer start start index
• integer end end index
• integer stride

start, end & stride support negative indexes.

Specification

Index Positive Negative
First 0 -length
Last length - 1 -1

Indexes

  • Positive indexes count from the beginning, the first item being indexed as 0, the last as (length - 1).
  • Negative indexes count from the far end, the first item being indexed as -length, the last as -1.

Caveats

  • If either start, end or stride are out of bounds the script continues to execute without an error message.
  • start & end will form an exclusion range when start is past end (Approximately: start > end).
All Issues ~ Search JIRA for related Bugs

Examples

list mylist = [0,1,2,3,4,5,6];


llList2ListStrided(mylist,0,-1,2); //start at first item in list, go to the end, return every 2nd item

returns: [0,2,4,6]


llList2ListStrided(mylist,1,-1,2); //start at second item in list, go to the end, return every 2nd item

returns: [2,4,6];


llList2ListStrided(mylist,2,-1,2); //start at third item in list, go to the end, return every 2nd item

returns: [2,4,6];

<lsl> list menu = ["1", "one", "2", "two", "3", "three"]; default {

   state_entry()
   {
       llListen(10, "", llGetOwner(), "");
   }
   touch_start(integer detected)
   {
       list buttons = llList2ListStrided(menu, 0, -1, 2);
       llDialog(llDetectedKey(0), "choose a number", buttons, 10);
   }
   listen(integer channel, string obj, key id, string message)
   {
       integer index = llListFindList(menu, [message]);
       if (index != -1)
       {
           llOwnerSay("you chose " + llList2String(menu, index + 1) + " (" + message + ")");
       }
   }

}

</lsl>

Notes

Ranges & Indexes

The easiest way to explain how ranges works is to make all indexes positive. Negative indexes are just a way of counting from the tail end instead of the beginning, all negative indexes have a corresponding equivalent positive index (assuming they are in range). Positive indexes past length (after the last index), or negative indexes past the beginning (before the first index) are valid and the effects are predictable and reliable: the entries are treated as if they were there but were removed just before output.

  • If start <= end then the range operated on starts at start and ends at end. [start, end]
  • Exclusion range: If start > end then the range operated on starts at 0 and goes to end and then starts again at start and goes to -1. [0, end] + [start, -1]
    • If end is a negative index past the beginning, than the operating range would be [start, -1].
    • If end is a positive index past the end, than the operating range would be [0, end].
    • If both start and end are out of bounds than the function would have no operating range (effectively inverting what the function is supposed to do).

See negative indexes for more information. To get every first element in a "collection of data" in a strided list:

list ListStridedFirstElement(list src, integer start, integer end, integer stride) {
     return llList2ListStrided(llList2List(src, start, end), 0, end, stride);
}


To get every second element in a "collection of data" in a strided list:

llList2ListStrided(llDeleteSubList(src, 0, 0), 0, -1, 3);


To get every second element in a "collection of data" in a strided list:

llList2ListStrided(llDeleteSubList(src, 0, 1), 0, -1, 3);

See Also

Articles

•  Negative Index

Deep Notes

Search JIRA for related Issues

Signature

function list llList2ListStrided( list src, integer start, integer end, integer stride );