extend to RFC3066bis :D
[scilab.git] / scilab / modules / optimization / help / en_US / karmarkar.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>karmarkar</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>$LastChangedDate$</DATE>
8   <SHORT_DESCRIPTION name="karmarkar"> karmarkar algorithm</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>[x1]=karmarkar(a,b,c,x0)  </CALLING_SEQUENCE_ITEM>
11   </CALLING_SEQUENCE>
12   <PARAM>
13     <PARAM_INDENT>
14       <PARAM_ITEM>
15         <PARAM_NAME>a</PARAM_NAME>
16         <PARAM_DESCRIPTION>
17           <SP>: matrix (n,p)</SP>
18         </PARAM_DESCRIPTION>
19       </PARAM_ITEM>
20       <PARAM_ITEM>
21         <PARAM_NAME>b</PARAM_NAME>
22         <PARAM_DESCRIPTION>
23           <SP>:  n - vector</SP>
24         </PARAM_DESCRIPTION>
25       </PARAM_ITEM>
26       <PARAM_ITEM>
27         <PARAM_NAME>c</PARAM_NAME>
28         <PARAM_DESCRIPTION>
29           <SP>:  p - vector</SP>
30         </PARAM_DESCRIPTION>
31       </PARAM_ITEM>
32       <PARAM_ITEM>
33         <PARAM_NAME>x0</PARAM_NAME>
34         <PARAM_DESCRIPTION>
35           <SP>:  initial vector</SP>
36         </PARAM_DESCRIPTION>
37       </PARAM_ITEM>
38       <PARAM_ITEM>
39         <PARAM_NAME>eps</PARAM_NAME>
40         <PARAM_DESCRIPTION>
41           <SP>: threshold (default value : 1.d-5)</SP>
42         </PARAM_DESCRIPTION>
43       </PARAM_ITEM>
44       <PARAM_ITEM>
45         <PARAM_NAME>gamma</PARAM_NAME>
46         <PARAM_DESCRIPTION>
47           <SP>: descent step  <VERB>0&lt;gamma&lt;1</VERB> , default value : 1/4</SP>
48         </PARAM_DESCRIPTION>
49       </PARAM_ITEM>
50       <PARAM_ITEM>
51         <PARAM_NAME>x1</PARAM_NAME>
52         <PARAM_DESCRIPTION>
53           <SP>: solution</SP>
54         </PARAM_DESCRIPTION>
55       </PARAM_ITEM>
56       <PARAM_ITEM>
57         <PARAM_NAME>crit</PARAM_NAME>
58         <PARAM_DESCRIPTION>
59           <SP>: value of  c'*x1</SP>
60         </PARAM_DESCRIPTION>
61       </PARAM_ITEM>
62     </PARAM_INDENT>
63   </PARAM>
64   <DESCRIPTION>
65     <P>
66     Computes <VERB>x</VERB> which minimizes</P>
67     <VERBATIM>
68 <![CDATA[
69                         c'*x
70    ]]>
71     </VERBATIM>
72     <P>
73     under constraints:</P>
74     <VERBATIM>
75 <![CDATA[
76                         a*x = b
77                         x>=0
78    ]]>
79     </VERBATIM>
80   </DESCRIPTION>
81   <EXAMPLE>
82 <![CDATA[
83 // n=10;p=20;
84 // a=rand(n,p);c=rand(p,1);x0=abs(rand(p,1));b=a*x0;x1=karmarkar(a,b,c,x0);
85  ]]>
86   </EXAMPLE>
87 </MAN>