HigherOrder Functions
This page talks about higherorder functions introduced with XQuery 3.0. The BaseXspecific HigherOrder Functions Module contains some more useful functions.
Contents
Function Items
Probably the most important new feature in XQuery 3.0 are function items, i. e. items that act as functions, but can also be passed to and from other functions and expressions, making functions firstclass citizens of the language.
The XQuery 3.0 page goes into details on how function items can be obtained.
Function Types
Like every XQuery item, function items have a sequence type. It can be used to specify the arity (number of arguments the function takes) and the argument and result types.
The most general function type is function(*)
. It's the type of all
function items. The following query for example goes through a list of XQuery
items and, if it is a function item, prints its arity:
for $item in (1, 'foo', fn:concat#3, function($a) { 42 * $a }) where $item instance of function(*) return fn:functionarity($item)
Result: 3 1
The notation for specifying argument and return types is quite intuitive, as it closely resembles the function declaration. The XQuery function
declare function local:charat( $str as xs:string, $pos as xs:integer ) as xs:string { fn:substring($str, $pos, 1) };
for example has the type function(xs:string, xs:integer) as xs:string
. It isn't possible to specify only the argument and not the result
type or the other way round. A good placeholder to use when no restriction
is wanted is item()*
, as it matches any XQuery value.
Function types can also be nested. As an example we take local:onsequences
, which takes a function defined on single items and makes it work on sequences as well:
declare function local:onsequences( $fun as function(item()) as item()* ) as function(item()*) as item()* { fn:foreach($fun, ?) };
We'll see later how fn:foreach(...)
works. The type of local:onsequences(...)
on the other hand is easily constructed, if a bit long:
function(function(item()) as item()*) as function(item()*) as item()*
.
HigherOrder Functions
A higherorder function is a function that takes other functions as arguments and/or returns them as results. fn:foreach
and local:onsequences
from the last chapter are nice examples.
With the help of higherorder functions, one can extract common patterns of behaviour and abstract them into a library function.
HigherOrder Functions on Sequences
Some usage patterns on sequences are so common that the higherorder functions describing them are in the XQuery standard libraries. They are listed here, together with their possible XQuery implementation and some motivating examples.
fn:foreach
Signatures  fn:foreach($seq as item()*, $fun as function(item()) as item()*)) as item()*

Summary  Applies the function item $fun to every element of the sequence $seq and returns all of the results as a sequence.

Examples 

XQuery 1.0  declare function local:foreach( $seq as item()*, $fun as function(item()) as item()* ) as item()* { for $s in $seq return $fun($s) }; 
fn:filter
Signatures  fn:filter($seq as item()*, $pred as function(item()) as xs:boolean)) as item()* fn:filter($pred as function(item()) as xs:boolean, $seq as item()*) as item()* 
Summary  Applies the boolean predicate $pred to all elements of the sequence $seq , returning those for which it returns true() .

Examples 

Note  fn:filter can be easily implemented with fn:foreach :
declare function local:filter($seq, $pred) { foreach( $seq, function($x) { if($pred($x)) then $x else () } ) }; 
XQuery 1.0  declare function local:filter( $seq as item()*, $pred as function(item()) as xs:boolean ) as item()* { $seq[$pred(.)] }; 
fn:foreachpair
Signatures  fn:foreachpair($seq1 as item()*, $seq2 as item()*, $fun as function(item(), item()) as item()*) as item()*

Summary  zips the elements from the two sequences $seq1 and $seq2 together with the function $f . It stops after the shorter sequence ends.

Examples 

XQuery 1.0  declare function local:foreachpair( $seq1 as item()*, $seq2 as item()*, $fun as function(item(), item()) as item()* ) as item()* { for $pos in 1 to min((count($seq1), count($seq2))) return $fun($seq1[$pos], $seq2[$pos]) }; 
Folds
A fold, also called reduce or accumulate in other languages, is a very basic higherorder function on sequences. It starts from a seed value and incrementally builds up a result, consuming one element from the sequence at a time and combining it with the aggregate of a userdefined function.
Folds are one solution to the problem of not having state in functional programs. Solving a problem in imperative programming languages often means repeatedly updating the value of variables, which isn't allowed in functional languages.
Calculating the product of a sequence of integers for example is easy in Java
:
public int product(int[] seq) { int result = 1; for(int i : seq) { result = result * i; } return result; }
Nice and efficient implementations using folds will be given below.
The linear folds on sequences come in two flavours. They differ in the direction in which they traverse the sequence:
fn:foldleft
Signatures  fn:foldleft($seq as item()*, $seed as item()*, $fun as function(item()*, item()) as item()*) as item()*

Summary  The left fold traverses the sequence from the left.
The query $f($f($f($f($f(0, 1), 2), 3), 4), 5) 
Examples 

XQuery 1.0  As folds are more general than FLWOR expressions, the implementation isn't as concise as the former ones:
declare function local:foldleft( $seq as item()*, $seed as item()*, $fun as function(item()*, item()) as item()* ) as item()* { if(empty($seq)) then $seed else local:foldleft( fn:tail($seq), $fun($seed, fn:head($seq)), $fun ) }; 
fn:foldright
Signatures  fn:foldright($seq as item()*, $seed as item()*, $fun as function(item(), item()*) as item()*

Summary  The right fold fn:foldright($seq, $seed, $fun) traverses the from the right.
The query $f(1, $f(2, $f(3, $f(4, $f(5, 0))))) 
Examples 

XQuery 1.0  declare function local:foldright( $seq as item()*, $seed as item()*, $fun as function(item(), item()*) as item()* ) as item()* { if(empty($seq)) then $seed else $fun( fn:head($seq), local:foldright(tail($seq), $seed, $fun) ) }; Note that the order of the arguments of 