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
|
<?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
-
-
-->
<refentry id="xpf_ceiling">
<refmeta>
<refentrytitle>ceiling</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ceiling</refname>
<refpurpose>Returns the smallest integer that is not less than the argument.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_ceiling">
<funcprototype id="xpf_proto_ceiling">
<funcdef>integer <function>ceiling</function></funcdef>
<paramdef><parameter>num</parameter> number</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_ceiling"><title>Description</title>
<para>
This function returns the smallest (closest to negative infinity) number that is not less than the argument and that is an integer.
In other words, it "rounds up" the given value.
</para></refsect1>
<refsect1 id="xpf_params_ceiling"><title>Parameters</title>
<refsect2><title>num</title>
<para>The value to be "rounded up"</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_ceiling"><title>Return Types</title><para></para></refsect1>
<refsect1 id="xpf_examples_ceiling"><title>Examples</title>
<example id="xpf_ex_ceiling"><title></title>
<para>The following expressions are true:</para>
<screen>
ceiling(2.5) = 3
ceiling(2) = 2
ceiling(-2.5) = -2
ceiling(-2) = -2
</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_ceiling"><title>See Also</title>
<para><link linkend="xpf_floor">floor()</link><link linkend="xpf_round">round()</link></para>
</refsect1>
</refentry>
|