Deleted vectorized computation feature. Deleted neldermead_contour. Fixed the demos.
[scilab.git] / scilab / modules / optimization / help / en_US / karmarkar.xml
index 8938c52..d9b91f0 100644 (file)
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>karmarkar</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>$LastChangedDate$</DATE>
-  <SHORT_DESCRIPTION name="karmarkar"> karmarkar algorithm</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[x1]=karmarkar(a,b,c,x0)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>a</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: matrix (n,p)</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>b</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>:  n - vector</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>c</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>:  p - vector</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>x0</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>:  initial vector</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>eps</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: threshold (default value : 1.d-5)</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>gamma</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: descent step  <VERB>0&lt;gamma&lt;1</VERB> , default value : 1/4</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>x1</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: solution</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>crit</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: value of  c'*x1</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Computes <VERB>x</VERB> which minimizes</P>
-    <VERBATIM>
-<![CDATA[
-                        c'*x
-   ]]>
-    </VERBATIM>
-    <P>
-    under constraints:</P>
-    <VERBATIM>
-<![CDATA[
-                        a*x = b
-                        x>=0
-   ]]>
-    </VERBATIM>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[
-// n=10;p=20;
-// a=rand(n,p);c=rand(p,1);x0=abs(rand(p,1));b=a*x0;x1=karmarkar(a,b,c,x0);
- ]]>
-  </EXAMPLE>
-</MAN>
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<refentry version="5.0-subset Scilab" xml:id="karmarkar" 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:ns4="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+
+  <refnamediv>
+    <refname>karmarkar</refname>
+
+    <refpurpose>karmarkar algorithm</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+
+    <synopsis>[x1]=karmarkar(a,b,c,x0)</synopsis>
+  </refsynopsisdiv>
+
+  <refsection>
+    <title>Parameters</title>
+
+    <variablelist>
+      <varlistentry>
+        <term>a</term>
+
+        <listitem>
+          <para>matrix (n,p)</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>b</term>
+
+        <listitem>
+          <para>n - vector</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>c</term>
+
+        <listitem>
+          <para>p - vector</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>x0</term>
+
+        <listitem>
+          <para>initial vector</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>eps</term>
+
+        <listitem>
+          <para>threshold (default value : 1.d-5)</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>gamma</term>
+
+        <listitem>
+          <para>descent step <literal>0&lt;gamma&lt;1</literal> , default
+          value : 1/4</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>x1</term>
+
+        <listitem>
+          <para>solution</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>crit</term>
+
+        <listitem>
+          <para>value of c'*x1</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+
+  <refsection>
+    <title>Description</title>
+
+    <para>Computes <literal>x</literal> which minimizes</para>
+
+    <informalequation>
+      <mediaobject>
+        <imageobject>
+          <imagedata align="center" fileref="../mml/karmarkar_equation_1.mml" />
+        </imageobject>
+      </mediaobject>
+    </informalequation>
+  </refsection>
+
+  <refsection>
+    <title>Examples</title>
+
+    <programlisting role="example"><![CDATA[ 
+n=10;p=20;
+a=rand(n,p);
+c=rand(p,1);
+x0=abs(rand(p,1));
+b=a*x0;
+x1=karmarkar(a,b,c,x0);
+ ]]></programlisting>
+  </refsection>
+</refentry>