Re-indent XML Files
[scilab.git] / scilab / modules / optimization / help / en_US / karmarkar.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
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-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" version="5.0-subset Scilab" xml:lang="en" xml:id="karmarkar">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>karmarkar</refname>
19     <refpurpose> karmarkar algorithm</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>[x1]=karmarkar(a,b,c,x0)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>a</term>
30         <listitem>
31           <para>matrix (n,p)</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>b</term>
36         <listitem>
37           <para> n - vector</para>
38         </listitem>
39       </varlistentry>
40       <varlistentry>
41         <term>c</term>
42         <listitem>
43           <para> p - vector</para>
44         </listitem>
45       </varlistentry>
46       <varlistentry>
47         <term>x0</term>
48         <listitem>
49           <para> initial vector</para>
50         </listitem>
51       </varlistentry>
52       <varlistentry>
53         <term>eps</term>
54         <listitem>
55           <para>threshold (default value : 1.d-5)</para>
56         </listitem>
57       </varlistentry>
58       <varlistentry>
59         <term>gamma</term>
60         <listitem>
61           <para>descent step  <literal>0&lt;gamma&lt;1</literal> , default value : 1/4</para>
62         </listitem>
63       </varlistentry>
64       <varlistentry>
65         <term>x1</term>
66         <listitem>
67           <para>solution</para>
68         </listitem>
69       </varlistentry>
70       <varlistentry>
71         <term>crit</term>
72         <listitem>
73           <para>value of  c'*x1</para>
74         </listitem>
75       </varlistentry>
76     </variablelist>
77   </refsection>
78   <refsection>
79     <title>Description</title>
80     <para>
81     Computes <literal>x</literal> which minimizes</para>
82     <programlisting><![CDATA[
83
84                         c'*x
85    
86     ]]></programlisting>
87     <para>
88     under constraints:</para>
89     <programlisting><![CDATA[
90
91                         a*x = b
92                         x>=0
93    
94     ]]></programlisting>
95   </refsection>
96   <refsection>
97     <title>Examples</title>
98     <programlisting role="example"><![CDATA[
99
100 // n=10;p=20;
101 // a=rand(n,p);c=rand(p,1);x0=abs(rand(p,1));b=a*x0;x1=karmarkar(a,b,c,x0);
102  
103   ]]></programlisting>
104   </refsection>
105 </refentry>