Jump to content

LlGetListLength

From OSgrid Wiki
Revision as of 22:33, 31 December 2017 by Osgridadmin (talk | contribs) (Created page with "==Function: integer llGetListLength( list src );== Returns an integer that is the number of elements in the list src. <br> • list src <br> <br> Caveats <br> • The LSL...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Function: integer llGetListLength( list src );

Returns an integer that is the number of elements in the list src.
• list src

Caveats
• The LSL compiler will not optimize the condition, it will not hoisting this function out of the condition. Unless strictly necessary all work with strings, keys and lists should be manually hoisted and performed outside of the loop. See Best Practices for more details.

Examples

<source lang="lsl">

//Basic usage default {

   state_entry()
   {
       list l = ["one", "two", "three"];
       integer i = llGetListLength(l);
       llOwnerSay("there are " + (string)i + " entries in the list");
   }

} </source>


Notes
Best Practices

When using list length to help you loop through a list, it is better to determine the length first, then start your loop:

<source lang="lsl">

integer i = 0; integer length = llGetListLength(mylist); for (; i < length; ++i) {

   llSay(0, llList2String(mylist, i));

} </source>


The following example is to illustrate what not to do, it calculates the length in the "for" loop and is inefficient because the length gets recalculated at each pass through the loop. This should only ever be done if the list is in fact changing (in length) with each iteration of the loop[1].

<source lang="lsl">

integer i; for (i = 0; i < llGetListLength(mylist); ++i) {

   llSay(0, llList2String(mylist, i));

} </source>

Optimizations
A faster and lighter (in bytecode) way to determine the length of a list is to do a not-equals compare with a null list. This works because the list not-equals compare returns the difference between the lengths.

<source lang="lsl">

list in; integer len_in = llGetListLength(in); integer flen_in = (in != []); //flen_in and len_in will be the same

integer neg_len_in = -llGetListLength(in); integer fneg_len_in = ([] != in); //fneg_len_in and neg_len_in will be the same </source>


See Also
Functions
• llListStatistics – LIST_STAT_NUM_COUNT – Returns the number of integers and floats in the list
• llStringLength – Returns the number of characters in a string.

Deep Notes
Source
'linden\indra\lscript\lscript_library\lscript_alloc.cpp' @ lsa_cmp_lists
'linden\indra\lscript\lscript_execute\lscript_execute.cpp' @ list_list_operation

Footnotes
1. ^ Recalculating the length is slow because the VM duplicates the entire list (including the values) when it is pushed on the stack (so it can be popped off the stack when the length is calculated).