diff options
Diffstat (limited to 'help/en_US/sym_addVar.xml')
-rw-r--r-- | help/en_US/sym_addVar.xml | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/help/en_US/sym_addVar.xml b/help/en_US/sym_addVar.xml new file mode 100644 index 0000000..7ba5c74 --- /dev/null +++ b/help/en_US/sym_addVar.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_addVar" 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:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_addVar</refname> + <refpurpose>Add a new variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_addVar(coeff,lower,upper,obj,isInt,name)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function adds a new variable from scratch.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>coeff</term> + <listitem><para>Sparse matrix representing coefficients of the new variable in the existing constraints (must have 1 column and number of rows equal to number of constraints)</para></listitem> + </varlistentry> + <varlistentry> + <term>lower</term> + <listitem><para>Lower bound of the new variable</para></listitem> + </varlistentry> + <varlistentry> + <term>upper</term> + <listitem><para>Upper bound of the new variable</para></listitem> + </varlistentry> + <varlistentry> + <term>obj</term> + <listitem><para>Coefficient of the variable in the objective function</para></listitem> + </varlistentry> + <varlistentry> + <term>isInt</term> + <listitem><para>Wether the variable is constrainted to be an integer (boolean %t or %f)</para></listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem><para>Name of the new variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_addVar(sparse([0;0;1;2;0;0]),0,%inf,1.2,%t,"part1")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + |