summaryrefslogtreecommitdiff
path: root/help/en_US/iscatastrophic.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/iscatastrophic.xml')
-rw-r--r--help/en_US/iscatastrophic.xml68
1 files changed, 68 insertions, 0 deletions
diff --git a/help/en_US/iscatastrophic.xml b/help/en_US/iscatastrophic.xml
new file mode 100644
index 0000000..915ef6c
--- /dev/null
+++ b/help/en_US/iscatastrophic.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from iscatastrophic.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="iscatastrophic" 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>iscatastrophic</refname>
+ <refpurpose>This function determines if a convolutional code is catastrophic or not</refpurpose>
+ </refnamediv>
+
+
+<refsection>
+ <title>Description</title>
+ <para>
+RESULT = ISCATASTROPHIC(TRELLIS) returns 1 if the specified
+trellis corresponds to a catastrophic convolutional code, else 0.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+eg_1.numInputSymbols = 4;
+eg_1.numOutputSymbols = 4;
+eg_1.numStates = 3;
+eg_1.nextStates = [0 1 2 1;0 1 2 1; 0 1 2 1];
+eg_1.outputs = [0 0 1 1;1 1 2 1; 1 0 1 1];
+res_t_eg_1=istrellis(eg_1)
+res_c_eg_1=iscatastrophic(eg_1)
+if (res_c_eg_1) then
+disp('Example 1 is catastrophic')
+else
+disp('Example 1 is not catastrophic')
+end
+eg_2.numInputSymbols = 2;
+eg_2.numOutputSymbols = 4;
+eg_2.numStates = 2;
+eg_2.nextStates = [0 0; 1 1 ]
+eg_2.outputs = [0 0; 1 1];
+res_t_eg_2=istrellis(eg_2)
+res_c_eg_2=iscatastrophic(eg_2)
+if (res_c_eg_2) then
+disp('Example 2 is catastrophic')
+else
+disp('Example 2 is not catastrophic')
+end
+ ]]></programlisting>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Pola Lakshmi Priyanka, IIT Bombay</member>
+ </simplelist>
+</refsection>
+</refentry>