<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from isallpass.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="isallpass" 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:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>isallpass</refname>
    <refpurpose>Determine whether a filter is allpass.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Syntax</title>
   <synopsis>
   flag = isallpass(b, a)
   flag = isallpass(sos)
   flag = isallpass(..., tol)
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
        <varlistentry>
            <term>b:</term>
            <listitem><para> Numerator coefficients of the filter.</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>a:</term>
            <listitem><para> Denominator coefficients of the filter.</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>sos:</term>
            <listitem><para> Second-order section matrix (K x 6).</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>tol:</term>
            <listitem><para> (optional) Tolerance used to determine when two numbers are close enough to be considered equal.</para></listitem>
        </varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
The `isallpass` function determines whether the given filter is an allpass filter.
An allpass filter has a magnitude response of 1 for all frequencies.
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
k = [1/2, 1/3, 1/4, 1/5]
[b, a] = latc2tf(k, 'allpass')
flag_isallpass = isallpass(b, a)

   ]]></programlisting>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Parthasarathi Panda (parthasarathipanda314@gmail.com)</member>
   </simplelist>
</refsection>
</refentry>
