summaryrefslogtreecommitdiff
path: root/help/en_US/autoreg_matrix.xml
blob: 217a151417eb0e3daed193937e03307233461b32 (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="autoreg_matrix" 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>autoreg_matrix</refname>
    <refpurpose>Given a time series (vector) Y, return a matrix with ones in the first column and the first K lagged values of Y in the other columns.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   autoreg_matrix(Y, K)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>Y:</term>
      <listitem><para> Vector</para></listitem></varlistentry>
   <varlistentry><term>K:</term>
      <listitem><para> Scalar or Vector</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Given a time series (vector) Y, return a matrix with ones in the first column and the first K lagged values of Y in the other columns.
   </para>
   <para>
In other words, for T &gt; K, '[1, Y(T-1), ..., Y(T-K)]' is the t-th row of the result.
   </para>
   <para>
The resulting matrix may be used as a regressor matrix in autoregressions.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[

Y = [1,2,3] ;
K = 2 ;
autoreg_matrix(Y,K)

   ]]></programlisting>
</refsection>
</refentry>