1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<!--
Please use the following prefixes for IDs:
xpf_ for old XPATH functions,
xf_ for XPATH 2.0 & XQUERY 1.0 functions,
xsl_ for XSL elements,
-->
<refentry id="xpf_sum">
<refmeta>
<refentrytitle>sum</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sum</refname>
<refpurpose>Returns sum of all its arguments</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_sum">
<funcprototype id="xpf_proto_sum">
<funcdef>number <function>sum</function></funcdef>
<paramdef><parameter>arg1</parameter> any</paramdef>
<paramdef><parameter>arg2</parameter> any</paramdef>
<paramdef><parameter>...</parameter></paramdef>
<paramdef><parameter>argN</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_sum"><title>Description</title>
<para>
The function returns the sum, for each node in every argument node-set, of the result of converting the string-values of the node to a number.
If some arguments are not node-sets, they are converted to numbers first.
</para>
<para>
Note that this definition differs from XPATH 1.0 standard, where sum() function
must have exactly one argument of type node-set.
It is important that other XPATH processors may quietly ignore all arguments except the first
one, producing unexpected results.
</para>
<para>
Being called without arguments, sum() will return zero.
</para>
</refsect1>
<refsect1 id="xpf_params_sum"><title>Parameters</title>
<refsect2><title>argI</title>
<para>A node-set of nodes whose string values must be converted to numbers and added to the result, or single value.</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_sum"><title>Return Types</title><para></para></refsect1>
<refsect1 id="xpf_examples_sum"><title>Examples</title>
<example id="xpf_ex_sum"><title></title>
<para></para>
<screen>sum(/bill[@type="sale"]/total,/bill[@type="leasing"]/income)</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_sum"><title>See Also</title>
<para><link linkend="xpf_avg">avg</link><link linkend="xpf_max">max</link><link linkend="xpf_min">min</link></para>
</refsect1>
</refentry>
|
