<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xgraduate">
    <refnamediv>
        <refname>xgraduate</refname>
        <refpurpose>axis graduation</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            [xi, xa, np1, np2, kMinr, kMaxr, ar] = xgraduate(xmi, xma)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>xmi, xma</term>
                <listitem>
                    <para>real scalars.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>xi, xa, kMinr, kMaxr, ar</term>
                <listitem>
                    <para>real scalars.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>np1, np2</term>
                <listitem>
                    <para>integers.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <function>xgraduate</function> returns the axis graduations which are
            used by the plot routines (with pretty print flag enabled). It
            returns an interval <literal>[xi, xa]</literal> which contains the
            given interval <literal>[xmi,xma]</literal> and such that
            <code>xi= kMinr*10^ar</code>, <code>xa=kMaxr*10^ar</code>
            and the interval can be divided into <varname>np2</varname> intervals
            and each interval is divided in <varname>np1</varname> sub-intervals.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
[x1,xa,np1,np2,kMinr,kMaxr,ar]=xgraduate(-0.3,0.2)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="graduate">graduate</link>
            </member>
            <member>
                <link linkend="plot2d">plot2d</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
