Diff for "Arrays"

Differences between revisions 2 and 13 (spanning 11 versions)

The following functions can be used to manipulate an array.

Click each function name in the table below for more details of it, with examples.

Functions

Function	Type	Description
push	array	Adds one or more elements to the end of an array and returns the new length of the array.
pop	array	Removes the last element from an array and returns the value of that element.
unshift	array	Adds one or more elements to the beginning of an array and returns the new length of the array. The other elements in the array are moved from their original position, i, to i+1.
shift	array	Removes the first element from an array and returns that element. The remaining array elements are moved from their original position, i, to i-1.
concat	array	Used to join two or more arrays together.
sort	array	Used to sort the order of array elements.
join	string	Takes an array and joins the elements into one string.
IndexOf	int	Checks for the first instance of an element and returns its position.
lastIndexOf	int	Checks for the last instance of an element and returns its position.
reverse	array	Reverses the order of the elements in the array.
splice	array	Add or remove elements to or from an array, and return the removed elements.
slice	Array	Returns the selected elements in an array, as a new array object.

push

Usage: array.push("x")

Adds one or more elements to the end of an array and returns the new length of the array.

Example:

myArray = ["a","b","c","d"]
echo "myArray = "+myArray
returnVal = myArray.push("e")
echo "myArray = "+myArray
echo "returnVal = "+returnVal

Result:

a,b,c,d
a,b,c,d,e
5

pop

Usage: array.pop()

Removes the last element from an array and returns the value of that element.

Example:

myArray = ["a","b","c","d"]
echo "myArray = "+myArray
returnVal = myArray.pop()
echo "myArray = "+myArray
echo "returnVal = "+returnVal

Result:

a,b,c,d
a,b,c
d

unshift

Usage: array.unshift("x")

Adds one or more elements to the beginning of an array and returns the new length of the array. The other elements in the array are moved from their original position, i, to i+1.

Example:

myArray = ["a","b","c","d"]
echo "myArray = "+myArray
returnVal = myArray.unshift("_")
echo "myArray = "+myArray
echo "returnVal = "+returnVal

Result:

a,b,c,d
_,a,b,c,d
5

shift

Usage: array.shift()

Removes the first element from an array and returns that element. The remaining array elements are moved from their original position, i, to i-1.

Example:

myArray = ["a","b","c","d"]
echo "myArray = "+myArray
returnVal = myArray.shift()
echo "myArray = "+myArray
echo "returnVal = "+returnVal

Result:

a,b,c,d
b,c,d
a

concat

Usage: array.concat()

used to join two or more arrays together.

Example:

boy = ["Luke", "Bob","Jason"]

girl = ["Emma", "Katie", "Chiara"]

uni = ["Jordan","alex","Jessie"]

names = uni.concat(girl,boy)

echo names

Result:

Jordan,alex,Jessie,Emma,Katie,Chiara,Luke,Bob,Jason

sort

Usage: array.sort()

Used to sort the order of array elements.

Example:

array = ["b", "a", "d", "c"]
echo array.sort()

Result:

a,b,c,d

join

Usage: array.join()

Takes an array and joins the elements into one string.

Example:

array = ["a", "b", "c", "d"]
echo array.join()

Result:

"a,b,c,d"

IndexOf

Usage: array.indexOf()

Checks for the first instance of an element and returns its position.

If the item is not found, it will return as "-1"

If the item is present more than once, the indexOf method returns the position of the first occurrence.

Example:

array = ["google", "yahoo", "DuckDuckGo", "Bing"]

echo array.indexOf("DuckDuckGo")

Result:

lastIndexOf

Usage: array.lastIndexOf()

Checks for the last instance of an element and returns its position.

If the item is not found, it will return as "-1"

If the item is present more than once, the lastIndexOf method returns the position of the last occurrence.

Example:

array = ["google", "yahoo", "DuckDuckGo", "Bing","DuckDuckGo","google"] echo array.lastIndexOf("DuckDuckGo")

