List Functions

Converts a matrix into a list. Multi-column matrices are converted to a list of row lists.

Concat Items({string1, string2, ...}, <delimiter>})

Converts a list of string expressions into one string, with each item separated by a delimiter. The delimiter is a blank, if unspecified.

an optional string that is placed between each item. The delimiter can be more than one character long.

The concatenated string.

Example

str1 = "one";

str2 = "two";

str3 = "three";

comb = Concat Items({str1, str2, str3});

"one two three"

comb = Concat Items({str1, str2, str3}, " : ");

"one : two : three"

del = ",";

comb = Concat Items({str1, str2, str3}, del);

"one,two,three"

Eval List(list)

Evaluates expressions inside list.

A list of the evaluated expressions.

A list of valid JSL expressions.

list

Insert(source, item, <position>)

Insert(source, key, value)

Inserts a new item into the source at the given position. If position is not given, item is added to the end.

For an associative array: Adds the key into the source associative array and assigns value to it. If the key exists in source already, its value is overwritten with the new value.

A string, list, expression, or associative array.

item or key

Any value to be placed within source. For an associative array, key might or might not be present in source.

position

Optional numeric value that specifies the position in source to place the item into.

value

A value to assign to the key.

Insert Into(source, item, <position>)

Insert Into(source, key, value)

Inserts a new item into the source at the given position in place. The source must be an L-value.

A variable that contains a string, list, display box, expression, or associative array.

item or key

Any value to be placed within source. For an associative array, key might or might not be present in source.

position

Optional numeric value that specifies the position in source to place the item into.

value

A value to assign to the key.

Is List(x)

Returns 1 if the evaluated argument is a list, or 0 otherwise.

List(a, b, c, ...)

{a, b, c, ...}

Constructs a list from a set of items.

N Items(source)

Determines the number of elements in the source specified.

For a list or display box, the number of items in the list or display box is returned. For an associative array, the number of keys is returned. For the matrix, the number of elements in the matrix is returned. For the namespace, the number of items in the namespace is returned.

A list, associative array, matrix, display box, or namespace.

Remove(source, position, <n>)

Remove(source, {items})

Remove(source, key)

Deletes the n item(s), starting from the indicated position. If n is omitted, the item at position is deleted. If position and n are omitted, the item at the end is removed. For an associative array: Deletes the key and its value.

A copy of the source with the items deleted.

A string, list, expression, or associative array.

position or key

An integer (or list of integers) that points to a specific item (or items) in the list or expression.

Optional. An integer that specifies how many items to remove.

Remove From(source, position, <n>)

Remove From(source, key)

Deletes the n item(s) in place, starting from the indicated position. If n is omitted, the item at position is deleted. If position and n are omitted, the item at the end is removed. For an associative array: Deletes the key and its value. The source must be an L-value.

The original source with the items deleted.

A string, list, expression, display box, or associative array.

position or key

An integer (or list of integers) that points to a specific item (or items) in the list or expression.

Optional. An integer that specifies how many items to remove.

Reverse(source)

Reverse order of elements or terms in the source.

Argument

A string, list, or expression.

Reverse Into(source)

Reverses the order of elements or terms in source in place.

Argument

A string, list, display box, or expression.

Shift(source, <n>)

Shifts an item or n items from the front to the back of the source.

A string, list, or expression.

Optional. An integer that specifies the number of items to shift. Positive values shift items from the beginning of the source to the end. Negative values shift items from the end of the source to the beginning. The default value is 1.

Shift Into(source, <n>)

Shifts items in place.

A string, list, display box, or expression.

Sort List(list |expr)

Sort List Into(list |expr)

Sort the elements or terms of list or expr.

Substitute(string, substring, replacementString, ...)

Sort the elements or terms of list or expr in place.

Substitute(list, listItem, replacementItem, ...)

Substitute(Expr(sourceExpr), Expr(findExpr), Expr(replacementExpr), ...)

This is a search and replace function. It searches for a specific portion (second argument) of the source (first argument), and replaces it (third argument).

If a string, finds all matches to substring in the source string, and replaces them with the replacementString.

If a list, finds all matches to listItem in the source list, and replaces them with the replacementItem.

If an expression, finds all matches to the findExpr in the sourceExpr, and replaces them with the replacementExpr. Note that all expressions must be enclosed within an Expr() function.

A string, list, or expression in which to perform the substitution.

string, list, sourceExpr

substring, listItem, findExpr

A string, list item, or expression to be found in the source string, list, or expression.

replacementString, replacementItem, replacementExpr

A string, list item, or expression to replace the found string, list item, or expression.

Substitute Into(string, substring, replacementString, ...)

Substitute Into(list, listItem, replacementItem, ...)

Substitute Into(Expr(sourceExpr), Expr(findExpr), Expr(replacementExpr), ...)

This is a search and replace function, identical to Substitute() except in place. It searches for a specific portion (second argument) of the source (first argument), and replaces it (third argument). The first argument must be an L-value.

If a string, finds all matches to substring in the source string, and replaces them with the replacementString.

If a list, finds all matches to listItem in the source list, and replaces them with the replacementItem.

If an expression, finds all matches to the findExpr in the sourceExpr, and replaces them with the replacementExpr. Note that all expressions must be enclosed within an Expr() function.

A string, list, or expression in which to perform the substitution.

string, list, sourceExpr

substring, listItem, findExpr

A string, list item, or expression to be found in the source string, list, or expression.

replacementString, replacementItem, replacementExpr

A string, list item, or expression to replace the found string, list item, or expression.

Words("text", <"delimiters">)