<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * Copyright (C) 2011 - DIGITEO - Michael Baudin
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="round" xml:lang="en">
    <refnamediv>
        <refname>round</refname>
        <refpurpose>round to nearest integer</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>y=round(x)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>real or complex matrix</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>integer value matrix (or complex matrix with integer real and imaginary part)</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>round(x)</literal> rounds the elements of
            <literal>x</literal> to the nearest integers.
        </para>
        <para>
            In case of tie, this function rounds to infinities.
            That is, if <literal>x</literal> is positive and is halfway between two
            integers, then <literal>round(x)</literal> is rounded toward <literal>%inf</literal>.
            If <literal>x</literal> is negative and is halfway between two
            integers, then <literal>round(x)</literal> is rounded toward <literal>-%inf</literal>.
            In other words, if <literal>x</literal> is positive, then <literal>round(x)</literal>
            is equal to <literal>int(x+0.5)</literal>, and if <literal>x</literal> is negative,
            then <literal>round(x)</literal> is equal to <literal>int(x-0.5)</literal>
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// Notice that round(1.5)==2
round([1.3 1.5 1.7 2.5 3.7])
// Notice the result for x negative
// Notice that round(-1.5)==-2
round([-1.3 -1.5 -1.7 -2.5 -3.7])
round([2.2+%i*23, %pi*%i, -%i ])
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="int">int</link>
            </member>
            <member>
                <link linkend="floor">floor</link>
            </member>
            <member>
                <link linkend="ceil">ceil</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