Result:

reverse

Usage: array.reverse()

Reverses the order of the elements in the array.

Example:

count = ["1","2","3","4","5"]

echo count.reverse()

Result:

5,4,3,2,1

splice

Usage: array.splice()

adds or removes elements to or from an array, and returns the removed elements.

Example:

browser = ["Safari", "IE", "FireFox", "Chrome"] echo browser.splice(2, 2)

Result:

FireFox,chrome
Safari,IE

slice

Usage: array.slice()

The slice() method returns the selected elements in an array, as a new array object.

The slice() method selects the elements starting at the given start argument, and ends at, but does not include, the given end argument.

Example:

browsers = ["IE", "Chrome", "FireFox", "Safari", "SeaMonkey"]

Good = browsers.slice(1, 3)

Result:

Good = Chrome,FireFox

CategoryFunctions

Arrays (last edited 2015-04-17 00:19:57 by LKD70)

-  ⇤ ← Revision 2 as of 2014-01-27 11:41:06 → 
  Size: 2963
  Editor: Inanna
  Comment:
+   ← Revision 13 as of 2014-07-30 20:09:18 → ⇥
  Size: 5847
  Editor: LKD70
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
-These should be written in the following formats: 
 .''variable.function(arguments)'', example - ''myVar.subStr(3,2)'' if your variable name was "myVar" and you wanted to use subStr() to find the 2 characters that begin 3 from the left.

 .''object.function(arguments)'', example - ''city.coords.split(",")'' if you wanted to split the coordinates of your city into an array to determine the seperate x and y values using the split() function.
