diff options
Diffstat (limited to 'help/en_US/sym_loadProblemBasic.xml')
-rw-r--r-- | help/en_US/sym_loadProblemBasic.xml | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/help/en_US/sym_loadProblemBasic.xml b/help/en_US/sym_loadProblemBasic.xml new file mode 100644 index 0000000..90a5995 --- /dev/null +++ b/help/en_US/sym_loadProblemBasic.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadProblemBasic" 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_loadProblemBasic</refname> + <refpurpose>Load a problem into Symphony (basic version)</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadProblemBasic(nbVar,nbConstr,varLB,varUB,objCoeff,isInt,objSense,conMatrix,conLB,conUB)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Loads a MIP problem into Symphony. All the necessary data can be given through a single function call.</para> + <para>The type of constraint is automatically deduced from the constraint bounds.</para> + <para>This version of the problem loader does not support sparse matrices and hence is only useful for small problems.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>nbVar</term> + <listitem><para>Number of variables</para></listitem> + </varlistentry> + <varlistentry> + <term>nbConstr</term> + <listitem><para>Number of constraints</para></listitem> + </varlistentry> + <varlistentry> + <term>varLB</term> + <listitem><para>Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>varUB</term> + <listitem><para>Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>objCoeff</term> + <listitem><para>Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>isInt</term> + <listitem><para>Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>objSense</term> + <listitem><para>The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here</para></listitem> + </varlistentry> + <varlistentry> + <term>conMatrix</term> + <listitem><para>Matrix (normal) representing the constraint matrix (must have size nbConstr rows and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>conLB</term> + <listitem><para>Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + <varlistentry> + <term>conUB</term> + <listitem><para>Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the problem was successfully loaded into Symphony</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_loadProblemBasic(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,[1,2;2,1],[0;0],[7;6.5])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + |