diff options
Diffstat (limited to 'help/en_US/residued.xml')
-rw-r--r-- | help/en_US/residued.xml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/help/en_US/residued.xml b/help/en_US/residued.xml new file mode 100644 index 0000000..8bdecc5 --- /dev/null +++ b/help/en_US/residued.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from residued.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="residued" 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>residued</refname> + <refpurpose></refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [r,p,f,m]=residued(b,a) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>b:</term> + <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +Similar to the "residuez" function. The difference being in the function "residuez", the IIR part (poles p and residues r) is driven in parallel with the FIR part(f) whereas in the function "residued", the IIR part is driven by the output of the FIR part. In signal modeling applications, this structure can be more accurate. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +1. [a,b,c,d]=residued([1 i;3 -4],[1 2; 3 4]) +a = [ 0.19405 - 1.31377i; 0.08329 + 0.99163i; -0.27734 + 0.32215i] +b = [ -0.10184 - 1.19167i; -0.10184 + 1.19167i; -2.79632 - 0.00000i] +c = 1 +d = [ 1 ; 1 ; 1] + ]]></programlisting> +</refsection> +</refentry> |