summaryrefslogtreecommitdiff
path: root/help/en_US/sosbreak.xml
diff options
context:
space:
mode:
authorSunil Shetye2018-07-25 17:32:17 +0530
committerSunil Shetye2018-07-26 23:50:17 +0530
commitcdd55940b7a287810e423017c42e7c965815c468 (patch)
treed802563d2d507039354a3cf48e75465b7e7a8d76 /help/en_US/sosbreak.xml
parent1251f70aa3442736ce6fd9c4fb7fbce412af5a52 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-cdd55940b7a287810e423017c42e7c965815c468.tar.gz
FOSSEE-Signal-Processing-Toolbox-cdd55940b7a287810e423017c42e7c965815c468.tar.bz2
FOSSEE-Signal-Processing-Toolbox-cdd55940b7a287810e423017c42e7c965815c468.zip
code changes by Shashikiran Yadalam during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/sosbreak.xml')
-rw-r--r--help/en_US/sosbreak.xml49
1 files changed, 49 insertions, 0 deletions
diff --git a/help/en_US/sosbreak.xml b/help/en_US/sosbreak.xml
index 3957d94..383f449 100644
--- a/help/en_US/sosbreak.xml
+++ b/help/en_US/sosbreak.xml
@@ -19,5 +19,54 @@
<refname>sosbreak</refname>
<refpurpose>function for breaking a polynomial in second order polynomials (and an extra linear)</refpurpose>
</refnamediv>
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [zerosort,g]=sosbreak(p)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>p:</term>
+ <listitem><para>-the input polynomial.</para></listitem></varlistentry>
+ <varlistentry><term>zerosort:</term>
+ <listitem><para>-the array of the broken polynomials </para></listitem></varlistentry>
+ <varlistentry><term>g:</term>
+ <listitem><para>the interger multiple obtained after breaking the polynomial</para></listitem></varlistentry>
+
+
+
+</variablelist>
+
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+v=[1+4*%s+6*%s^2+4*%s^3+%s^4];
+[zerosort,g]=sosbreak(v);
+//OUTPUT:
+// g =1.
+ //zerosort =
+ // zerosort(1)
+// 2
+// 1 + 2s + s
+// zerosort(2)
+// 2
+//1.0000000 + 2s + s
+
+ ]]></programlisting>
+</refsection>
+
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Parthasarathi Panda</member>
+</simplelist>
+</refsection>
+
</refentry>