Lists

ALLIN

Returns TRUE if all elements from SEARCH exist also in LST. Items in LST list can contain wildcards.

ANYIN

Returns TRUE if at least one element from SEARCH exists also in LST. Items in LST list can contain wildcards.

EXPLODE

Converts a string (VALUE) to a list by splitting it by the use of SEPAR sepa-rator. The separator is consumed by the function, which means the resulting list items do not contain it.

IMPLODE

Converts a list to string by joining list's element with SEPAR glue.

IN

Checks whether VAL value exists in LST list. This function always searches for values, never for keys. Items in the list can contain wildcards.

KEYIN

Checks whether KEY key exists in LST list. If keys are used in the list then it compares keys. If the list uses automatic (i.e. numeric) keys then the key must be numeric. Items in the list can contain wildcards.

KEYS

Returns a list of keys used in the list passed as a parameter. This is useful mainly when the parameter is an associative list. By calling this function the keys can be transformed to a standard list. If the list passed as a parameter is not associative then the function returns a list of numbers, because num-bers are used as keys in non associative lists.

KSORT

Returns an associative list sorted by keys. This function fails when used with simple (non associative) list.

MERGE

Returns a list that contains all elements of all lists passed as arguments. The function can be used both with standard lists (with automatic keys) or with associative lists. You can merge up to 5 lists by one function call. All lists that are merged must have the same type - they all must use automatic keys or be associative. A content of the lists passed as arguments is not affected by the function.

When the lists use automatic indexes then the result contains all elements of the source lists. The first element has index 1, the last one has index equal to their count. In case of associative lists the key val-ues are important. If there are elements in the merged lists having the same key values, then such an element appears just once in the result and its value equals to the last one used

Example 1:

SET &A = ['a', 'b', 'c'];
SET &B = ['d', 'e', 'f'];
SET &C = ['g', 'h', 'i'];
SET &X = MERGE(&A, &B, &C);

The value of X is: ['a','b','c','d','e','f','g','h','i']

Example 2:

SET &A = ['a' => 'one',   'b' => 'two'];
SET &B = ['a' => 'three', 'c' => 'four'];
SET &C = ['a' => 'five'];
SET &X = MERGE(&A, &B, &C);

The value of X is: ['a' => 'five', 'b' => 'two', 'c' => 'four']

PUT

Inserts a new value to the list. This function can be used only with lists hav-ing automatic indexes.

Inserts a new pair or key and value to the list. This function can be used only with lists that use keys. If the key already exists in the list then it is set the new value.

PUTALL

Inserts all items from the source list to the target one. The new items are appended at the end. This function can be used only with target lists having automatic indexes. Items in the source list can be of any type.

Example:

set &A=[1,2,3,4,5];
set &B=['x','y','z'];
call putall(&B, &A);

After calling putall the content of &A will be: [1,2,3,4,5,'x','y','z']

PUTALLAT

Inserts all items from the source list to the target one at the specified posi-tion. If the position if higher than the current number of elements of the target list then the new items are appended to its end. This function can be used only with target lists having automatic indexes. Items in the source list can be of any type.

Example:

set &A=[1,2,3,4,5];
set &B=['x','y','z'];
call putall(&B, 3, &A);

After calling putall the content of &A will be: [1,2,'x','y','z',3,4,5]

PUTAT

Inserts a new value to the list at POS position. Existing items at POS and higher positions are shifted.

REM

Removes VAL value from the list. It always compare values, even when the list uses keys.

REMAT

Removes a value from the list at specified position. If the list does not use keys then VAL must be a number and has a meaning of a position. Other-wise VAL has a meaning of key.

REVERSE

Returns a list that has items sorted in the reverse order. It can be used with normal as well as with associative lists.

SAME

Returns TRUE if all pairs of a key and a value from L1 appear also in L2 and there is no key-value pair which exists only in one of the two lists.

SAMEKEYS

Returns TRUE if all keys from L1 appear also in L2 and there is no key which exists only in one of the two lists.

SAMEVALUES

Returns TRUE if all values from L1 appear also in L2 and there is no value which exists only in one of the two lists.

SIZE

Returns a number of elements in LST list.

SORT

Returns a list with sorted original list items. If it is used with associative lists then the result is sorted by values. If you need to sort by keys, use KSORT function instead.

SUBLIST

Returns a sublist of LST list. The new list contains elements starting at POS position of the original list. POS can be negative, then it measures from the end.

Returns a sublist of LST list. The new list contain max LEN elements of the original list starting from POS position. POS can be negative, then it measures from the end.

SUBLIST function works only with lists with automatic numeric keys. It can't be used for lists with user-defined keys.

VALUES

Returns a list of values used in the list passed as a parameter. The returned list is not associative. That means indexes in the returned list are numbers.