Lists

In this chapter we are going to learn how to deal with lists.

Create Lists

We can create new lists by defining the list items inside square brackets.

Example:

aList = [1,2,3,4,5]

Ring support trailing comma.

Example:

aList = ["one",
         "two",
         "three",
        ]

? aList

Also, we can create new lists using the : operator

Example:

aList = 1:5
aList2 = "a":"z"

Example:

aList = 5:1
aList2 = "z":"a"

Also we can create lists using the list() function

Syntax:

list = list(size)

To create 2D list

list = list(nRows,nCols)

Example (1)

aList = list(10)        # aList contains 10 items

Example (2)

aList = list(5,4)       # Create 2D List contains 5 rows and 4 columns

Note

the list index start from 1

Add Items

To add new items to the list, we can use the Add() function.

When adding a list to another list it will be added as one item.

If you want to change this and add each item in the added list alone pass the third parameter as True

Syntax:

Add(List,Item,[lManyItems])

Example:

aList = ["one","two"]
add(aList,"three")
see aList

Also we can do that using the + operator.

Syntax:

List + item

Example:

aList = 1:10    # create list contains numbers from 1 to 10
aList + 11      # add number 11 to the list
see aList       # print the list

Example:

aList = 1:3
add(aList,4:6)          # Add the list as one item
? len(aList)            # 4

aList = 1:3
add(aList,4:6,True)     # Add each item alone
? len(aList)            # 6
? aList

Get List Size

We can get the list size using the len() function

Syntax:

Len(List)

Example:

aList = 1:20  see len(aList)  # print 20

Delete Item From List

To delete an item from the list, we can use the del() function

Syntax:

del(list,index)

Example:

aList = ["one","two","other","three"]
Del(aList,3)    # delete item number three
see aList       # print one two three

Get List Item

To get an item from the list, we uses the next syntax

List[Index]

Example:

aList = ["Cairo","Riyadh"]
see "Egypt : " + aList[1] + nl +
    "KSA   : " + aList[2] + nl

Set List Item

To set the value of an item inside the list, we can use the next syntax

List[Index] = Expression

Example:

aList = list(3) # create list contains three items
aList[1] = "one" aList[2] = "two" aList[3] = "three"
see aList

Sort

We can sort the list using the sort() function.

Syntax:

Sort(List) ---> Sorted List
Sort(List,nColumn) ---> Sorted List based on nColumn
Sort(List,nColumn,cAttribute) ---> Sorted List based on Object Attribute

Example:

aList = [10,12,3,5,31,15]
aList = sort(aList) see aList # print 3 5 10 12 15 31

We can sort list of strings

Example:

mylist = ["mahmoud","samir","ahmed","ibrahim","mohammed"]
see mylist                # print list before sorting
mylist = sort(mylist)     # sort list
see "list after sort"+nl
see mylist                # print ahmed ibrahim mahmoud mohammed samir

We can sort a list based on a specific column.

Example:

aList = [ ["mahmoud",15000] ,
          ["ahmed", 14000 ] ,
          ["samir", 16000 ] ,
          ["mohammed", 12000 ] ,
          ["ibrahim",11000 ] ]

aList2 = sort(aList,1)
see aList2

Output:

ahmed
14000
ibrahim
11000
mahmoud
15000
mohammed
12000
samir
16000

Reverse

We can reverse a list using the reverse() function.

Note

This functions support strings too

Syntax:

Reverse(List) ---> Reversed List

Example:

aList = [10,20,30,40,50]
aList = reverse(aList)
see aList       # print 50 40 30 20 10

Insert Items

To insert an item in the list we can use the insert() function.

Syntax:

Insert(List,Index,Item)

The inserted item will be AFTER the Index

Example:

aList = ["A","B","D","E"]
insert(aList,2,"C")    # Inserts AFTER Index 2, "C" into Position 3
see aList              # print A B C D E

Nested Lists

The list may contain other lists

Example:

