<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="zkcl">
  <refmeta>
    <refentrytitle>zkcl</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>zkcl</refname>
    <refpurpose>
      Clears one or more variables in the zk space.
      <indexterm id="IndexZkcl"><primary>zkcl</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Clears one or more variables in the zk space.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>zkcl</command> kfirst, klast</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ksig</emphasis> -- the input signal
    </para>

    <para>
      <emphasis>kfirst</emphasis> -- first zk or za location in the range to clear.
    </para>

    <para>
      <emphasis>klast</emphasis> -- last zk or za location in the range to clear.
    </para>

    <para>
      <emphasis>zkcl</emphasis> clears one or more variables in the zk space. This is useful for those variables which are used as accumulators for mixing k-rate signals at each cycle, but which must be cleared before the next set of calculations.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the zkcl opcode. It uses the files <ulink url="examples/zkcl.orc"><citetitle>zkcl.orc</citetitle></ulink> and <ulink url="examples/zkcl.sco"><citetitle>zkcl.sco</citetitle></ulink>.

      <example>
        <title>Example of the zkcl opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/zkcl.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/zkcl.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="zacl"><citetitle>zacl</citetitle></link>,
      <link linkend="zkwm"><citetitle>zkwm</citetitle></link>,
      <link linkend="zkw"><citetitle>zkw</citetitle></link>,
      <link linkend="zkmod"><citetitle>zkmod</citetitle></link>,
      <link linkend="zkr"><citetitle>zkr</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Robin Whittle</member>
        <member>Australia</member>
        <member>May 1997</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>
