summaryrefslogtreecommitdiff
path: root/help/en_US/mpoles.xml
diff options
context:
space:
mode:
authorttt2018-12-06 13:42:14 +0530
committerttt2018-12-06 13:42:14 +0530
commitd6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795 (patch)
treefdbe9d1a10e7c256e86d7efae276fa75615cd0ba /help/en_US/mpoles.xml
parent3ffa5ac619587eadfdb4ffd3e2fee57fee385e21 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.tar.gz
FOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.tar.bz2
FOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.zip
code by jitendra and added more test4.sce
Diffstat (limited to 'help/en_US/mpoles.xml')
-rw-r--r--help/en_US/mpoles.xml57
1 files changed, 1 insertions, 56 deletions
diff --git a/help/en_US/mpoles.xml b/help/en_US/mpoles.xml
index 99ff1d2..7246219 100644
--- a/help/en_US/mpoles.xml
+++ b/help/en_US/mpoles.xml
@@ -17,62 +17,7 @@
<refnamediv>
<refname>mpoles</refname>
- <refpurpose>Identifies unique poles in p and their associated multiplicity.</refpurpose>
+ <refpurpose></refpurpose>
</refnamediv>
-<refsynopsisdiv>
- <title>Calling Sequence</title>
- <synopsis>
- [multp, idxp] = mpoles (p)
- [multp, idxp] = mpoles (p, tol)
- [multp, idxp] = mpoles (p, tol, reorder)
- </synopsis>
-</refsynopsisdiv>
-
-
-<refsection>
- <title>Parameters</title>
- <variablelist>
- <varlistentry><term>p:</term>
- <listitem><para> Real vector whose poles has to be calculated</para></listitem></varlistentry>
- <varlistentry><term>tol:</term>
- <listitem><para> tolerence,by default, tol=0.001</para></listitem></varlistentry>
- <varlistentry><term>reorder:</term>
- <listitem><para> the optional parameter, if reorder is zero, poles are not sorted.</para></listitem></varlistentry>
- <varlistentry><term>multp:</term>
- <listitem><para> is a vector specifying the multiplicity of the poles.</para></listitem></varlistentry>
-<varlistentry><term>indxp:</term>
- <listitem><para> indices of the poles</para></listitem></varlistentry>
-
-</variablelist>
-</refsection>
-<refsection>
- <title>Description</title>
- <para>
-The output is ordered from largest to the smallest poles. If the relative difference between the poles is less than the tolerance(tol), then those poles are considered as multiples. By default, the tolerance value is 0.001.
-</para>
-
-<para>
-If the optional parameter, reorder is 0, then the poles are not sorted.
-</para>
-</refsection>
-<refsection>
- <title>Examples</title>
- <programlisting role="example"><![CDATA[
- p = [2 3 1 1 2];
- [m, n] = mpoles (p)
-// n =
-// 2.
-// 5.
-// 1.
-// 4.
-// 3.
-// m =
-// 1.
-// 1.
-// 2.
-// 1.
-// 2.
- ]]></programlisting>
-</refsection>
</refentry>