aList = [ 1 , [10,20,30] , 5 , [100,1000,5000] ]
aList2 = [
"one","two",
[3,4],
[20,30], ["three",
          "four",
          "five",[100,200,300]
         ]
]

see aList[2]            # print 10 20 30
see aList[4][3] + nl    # print 5000
see aList2[5][2] + nl   # print four
see aList2[5][4][3]     # print 300

Copy Lists

We can copy lists (including nested lists) using the Assignment operator.

Example:

aList = [
"one","two",
[3,4],
[20,30], ["three",
          "four",
          "five",[100,200,300]
         ]
]

aList2 = aList          # Copy aList to aList2
aList2[5] = "other"     # modify item number five
see aList2[5] + nl      # print other
see aList[5]            # print three four five 100 200 300

First-class lists

Lists are first-class citizens where we can store lists in variables, pass lists to functions, and return lists from functions.

Example:

aList = duplicate( [1,2,3,4,5] )
see aList[10] + nl                # print 5

see mylist()                      # print 10 20 30 40 50

func duplicate list
        nMax = len(list)
        for x = 1 to nMax
                list + list[x]
        next
        return list

func mylist return [10,20,30,40,50]

Using Lists during definition

We can use the list and the list items while we are defining the list for the first time.

Example:

aList = [ [1,2,3,4,5] , aList[1] , aList[1] ]
see aList       # print 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5

Example:

x = [ 1, 2, x ]
? x             # print 1 2 1 2
? len(x)        # print 3
? x[1]          # print 1
? x[2]          # print 2
? x[3]          # print 1 2

Output:

1
2
1
2

3
1
2
1
2

Passing Lists to Functions

Lists are passed to functions by reference, This means that the called function will work on the same list and can modify it.

Example:

func main
        aList = [1,2,3,4,5]     # create list, local in function main
        myfunc(aList)           # call function, pass list by reference
        see aList               # print 1 2 3 4 5 6 7 8 9 10

func myfunc list
        list + [6,7,8,9,10]

Access List Items by String Index

Instead of using numbers to determine the item index when we get item value or set item value, We can access items using string index if the item is a list contains two items and the first item is a string.

Example:

aList = [ ["one",1] , ["two",2] , ["three",3] ]
see aList["one"] + nl +
    aList["two"] + nl +
    aList["three"]      # print 1 2 3

This type of lists can be defined in a better syntax using the : and = operators.

Example:

aList = [ :one = 1 , :two = 2 , :three = 3 ]
see aList["one"] + nl +
    aList["two"] + nl +
    aList["three"] + nl # print 1 2 3
see aList[1]            # print one 1

Tip

using : before identifier (one word) means literal

Note

using = inside list definition create a list of two items where the first item is the left side and the second item is the right side.

We can add new items to the list using the string index

Example:

aList = []
aList["Egypt"] = "Cairo"
aList["KSA"] = "Riyadh"
see aList["Egypt"] + nl +       # print Cairo
    aList["KSA"] + nl           # print Riyadh

Passing Parameters or Arguments Using List

This type of lists is very good for passing parameters to functions Where the order of parameters will not be important (we can change the order).

Also some parameters maybe optional.

Example:

myconnect (  [ :server = "myserver.com" , :port = 80 ,
               :username = "mahmoud" , :password = "password" ] )

func myconnect mypara

        # print connection details
        see "User Name : " + mypara[:username] + nl +
            "Password  : " + mypara[:password] + nl +
            "Server    : " + mypara[:server] + nl +
            "Port      : " + mypara[:port]

Passing Parameters or Arguments Using List Array

Passing Arguments or Parameters to a Function in an array format

Example:

myList = [5,7,3,9]    ### list with args or parms in  an array
result = sum(myList)
See "Sum result: "+ result +n

func sum(aList)
  acc = 0
  sizeList = len(aList)

  for i = 1 to sizeList
     See aList[i] +nl
     acc = acc + aList[i]
  next
