Merge pull request #5 from abhinavdronamraju/master

Help files created and Updated Readme.md

1 files changed, 75 insertions, 0 deletions

diff --git a/help/en_US/cheb1ap.xml b/help/en_US/cheb1ap.xml
new file mode 100644
index 0000000..dbd541a
--- /dev/null
+++ b/help/en_US/cheb1ap.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from cheb1ap.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="cheb1ap" 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>cheb1ap</refname>
+    <refpurpose>This function designs a lowpass analog Chebyshev type I filter.</refpurpose>
+  </refnamediv>
+
+
+<refsynopsisdiv>
+   <title>Calling Sequence</title>
+   <synopsis>
+   [z, p, g] = cheb1ap (n, Rp)
+   [z, p] = cheb1ap (n, Rp)
+   p = cheb1ap (n, Rp)
+   </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+   <title>Parameters</title>
+   <variablelist>
+   <varlistentry><term>n:</term>
+      <listitem><para> Filter Order</para></listitem></varlistentry>
+   <varlistentry><term>Rp:</term>
+      <listitem><para> Peak-to-peak passband ripple</para></listitem></varlistentry>
+   <varlistentry><term>z:</term>
+      <listitem><para> Zeros</para></listitem></varlistentry>
+   <varlistentry><term>p:</term>
+      <listitem><para> Poles</para></listitem></varlistentry>
+   <varlistentry><term>g:</term>
+      <listitem><para> Gain</para></listitem></varlistentry>
+   </variablelist>
+</refsection>
+
+<refsection>
+   <title>Description</title>
+   <para>
+This is an Octave function.
+It designs a lowpass analog Chebyshev type I filter of nth order and with a Peak-to-peak passband ripple of Rp.
+</para>
+</refsection>
+
+<refsection>
+   <title>Examples</title>
+   <programlisting role="example"><![CDATA[
+[z, p, g] = cheb1ap (10, 20)
+z = [](0x0)
+p =
+
+Columns 1 through 6:
+
+-0.00157 - 0.98774i  -0.00456 - 0.89105i  -0.00709 - 0.70714i  -0.00894 - 0.45401i  -0.00991 - 0.15644i  -0.00991 + 0.15644i
+
+Columns 7 through 10:
+
+-0.00894 + 0.45401i  -0.00709 + 0.70714i  -0.00456 + 0.89105i  -0.00157 + 0.98774i
+
+g =  1.9630e-04 - 6.3527e-22i
+   ]]></programlisting>
+</refsection>
+</refentry>