Array Module - Revision history

CG: Text replacement - "" to "

2023-12-01T16:35:06Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG: Text replacement - "" to ""

2023-12-01T16:32:34Z

Text replacement - "</syntaxhighlight>" to "</pre>"

Michael at 13:02, 23 November 2023

2023-11-23T13:02:50Z

Holu: Reorder array:put and array:remove

2023-11-21T09:14:43Z

Reorder array:put and array:remove

Holu at 09:13, 21 November 2023

2023-11-21T09:13:01Z

Holu at 09:08, 21 November 2023

2023-11-21T09:08:46Z

Holu: Added array:members

2023-11-21T09:00:26Z

Added array:members

Holu: Reorder array:join and added some examples

2023-11-21T08:52:35Z

Reorder array:join and added some examples

Holu: Added example to array:index-where

2023-11-21T08:40:14Z

Added example to array:index-where

Holu: Added array:insert-before

2023-11-20T09:00:58Z

Added array:insert-before

@@ Line 161: / Line 161: @@
 | '''Examples'''
 |The following query returns the array {{Code|[0, 1, 3]}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 array:filter(
    array { 0, 1, -2, 3, -4 },
@@ Line 201: / Line 201: @@
 | '''Examples'''
 |The following query returns {{Code|55}} (the sum of the integers 1 to 10):
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 array:fold-left(
    array { 1 to 10 },
@@ Line 225: / Line 225: @@
 | '''Examples'''
 |The following query is equivalent to the expression <code>array:reverse(array { 1 to 5 })</code>:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 array {
    array:fold-right(
@@ Line 286: / Line 286: @@
 |The following query returns the array {{Code|[2, 3, 4, 5, 6]}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 array:for-each(
    array { 1 to 5 },
@@ Line 309: / Line 309: @@
 | '''Examples'''
 |The following query returns the array {{Code|[5, 7, 9]}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 array:for-each-pair(
    array { 1 to 3 },

@@ Line 166: / Line 166: @@
    function($i) { $i > 0 }
+)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 207: / Line 207: @@
    function($a, $b) { $a + $b }
+)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 233: / Line 233: @@
+   )
+}
-</syntaxhighlight>
+</pre>
 |}
@@ Line 291: / Line 291: @@
    function($i) { $i + 1}
+)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 315: / Line 315: @@
    function($a + $b) { $a + $b }
+)
-</syntaxhighlight>
+</pre>
 |}

@@ Line 7: / Line 7: @@
 =Functions=
 ==array:append==
 {| width='100%'

@@ Line 542: / Line 542: @@
 |}
-==array:size==
+==array:put==
 {| width='100%'
 | width='120' | '''Signature'''
-|<pre>array:size(
+|<pre>array:put(
-   $array  as array(*)
+   $array     as array(*),
-) as xs:integer</pre>
+  $position  as xs:integer,
 |- valign="top"
 | '''Summary'''
-| Returns the number of members in {{Code|$array}}. Note that because an array is an item, the {{Code|fn:count}} function when applied to an array always returns {{Code|1}}.
+| Returns a copy of {{Code|$array}} with {{Code|$member}} replaced at the specified {{Code|$position}}. Equivalent to <code>$array => array:remove($position) => array:insert-before($position, $member)</code>.
 |- valign="top"
 | '''Examples'''
+|
-* <code>array:size(array { 1 to 10 })</code> returns {{Code|10}}.
+* <code>array:put(["a", "b", "c"], 2, "d")</code> returns the array {{Code|["a", "d", "c"]}}.
 |}
-==array:subarray==
+==array:remove==
 {| width='100%'
 | width='120' | '''Signature'''
-|<pre>array:subarray(
+|<pre>array:remove(
-   $array     as array(*),
+   $array      as array(*),
-   $position  as xs:integer,
+   $positions  as xs:integer*
 ) as array(*)</pre>
 |- valign="top"
 | '''Summary'''
-| Constructs a new array with with {{Code|$length}} members of {{Code|$array}} beginning from the specified {{Code|$position}}.<br/>The two-argument version of the function returns the same result as the three-argument version when called with {{Code|$length}} equal to the value of {{Code|array:size($array) - $position + 1}}.
+| Returns a copy of {{Code|$array}} without the member at the specified {{Code|$positions}}.
 |- valign="top"
 | '''Errors'''
-|{{Error|FOAY0001|#Errors}} {{Code|$position}} is less than one, or if {{Code|$position + $length}} is greater than {{Code|array:size($array) + 1}}.<br/>{{Error|FOAY0002|#Errors}} {{Code|$length}} is less than zero.
+|{{Error|FOAY0001|#Errors}} A position is not in the range {{Code|1}} to {{Code|array:size($array)}} inclusive.
 |- valign="top"
 | '''Examples'''
+|
-* <code>array:subarray(["a", "b", "c"], 2)</code> returns the array {{Code|["b", "c"]}}.
+* <code>array:append(["a"], 1)</code> returns the array {{Code|[]}}.
 |}
-==array:put==
+==array:size==
 {| width='100%'
 | width='120' | '''Signature'''
-|<pre>array:put(
+|<pre>array:size(
-   $array     as array(*),
+   $array  as array(*)
-  $position  as xs:integer,
+) as xs:integer</pre>
 |- valign="top"
 | '''Summary'''
-| Returns a copy of {{Code|$array}} with {{Code|$member}} replaced at the specified {{Code|$position}}. Equivalent to <code>$array => array:remove($position) => array:insert-before($position, $member)</code>.
+| Returns the number of members in {{Code|$array}}. Note that because an array is an item, the {{Code|fn:count}} function when applied to an array always returns {{Code|1}}.
 |- valign="top"
 | '''Examples'''
+|
-* <code>array:put(["a", "b", "c"], 2, "d")</code> returns the array {{Code|["a", "d", "c"]}}.
+* <code>array:size(array { 1 to 10 })</code> returns {{Code|10}}.
 |}
-==array:remove==
+==array:subarray==
 {| width='100%'
 | width='120' | '''Signature'''
-|<pre>array:remove(
+|<pre>array:subarray(
-   $array      as array(*),
+   $array     as array(*),
-   $positions  as xs:integer*
+   $position  as xs:integer,
 ) as array(*)</pre>
 |- valign="top"
 | '''Summary'''
-| Returns a copy of {{Code|$array}} without the member at the specified {{Code|$positions}}.
+| Constructs a new array with with {{Code|$length}} members of {{Code|$array}} beginning from the specified {{Code|$position}}.<br/>The two-argument version of the function returns the same result as the three-argument version when called with {{Code|$length}} equal to the value of {{Code|array:size($array) - $position + 1}}.
 |- valign="top"
 | '''Errors'''
-|{{Error|FOAY0001|#Errors}} A position is not in the range {{Code|1}} to {{Code|array:size($array)}} inclusive.
+|{{Error|FOAY0001|#Errors}} {{Code|$position}} is less than one, or if {{Code|$position + $length}} is greater than {{Code|array:size($array) + 1}}.<br/>{{Error|FOAY0002|#Errors}} {{Code|$length}} is less than zero.
 |- valign="top"
 | '''Examples'''
+|
-* <code>array:append(["a"], 1)</code> returns the array {{Code|[]}}.
+* <code>array:subarray(["a", "b", "c"], 2)</code> returns the array {{Code|["b", "c"]}}.
 |}

@@ Line 697: / Line 697: @@
 * Added: {{Function||array:build}}
 * Added: {{Function||array:foot}}
 ;Version 8.6

@@ Line 498: / Line 498: @@
 |- valign="top"
 | '''Summary'''
 | Delivers the contents of an {{Code|$array}} as a sequence of value records.
 |- valign="top"
 | '''Examples'''
@@ Line 511: / Line 514: @@
    array:of-members(array:members($array))
 )</pre> returns {{Code|true()}}</li>
 </ul>
 |}

@@ Line 486: / Line 486: @@
 * <code>array:join((["a", "b"], ["c", "d"], [ ]))</code> returns the array {{Code|["a", "b", "c", "d"]}}.
 * <code>array:join((["a", "b"], ["c", "d"], [["e", "f"]]))</code> returns the array {{Code|["a", "b", "c", "d", ["e", "f"]]}}.
 |}

@@ Line 465: / Line 465: @@
    </li>
 </ul>
 |}
@@ Line 544: / Line 565: @@
+|
 * <code>array:append(["a"], 1)</code> returns the array {{Code|[]}}.
 |}
@@ Line 600: / Line 600: @@
+|
 * <code>array:reverse(array { 1 to 3 })</code> returns the array {{Code|[3, 2, 1]}}.
 |}

@@ Line 409: / Line 409: @@
    function($m) { count($m) = 3 }
 )</pre> returns <code>(1, 2)</code>
    </li>
 </ul>