-Line 11:
+Line 6:
-||<tablewidth="796px" tableheight="123px"#cccccc>'''Function ''' ||<#cccccc>'''Type''' ||<#cccccc>'''Description '''||||<style="text-align:center"> || ||
+||<tablewidth="796px" tableheight="123px"#cccccc>'''Function ''' ||<#cccccc>'''Type''' ||<#cccccc>'''Description ''' ||||<style="text-align:center"> || ||
-Line 16:
+Line 11:
+||[[#concat|concat]] ||array ||Used to join two or more arrays together. ||
||[[#sort|sort]] ||array ||Used to sort the order of array elements. ||
||[[#join|join]] ||string ||Takes an array and joins the elements into one string. ||
||[[#IndexOf|IndexOf]] ||int ||Checks for the first instance of an element and returns its position. ||
||[[#lastIndexOf|lastIndexOf]] ||int ||Checks for the last instance of an element and returns its position. ||
||[[#reverse|reverse]] ||array ||Reverses the order of the elements in the array. ||
||[[#splice|splice]] ||array ||Add or remove elements to or from an array, and return the removed elements. ||
||[[#slice|slice]] ||Array ||Returns the selected elements in an array, as a new array object. ||
-Line 24:
+Line 27:
- .myArray = ["a","b","c","d"]
 .echo "myArray = "+myArray
 .returnVal = myArray.push("e")
 .echo "myArray = "+myArray
 .echo "returnVal = "+returnVal

'''Result:'''
 .a,b,c,d
 .a,b,c,d,e
 .5
+ . myArray = ["a","b","c","d"]
 . echo "myArray = "+myArray
 . returnVal = myArray.push("e")
 . echo "myArray = "+myArray
 . echo "returnVal = "+returnVal

'''Result:'''

 . a,b,c,d
 . a,b,c,d,e
 . 5
-Line 41:
+Line 46:
- .myArray = ["a","b","c","d"]
 .echo "myArray = "+myArray
 .returnVal = myArray.pop()
 .echo "myArray = "+myArray
 .echo "returnVal = "+returnVal

'''Result:'''
 .a,b,c,d
 .a,b,c
 .d
+ . myArray = ["a","b","c","d"]
 . echo "myArray = "+myArray
 . returnVal = myArray.pop()
 . echo "myArray = "+myArray
 . echo "returnVal = "+returnVal

'''Result:'''

 . a,b,c,d
 . a,b,c
 . d
-Line 59:
+Line 65:
- .myArray = ["a","b","c","d"]
 .echo "myArray = "+myArray
 .returnVal = myArray.unshift("_")
 .echo "myArray = "+myArray
 .echo "returnVal = "+returnVal

'''Result:'''
 .a,b,c,d
 ._,a,b,c,d
 .5
+ . myArray = ["a","b","c","d"]
 . echo "myArray = "+myArray
 . returnVal = myArray.unshift("_")
 . echo "myArray = "+myArray
 . echo "returnVal = "+returnVal

'''Result:'''

 . a,b,c,d
 . _,a,b,c,d
 . 5
-Line 76:
+Line 84:
- .myArray = ["a","b","c","d"]
 .echo "myArray = "+myArray
 .returnVal = myArray.shift()
 .echo "myArray = "+myArray
 .echo "returnVal = "+returnVal

'''Result:'''
 .a,b,c,d
 .b,c,d
 .a
+ . myArray = ["a","b","c","d"]
 . echo "myArray = "+myArray
 . returnVal = myArray.shift()
 . echo "myArray = "+myArray
 . echo "returnVal = "+returnVal

'''Result:'''

 . a,b,c,d
 . b,c,d
 . a



= concat =
'''Usage:''' array.concat()

used to join two or more arrays together.

==== Example: ====
boy = ["Luke", "Bob","Jason"]

girl = ["Emma", "Katie", "Chiara"]

uni = ["Jordan","alex","Jessie"]

names = uni.concat(girl,boy)

echo names

==== Result: ====
Jordan,alex,Jessie,Emma,Katie,Chiara,Luke,Bob,Jason


= sort =
'''Usage:''' array.sort()

Used to sort the order of array elements.


'''Example:'''

 . array = ["b", "a", "d", "c"]
 . echo array.sort()

'''Result:'''

 . a,b,c,d


= join =
'''Usage:''' array.join()

Takes an array and joins the elements into one string.


'''Example:'''

 . array = ["a", "b", "c", "d"]
 . echo array.join()

'''Result:'''

 . "a,b,c,d"



= IndexOf =
'''Usage:''' array.indexOf()

Checks for the first instance of an element and returns its position. 

If the item is not found, it will return as "-1" 

If the item is present more than once, the indexOf method returns the position of the first occurrence. 

'''Example:'''

array = ["google", "yahoo", "!DuckDuckGo", "Bing"]

echo array.indexOf("!DuckDuckGo")


'''Result:'''

 . 2



= lastIndexOf =
'''Usage:''' array.lastIndexOf()

Checks for the last instance of an element and returns its position.

If the item is not found, it will return as "-1"

If the item is present more than once, the lastIndexOf method returns the position of the last occurrence.


'''Example:'''

array = ["google", "yahoo", "!DuckDuckGo", "Bing","!DuckDuckGo","google"]
echo array.lastIndexOf("!DuckDuckGo")


'''Result:'''

 . 4


= reverse =
'''Usage:''' array.reverse()

Reverses the order of the elements in the array.

'''Example:'''

count = ["1","2","3","4","5"]

echo count.reverse()


'''Result:'''

 . 5,4,3,2,1

= splice =
'''Usage:''' array.splice()

adds or removes elements to or from an array, and returns the removed elements.

'''Example:'''

browser = ["Safari", "IE", "!FireFox", "Chrome"]
echo browser.splice(2, 2)


'''Result:'''

 . !FireFox,chrome
 . Safari,IE


= slice =
'''Usage:''' array.slice()

The slice() method returns the selected elements in an array, as a new array object.

The slice() method selects the elements starting at the given start argument, and ends at, but does not include, the given end argument.

'''Example:'''

browsers = ["IE", "Chrome", "!FireFox", "Safari", "!SeaMonkey"]

Good = browsers.slice(1, 3)

'''Result:'''

 . Good = Chrome,!FireFox