return acc

Return Parameters as List or Hash Table

Return Parameters from a Function in an Array or Hash Format

Example:

sudoku = [  [2,9,0],
            [0,0,1],
            [0,0,0] ]

aOutput = myFunctionArray(sudoku)
        See "Return Array: T/F: "+ aOutput[1] +" Row: "+ aOutput[2] +" Col: "+ aOutput[3] +nl

aOutput = myFunctionHash(sudoku)
        See "Return Hash.: T/F: "+ aOutput[:lValue] +" Row: "+ aOutput[:nRow] +" Col: "+ aOutput[:nCol] +nl

###----------------------------------
### isSolvedSoduku - Return ARRAY

Func myFunctionArray(sudoku)
    for Row = 1 to 9
        for Col = 1 to 9
            if sudoku[Row][Col] = 0

                //----------------------------
                // Return Array with 3 fields
                return [False, Row, Col]
            ok
        next
    next
return [True, Row, Col]

###----------------------------------
### isSolvedSoduku - Return HASH

Func myFunctionHash(sudoku)
    for Row = 1 to 3
        for Col = 1 to 3
            if sudoku[Row][Col] = 0

                //---------------------------------
                // Return Hash Table with 3 fields
                return  [   :lValue = False,
                            :nRow   = Row,
                            :nCol   = Col
                        ]
            ok
        next
    next

return  [ :lValue = False, :nRow = Row, :nCol = Col ]

###-----------------------------

Creating a Multi-Dimensional Array using List

A Multi-Dimensional Array of any size can be built using recursion in a Function

Example:

###---------------------------------------------------------
### Create Array -- Dimensions Any Size:  3D, 4D, 5D etc

dimList = [4,3,4]
bList   = createDimList(dimList)

###---------------------------------------------------------
### Populate the arrays using a counter 1 ,  4x4x4 = 256 , 2x3x4x5x6 = 720

Counter = 1

for Col=1 to dimList[1]
  for Row=1 to dimList[2]
    for Dep=1 to dimList[3]
            blist[Col][Row][Dep] = Counter
            Counter++
    next
  next
next

###-----------------------------------------------
### Print the array elements in block format

for Col=1 to dimList[1]
  for Row=1 to dimList[2]
    for Dep=1 to dimList[3]
            See bList[Col][Row][Dep] See " "
    next
    See nl
  next
    See nl
next

###===========================
### FUNCTIONS

###-----------------------------------------------------------------------
### Recursive Create a Dimension Array
### Call by passing an array of dimensions: dimList = [2,3,4,5]
### Drop the first entry every iteration call, making newParms
###
### Example:
###    dimList = [4,2,3,2]                <<< Number and size of dimensions in array format
###    bList   = createDimList(dimList)   <<< Call using the array as input

func createDimList(dimArray)

     sizeList = len(dimArray)

     newParms = []
     for i = 2 to sizeList
        Add(newParms, dimArray[i])
     next

     alist = list(dimArray[1])

     if sizeList = 1
        return aList
     ok

     for t in alist
         t = createDimList(newParms)
     next

return alist

Swap Lists and Items

We can swap lists/items using the Swap() function.

Syntax:

swap(aList1,aList2)
swap(aList,nItem1,nItem2)

Example:

aList = [:one,:two,:four,:three]
see aList
see copy("*",50) + nl
swap(aList,3,4)
see aList

Output

one
two
four
three
**************************************************
one
two
three
four

Example:

aList1 = 4:6
aList2 = 1:3
swap(aList1,aList2)
? aList1                        # 1 2 3
? aList2                        # 4 5 6

aList = [ 4:6 , 1:3 ]
? aList                         # 4 5 6 1 2 3
swap(aList[1], aList[2])
? aList                         # 1 2 3 4 5 6

aList = [ 4:6 , 1:3 ]
? aList                         # 4 5 6 1 2 3
swap(aList,1,2)
? aList                         # 1 2 3 4 5 6