Difference between revisions of "Array Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 25: Line 25:
 
{| width='100%'
 
{| width='100%'
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|array:append|$input as array(*), $insert as item()*|array(*)}}
+
|{{Func|array:append|$array as array(*), $insert as item()*|array(*)}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
 
| Adds one member at the end of the array. The result is an array whose size is {{Code|array:size($array) + 1}}, in which all members in positions {{Code|1}} to {{Code|array:size($array)}} are the same as the members in the corresponding position of $array, and the member in position {{Code|array:size($array) + 1}} is {{Code|$insert}}.
 
| Adds one member at the end of the array. The result is an array whose size is {{Code|array:size($array) + 1}}, in which all members in positions {{Code|1}} to {{Code|array:size($array)}} are the same as the members in the corresponding position of $array, and the member in position {{Code|array:size($array) + 1}} is {{Code|$insert}}.
 +
|-
 +
| '''Examples'''
 +
|
 +
* <code>array:append([], 'member1')</code> returns the array {{Code|["member1"]}}.
 +
|}
 +
 +
==array:subarray==
 +
{| width='100%'
 +
| width='120' | '''Signatures'''
 +
|{{Func|array:subarray|$array as array(*), $start as xs:integer|array(*)}}<br/>{{Func|array:subarray|$array as array(*), $start as xs:integer, $length as xs:integer|array(*)}}
 +
|-
 +
| '''Summary'''
 +
| Gets an array containing all members from a supplied array starting at a supplied position, up to a specified length.<br/>The two-argument version of the function returns the same result as the three-argument version when called with $length equal to the value of {{Code|array:size($array) - $start + 1}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''

Revision as of 20:30, 9 August 2014

This XQuery Module contains functions for manipulating arrays, which will officially be introduced with XQuery 3.1.
Please note that the functions are subject to change until the specification has reached its final stage.

Conventions

All functions in this module are assigned to the http://www.w3.org/2005/xpath-functions/array namespace, which is statically bound to the array prefix.

Functions

array:size

Signatures array:size($input as array(*)) as xs:integer
Summary Returns the number of members in the supplied array. Note that because an array is an item, the fn:count function when applied to an array always returns 1.
Examples
  • array:size([1 to 10]) returns 10.
  • array:size(array { 1 to 10 }) returns 10.

array:append

Signatures array:append($array as array(*), $insert as item()*) as array(*)
Summary Adds one member at the end of the array. The result is an array whose size is array:size($array) + 1, in which all members in positions 1 to array:size($array) are the same as the members in the corresponding position of $array, and the member in position array:size($array) + 1 is $insert.
Examples
  • array:append([], 'member1') returns the array ["member1"].

array:subarray

Signatures array:subarray($array as array(*), $start as xs:integer) as array(*)
array:subarray($array as array(*), $start as xs:integer, $length as xs:integer) as array(*)
Summary Gets an array containing all members from a supplied array starting at a supplied position, up to a specified length.
The two-argument version of the function returns the same result as the three-argument version when called with $length equal to the value of array:size($array) - $start + 1.
Examples
  • array:append([], 'member1') returns the array ["member1"].

array:serialize

Signatures map:serialize($input as map(*)) as xs:string
Summary This function is specific to BaseX. It returns a string representation of the supplied array. The purpose of this function is to get an insight into the structure of an array item; it cannot necessarily be used for reconstructing the original array.
Examples
  • array:serialize([ 1, (2, 3), 4 to 6 ]) returns [1, (2, 3), (4, 5, 6)].

Changelog

Introduced with Version 8.0.