summaryrefslogtreecommitdiff
path: root/help/en_US/aryule.xml
blob: 7d706fd158f1f9e258dbe511a34d4603a75fde72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from aryule.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="aryule" 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>aryule</refname>
    <refpurpose>This function fits an AR (p)-model with Yule-Walker estimates.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   a = aryule (x, p)
   [a, v] = aryule (x, p)
   [a, v, k] = aryule (x, p)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>x:</term>
      <listitem><para> vector of real or complex numbers, length &gt; 2</para></listitem></varlistentry>
   <varlistentry><term>p:</term>
      <listitem><para> positive integer value &lt; length(x) - 1</para></listitem></varlistentry>
   <varlistentry><term>a, v, k:</term>
      <listitem><para> Output variables</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
   </para>
   <para>
This function fits an AR (p)-model with Yule-Walker estimates.
The first argument is the data vector which is to be estimated.
Output variable a gives the AR coefficients, v gives the variance of the white noise and k gives the reflection coefficients to be used in the lattice filter.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
aryule([1,2,3,4,5],2)
ans  =
1.  - 0.8140351    0.1192982
   ]]></programlisting>
</refsection>
</refentry>