<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the Scilab time frequency toolbox.
This file must be used under the terms of the  terms of the GNU General Public License 
as published by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

Copyright (c) 1995 Rice University - CNRS (France) 1996.
-->


<refentry xml:id="disprog" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:scilab="http://www.scilab.org"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>disprog</refname>
	<refpurpose>Display progression of a loop</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>
      disprog(i,N,steps)
    </synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>I     :</term>
        <listitem>
          <para>a real scalar in [1 N]: the loop variable</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>	N     :</term>
        <listitem>
          <para>a positive  scalar: the  final value of i</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>	STEPS :</term>
        <listitem>
          <para>a positive integer: the  number of displayed steps.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>
    <para>
      disprog displays the progression of a loop.
    </para>
  </refsection>

  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
    N = 16;
	for i=1:N
	    disprog(i,N,5);
	end
    ]]></programlisting>
  </refsection>
  <refsection role="see also">
    <title>See also</title>
    <simplelist type="inline">
		<member><link linkend="waitbar">waitbar</link></member>
	</simplelist>
  </refsection>
  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>H. Nahrstaedt - Aug 2010</member>
      <member>F. Auger, August, December 1995.</member>
      <member>from an idea of R. Settineri.</member>
    </simplelist>
  </refsection>
</refentry>
