[Obsolete] nfreq
[scilab.git] / scilab / modules / statistics / help / en_US / regression / regress.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2000 - INRIA - Carlos Klimann
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="regress">
14     <refnamediv>
15         <refname>regress</refname>
16         <refpurpose>
17                 regression coefficients of two variables. <emphasis role="bold">This function is obsolete.</emphasis>
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>coefs=regress(x,y)</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>x,y</term>
29                 <listitem>
30                     <para>real or complex vector</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>
38             This function  computes the regresion  coefficients of two
39             variables <literal>x</literal>  and <literal>y</literal>, both  numerical vectors of
40             same number  of elements  <literal>n</literal>. <literal>coefs=[a b]</literal>  be a
41             1x2 matrix such that  <literal>Y=a+bX</literal> will be the equation of
42             the ordinary least square approximation to our data.
43         </para>
44         <warning>This function is obsolete.</warning>
45         It is better to use <link linkend="reglin">reglin</link> instead of <function>regress</function>.
46     </refsection>
47     <refsection>
48         <title>References</title>
49         <para>
50             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, J.Wiley &amp; Sons, 1990.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[ 
56 x=[0.5608486 0.6623569 0.7263507 0.1985144 0.5442573 0.2320748 0.2312237]
57 y=[0.3616361 0.2922267 0.5664249 0.4826472 0.3321719 0.5935095 0.5015342]
58 coefs=regress(x,y)
59  ]]></programlisting>
60     </refsection>
61     <refsection role="see also">
62         <title>See Also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="reglin">reglin</link>
66             </member>
67             <member>
68                 <link linkend="covar">covar</link>
69             </member>
70         </simplelist>
71     </refsection>
72     <refsection>
73         <title>History</title>
74         <revhistory>
75             <revision>
76                 <revnumber>5.5.0</revnumber>
77                 <revdescription>
78                     Function tagged as obsolete. Will be removed in 5.5.1. Please use <link linkend="reglin">reglin</link> instead.
79                 </revdescription>
80             </revision>
81         </revhistory>
82     </refsection>
83 </refentry>