diff options
Diffstat (limited to 'help/en_US/Symphony Native Function')
60 files changed, 3599 insertions, 0 deletions
diff --git a/help/en_US/Symphony Native Function/CHAPTER b/help/en_US/Symphony Native Function/CHAPTER new file mode 100644 index 0000000..8dd59e1 --- /dev/null +++ b/help/en_US/Symphony Native Function/CHAPTER @@ -0,0 +1 @@ +title = Symphony Native Functions
diff --git a/help/en_US/Symphony Native Function/CHAPTER~ b/help/en_US/Symphony Native Function/CHAPTER~ new file mode 100644 index 0000000..a0a7f5d --- /dev/null +++ b/help/en_US/Symphony Native Function/CHAPTER~ @@ -0,0 +1 @@ +title = API Functions
diff --git a/help/en_US/Symphony Native Function/sym_addConstr.xml b/help/en_US/Symphony Native Function/sym_addConstr.xml new file mode 100644 index 0000000..89ec114 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_addConstr.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_addConstr" 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_addConstr</refname> + <refpurpose>Add a new constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_addConstr(coeff,type,bound1[,bound2])</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function adds a new constraint from scratch. Supported types of constraints are less than or equal to, more than or equal to, equal to, or ranged.</para> + <para>The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>coeff</term> + <listitem><para>Sparse matrix representing coefficients of the variables in the new constraint (must have 1 row and number of columns equal to number of variables)</para></listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem><para>Type of the new constraint. Supported types: less than or equal to ("L"), greater than or equal to ("G"), equal to ("E"), or ranged ("R")</para></listitem> + </varlistentry> + <varlistentry> + <term>bound1</term> + <listitem><para>The first (or only) bound for the constraint</para></listitem> + </varlistentry> + <varlistentry> + <term>bound2</term> + <listitem><para>The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_addConstr(sparse([0,0,1,0,2]),"R",0,10)</programlisting> + <programlisting role="example">sym_addConstr(sparse([0,0,1,1,0]),"G",4)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_addVar.xml b/help/en_US/Symphony Native Function/sym_addVar.xml new file mode 100644 index 0000000..7ba5c74 --- /dev/null +++ b/help/en_US/Symphony Native Function/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> + diff --git a/help/en_US/Symphony Native Function/sym_close.xml b/help/en_US/Symphony Native Function/sym_close.xml new file mode 100644 index 0000000..5f2e903 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_close.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_close" 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_close</refname> + <refpurpose>Close the Symphony environment</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_close()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Closes the already open Symphony environment.</para> + <para>Warning: All data loaded into the environment is deleted.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment was successfully closed and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_close()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + <member>Iswarya</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_deleteConstrs.xml b/help/en_US/Symphony Native Function/sym_deleteConstrs.xml new file mode 100644 index 0000000..7c1aaa7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_deleteConstrs.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_deleteConstrs" 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_deleteConstrs</refname> + <refpurpose>This routine is used to delete rows from the original constraint matrix.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_deleteConstrs(indices)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>indices</term> + <listitem><para>An array indicating the indices of the rows to be deleted.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the constraints specified in the indices are deleted successfully and 0 if it returns corresponding to an error value.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_deleteConstrs([1,2])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_deleteVars.xml b/help/en_US/Symphony Native Function/sym_deleteVars.xml new file mode 100644 index 0000000..3ce1fe7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_deleteVars.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_deleteVars" 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_deleteVars</refname> + <refpurpose>This routine is used to delete columns from the original problem description.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_deleteVars(indices)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>indices</term> + <listitem><para>Pointer to an integer type array indicating the indices of the column numbers(variables) to be deleted.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the column numbers specified are deleted successfully and 0 if the deletion of column indices did not execute successfully and it returns with an error return value</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_deleteVars([1,2])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getConstrActivity.xml b/help/en_US/Symphony Native Function/sym_getConstrActivity.xml new file mode 100644 index 0000000..7323a48 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrActivity.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrActivity" 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_getConstrActivity</refname> + <refpurpose>Get the activity of the constraints in the solution</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrActivity()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the activity of the constraints in the solution.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns a matrix with 1 column and number of rows equal to number of constraints, that represents the activities of those constraints</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getConstrActivity()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getConstrLower.xml b/help/en_US/Symphony Native Function/sym_getConstrLower.xml new file mode 100644 index 0000000..8274813 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrLower.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrLower" 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_getConstrLower</refname> + <refpurpose>To get the lower bounds of the constraints.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrLower()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get lower bounds of constraints.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of lower bounds of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrLower()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getConstrRange.xml b/help/en_US/Symphony Native Function/sym_getConstrRange.xml new file mode 100644 index 0000000..402f313 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrRange.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrRange" 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_getConstrRange</refname> + <refpurpose>To to get the constraint ranges.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrRange()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the constraint ranges.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the constraint ranges.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrRange()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getConstrSense.xml b/help/en_US/Symphony Native Function/sym_getConstrSense.xml new file mode 100644 index 0000000..85d358c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrSense.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrSense" 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_getConstrSense</refname> + <refpurpose>To get the row senses.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrSense()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the row senses.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the row senses.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrSense()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getConstrUpper.xml b/help/en_US/Symphony Native Function/sym_getConstrUpper.xml new file mode 100644 index 0000000..5422d96 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrUpper.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrUpper" 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_getConstrUpper</refname> + <refpurpose>To get the upper bounds of the constraints.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrUpper()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get upper bounds of the constraints.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of upper bounds of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrUpper()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getDblParam.xml b/help/en_US/Symphony Native Function/sym_getDblParam.xml new file mode 100644 index 0000000..4e5d8f3 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getDblParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getDblParam" 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_getDblParam</refname> + <refpurpose>This routine is used to get the value of a double type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getDblParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the double parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getDblParam("time_limit")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getInfinity.xml b/help/en_US/Symphony Native Function/sym_getInfinity.xml new file mode 100644 index 0000000..295fd17 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getInfinity.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getInfinity" 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_getInfinity</refname> + <refpurpose>Get Symphony's infinity value</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getInfinity()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the value that Symphony considers to be infinity. This is equal to 10^20.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the infinity value of Symphony</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getInfinity()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getIntParam.xml b/help/en_US/Symphony Native Function/sym_getIntParam.xml new file mode 100644 index 0000000..a6626af --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getIntParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getIntParam" 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_getIntParam</refname> + <refpurpose>This routine is used to get the value of an integer type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getIntParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the integer parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getIntParam("verbosity")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getIterCount.xml b/help/en_US/Symphony Native Function/sym_getIterCount.xml new file mode 100644 index 0000000..ab7f42e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getIterCount.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getIterCount" 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_getIterCount</refname> + <refpurpose>To get the number of the analyzed nodes of the branching tree after solving the problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getIterCount()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the analyzed nodes of the branching tree after solving the problem.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns iteration count.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getIterCount()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getMatrix.xml b/help/en_US/Symphony Native Function/sym_getMatrix.xml new file mode 100644 index 0000000..fbcd87f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getMatrix.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getMatrix" 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_getMatrix</refname> + <refpurpose>To get the constraint matrix.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getMatrix()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the constraint matrix as sparse matrix in a standard row-ordered format.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row-ordered sparse matrix.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getMatrix()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getNumConstr.xml b/help/en_US/Symphony Native Function/sym_getNumConstr.xml new file mode 100644 index 0000000..63715fb --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumConstr.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumConstr" 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_getNumConstr</refname> + <refpurpose>To get the number of the constraints of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumConstr()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the constraints of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>If there was an error it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumConstr()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getNumElements.xml b/help/en_US/Symphony Native Function/sym_getNumElements.xml new file mode 100644 index 0000000..5ce71a9 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumElements.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumElements" 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_getNumElements</refname> + <refpurpose>To get the number of non-zero entries of the constraint matrix of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumElements()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of non-zero entries of the constraint matrix of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>If there was an error, it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of non-zero elements.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumElements()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getNumVar.xml b/help/en_US/Symphony Native Function/sym_getNumVar.xml new file mode 100644 index 0000000..5602811 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumVar.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumVar" 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_getNumVar</refname> + <refpurpose>To get the number of the variables of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumVar()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the variables of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>If there was an error it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of variables.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumVar()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getObjCoeff.xml b/help/en_US/Symphony Native Function/sym_getObjCoeff.xml new file mode 100644 index 0000000..194d3cd --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjCoeff.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjCoeff" 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_getObjCoeff</refname> + <refpurpose>To get the objective vector.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjCoeff()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the objective vector.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of coefficients of variables in objective.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getObjCoeff()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getObjSense.xml b/help/en_US/Symphony Native Function/sym_getObjSense.xml new file mode 100644 index 0000000..1d4f0fa --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjSense.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjSense" 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_getObjSense</refname> + <refpurpose>Get the objective sense</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjSense()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function gets the sense of the objective function (minimization/maximization).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the objective is to be minimized and -1 if the objective is to be maximized</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getObjSense()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getObjVal.xml b/help/en_US/Symphony Native Function/sym_getObjVal.xml new file mode 100644 index 0000000..9a65646 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjVal.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjVal" 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_getObjVal</refname> + <refpurpose>Get the optimized objective value</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjVal()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the optimized objective value after after solving the problem.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the optimized objective value</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getObjVal()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getPrimalBound.xml b/help/en_US/Symphony Native Function/sym_getPrimalBound.xml new file mode 100644 index 0000000..3b9db8d --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getPrimalBound.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getPrimalBound" 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_getPrimalBound</refname> + <refpurpose>Get the primal bound of the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getPrimalBound()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the primal bound of the loaded problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the primal bound of the problem</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getPrimalBound()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getRhs.xml b/help/en_US/Symphony Native Function/sym_getRhs.xml new file mode 100644 index 0000000..a0d1a76 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getRhs.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getRhs" 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_getRhs</refname> + <refpurpose>To to get the right hand side vector(column vector).</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getRhs()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the right hand side vector(coumn vector).</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the right hand side values of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getRhs()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getStatus.xml b/help/en_US/Symphony Native Function/sym_getStatus.xml new file mode 100644 index 0000000..f13e59e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getStatus.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getStatus" 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_getStatus</refname> + <refpurpose>To get status of the problem solver.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getStatus()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn the termination status of the solution procedure.</para> + <para>It prints status of the problem solver to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if it receives any return-value indicating an error message or 0 if it receives any return-value indicating a non-error message.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getStatus()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getStrParam.xml b/help/en_US/Symphony Native Function/sym_getStrParam.xml new file mode 100644 index 0000000..b261053 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getStrParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getStrParam" 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_getStrParam</refname> + <refpurpose>This routine is used to get the value of a string type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getStrParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the strung parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getStrParam("source_path")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getVarLower.xml b/help/en_US/Symphony Native Function/sym_getVarLower.xml new file mode 100644 index 0000000..771d095 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarLower.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarLower" 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_getVarLower</refname> + <refpurpose>To get the lower bounds of the variables.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarLower()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the lower bounds of the variables.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of lower bounds of the variables.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getVarLower()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getVarSoln.xml b/help/en_US/Symphony Native Function/sym_getVarSoln.xml new file mode 100644 index 0000000..5500c57 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarSoln.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarSoln" 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_getVarSoln</refname> + <refpurpose>Get the solution for the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarSoln()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the solution for the problem after solving it.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns a matrix with 1 row and number of columns equal to number of variables, that represents the solutions for those variables</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getVarSoln()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_getVarUpper.xml b/help/en_US/Symphony Native Function/sym_getVarUpper.xml new file mode 100644 index 0000000..a447a54 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarUpper.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarUpper" 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_getVarUpper</refname> + <refpurpose>To get the upper bounds of the variables.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarUpper()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the upper bounds of the variables.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of upper bounds of the variables.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getVarUpper()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isAbandoned.xml b/help/en_US/Symphony Native Function/sym_isAbandoned.xml new file mode 100644 index 0000000..1009201 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isAbandoned.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isAbandoned" 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_isAbandoned</refname> + <refpurpose>To check whether the problem was abandoned for some reason.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isAbandoned()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was abandoned for some reason.</para> + <para>It prints whether or not the problem was abandoned for some reason to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the problem was abandoned or 0 if the problem was not abandoned or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isAbandoned()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isBinary.xml b/help/en_US/Symphony Native Function/sym_isBinary.xml new file mode 100644 index 0000000..57a6cf3 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isBinary.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isBinary" 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_isBinary</refname> + <refpurpose>Check if a variable is constrained to be binary</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isBinary(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is constrained to be binary (0 or 1).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the variable is constrained to be binary and 0 if it is not.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isBinary(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isContinuous.xml b/help/en_US/Symphony Native Function/sym_isContinuous.xml new file mode 100644 index 0000000..8c6a77b --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isContinuous.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isContinuous" 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_isContinuous</refname> + <refpurpose>Check if a variable is continuous</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isContinuous(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is continuous.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the variable is continuous and 0 if it is not.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isContinuous(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isEnvActive.xml b/help/en_US/Symphony Native Function/sym_isEnvActive.xml new file mode 100644 index 0000000..b47e28b --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isEnvActive.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isEnvActive" 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_isEnvActive</refname> + <refpurpose>Check if Symphony environment is active</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isEnvActive()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Check if Symphony environment is active (open). Most Symphony functions will require the environment to be open.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment is active and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isEnvActive()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isInfeasible.xml b/help/en_US/Symphony Native Function/sym_isInfeasible.xml new file mode 100644 index 0000000..88a4f43 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isInfeasible.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isInfeasible" 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_isInfeasible</refname> + <refpurpose>To check whether the problem was proven to be infeasible.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isInfeasible()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was proven to be infeasible.</para> + <para>It prints whether or not the problem was proven to be infeasible to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the problem was solved proven to be infeasible or 0 if it was not proven to be infeasible or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isInfeasible()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isInteger.xml b/help/en_US/Symphony Native Function/sym_isInteger.xml new file mode 100644 index 0000000..e104039 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isInteger.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isInteger" 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_isInteger</refname> + + <refpurpose>Check if a variable is constrained to be an integer</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + + <synopsis>sym_isInteger(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is constrained to be an integer.</para> + <para>index : Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isInteger(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml b/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml new file mode 100644 index 0000000..013f984 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isIterLimitReached" 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_isIterLimitReached</refname> + <refpurpose>To know whether the iteration limit (node limit) was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isIterLimitReached()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the iteration limit(node limit) was reached.</para> + <para>It prints whether or not the iteration limit (node limit) was reached to scilab console.</para> + <para>It can also be used if "find first feasible" parameter was set to true before solving the problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the iteration limit is reached or 0 if the iteration limit is not reached or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isIterLimitReached()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isOptimal.xml b/help/en_US/Symphony Native Function/sym_isOptimal.xml new file mode 100644 index 0000000..889aa02 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isOptimal.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isOptimal" 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_isOptimal</refname> + <refpurpose>To check whether the problem was solved to optimality.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isOptimal()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was solved to</para> + <para>optimality.</para> + <para>It prints whether or not the problem was solved to optimality to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the problem was solved to optimality or 0 if it was not solved to optimality or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isOptimal()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml b/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml new file mode 100644 index 0000000..81c99b4 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isTargetGapAchieved" 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_isTargetGapAchieved</refname> + <refpurpose>To know whether the target gap was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isTargetGapAchieved()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the target gap was reached.</para> + <para>It print whether or not the target gap was reached.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the target gap was reached or 0 if the target gap was not reached or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isTargetGapAchieved()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml b/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml new file mode 100644 index 0000000..42889de --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isTimeLimitReached" 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_isTimeLimitReached</refname> + <refpurpose>To know whether the time limit was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isTimeLimitReached()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the time limit was reached.</para> + <para>It prints whether or not the time limit was reached to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the time limit was reached or 0 if the time limit was not reached or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isTimeLimitReached()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_loadMPS.xml b/help/en_US/Symphony Native Function/sym_loadMPS.xml new file mode 100644 index 0000000..6e55cff --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_loadMPS.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadMPS" 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_loadMPS</refname> + <refpurpose>This routine is used to load an instance from an MPS file.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadMPS(filename)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>filename</term> + <listitem><para>It is a string that has the path of the .mps file to loaded.It has to be given within double quotes ("")</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the .mps file is loaded properly to symphony and 0 if there is an error reading the mps file or the function returns with an error return value</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_loadMPS("./sample.mps") -mps file present in the current directory of execution can be mentioned this way also</programlisting> + <programlisting role="example">status=sym_loadMPS("/home/Desktop/sample.mps") -mps file present at a different location must be specified with their entire path</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_loadProblem.xml b/help/en_US/Symphony Native Function/sym_loadProblem.xml new file mode 100644 index 0000000..e2409c5 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_loadProblem.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadProblem" 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_loadProblem</refname> + <refpurpose>Load a problem into Symphony</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadProblem(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> + + </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>Sparse matrix 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_loadProblem(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,sparse([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> + diff --git a/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml b/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml new file mode 100644 index 0000000..90a5995 --- /dev/null +++ b/help/en_US/Symphony Native Function/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> + diff --git a/help/en_US/Symphony Native Function/sym_open.xml b/help/en_US/Symphony Native Function/sym_open.xml new file mode 100644 index 0000000..92b3dec --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_open.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_open" 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_open</refname> + <refpurpose>Open the Symphony environment</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_open()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Opens the Symphony environment. The environment and all data loaded into it is maintained across function calls.</para> + <para>This function fails if the environment is already open.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment was successfully opened and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_open()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + <member>Iswarya</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_resetParams.xml b/help/en_US/Symphony Native Function/sym_resetParams.xml new file mode 100644 index 0000000..a73fdbd --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_resetParams.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_resetParams" 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_resetParams</refname> + <refpurpose>This routine sets all the environment variables and parameters to their default values.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_resetParams()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the environment variables and parameters are set to their default value and 1 if a value corresponding to an error is returned</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_resetParams()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setConstrLower.xml b/help/en_US/Symphony Native Function/sym_setConstrLower.xml new file mode 100644 index 0000000..ae68046 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrLower.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrLower" 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_setConstrLower</refname> + <refpurpose>Set the lower bound of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrLower(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the lower bound of a constraint</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new lower bound for the constraint</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrLower(2,-100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setConstrType.xml b/help/en_US/Symphony Native Function/sym_setConstrType.xml new file mode 100644 index 0000000..18afed0 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrType.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrType" 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_setConstrType</refname> + <refpurpose>Set the type of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrType(index,type,bound1[,bound2])</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function completely modifies the type of a constraint. Supported types of constraints are less than or equal to, more than or equal to, equal to, or ranged.</para> + <para>The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem><para>New type of the constraint. Supported types: less than or equal to ("L"), greater than or equal to ("G"), equal to ("E"), or ranged ("R")</para></listitem> + </varlistentry> + <varlistentry> + <term>bound1</term> + <listitem><para>The first (or only) bound for the constraint</para></listitem> + </varlistentry> + <varlistentry> + <term>bound2</term> + <listitem><para>The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrType(2,"R",-10,10)</programlisting> + <programlisting role="example">sym_setConstrType(3,"E",100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setConstrUpper.xml b/help/en_US/Symphony Native Function/sym_setConstrUpper.xml new file mode 100644 index 0000000..676454c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrUpper.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrUpper" 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_setConstrUpper</refname> + <refpurpose>Set the upper bound of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrUpper(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the upper bound of a constraint</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new upper bound for the constraint</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrUpper(2,-100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setContinuous.xml b/help/en_US/Symphony Native Function/sym_setContinuous.xml new file mode 100644 index 0000000..f4948d9 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setContinuous.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setContinuous" 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_setContinuous</refname> + <refpurpose>This routine is used to set the type of a variable to be continuous.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setContinuous(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to be set continuous</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the variable type has been set as continuous and 0 if an error value is returned.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setContinuous(1)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setDblParam.xml b/help/en_US/Symphony Native Function/sym_setDblParam.xml new file mode 100644 index 0000000..464d29e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setDblParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setDblParam" 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_setDblParam</refname> + <refpurpose>This routine is used to set a double type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setDblParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the double type parameter to be set. Note: should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding double parameter</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the double parameter was unsuccessful due to invalid inputs</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setDblParam("time_limit",5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setIntParam.xml b/help/en_US/Symphony Native Function/sym_setIntParam.xml new file mode 100644 index 0000000..e20dfb5 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setIntParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setIntParam" 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_setIntParam</refname> + <refpurpose>This routine is used to set an integer type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setIntParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the parameter to be set. Note:should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding integer parameter</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the integer parameter was unsuccessful due to invalid inputs</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setIntParam("verbosity",5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setInteger.xml b/help/en_US/Symphony Native Function/sym_setInteger.xml new file mode 100644 index 0000000..cebb83f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setInteger.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setInteger" 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_setInteger</refname> + <refpurpose>This routine is used to set the type of a variable to be integer.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setInteger(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>The index of the variable type to be modified as integer. Note that, it has to be at most the number of columns.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the variable type has been set as integer and 0 if an error value is returned.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setInteger(1)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setObjCoeff.xml b/help/en_US/Symphony Native Function/sym_setObjCoeff.xml new file mode 100644 index 0000000..5251b4c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setObjCoeff.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setObjCoeff" 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_setObjCoeff</refname> + <refpurpose>Set coefficient of a variable in the objective</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setObjCoeff(index,newCoeff)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the coefficient of a variable in the objective function</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newCoeff</term> + <listitem><para>The new coefficient of the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setObjCoeff(2,1.5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setObjSense.xml b/help/en_US/Symphony Native Function/sym_setObjSense.xml new file mode 100644 index 0000000..356ea97 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setObjSense.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setObjSense" 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_setObjSense</refname> + <refpurpose>Set the objective sense</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setObjSense(sense)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function sets the sense of the objective function (minimization/maximization).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>sense</term> + <listitem><para>The new sense of the objective function. Use sym_minimize or sym_maximize here</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setObjSense(sym_minimize)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setPrimalBound.xml b/help/en_US/Symphony Native Function/sym_setPrimalBound.xml new file mode 100644 index 0000000..c2f29a7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setPrimalBound.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setPrimalBound" 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_setPrimalBound</refname> + <refpurpose>Set the primal bound of the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setPrimalBound(bound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Set the primal bound of the loaded problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>bound</term> + <listitem><para>The new primal bound for the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setPrimalBound(10)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setStrParam.xml b/help/en_US/Symphony Native Function/sym_setStrParam.xml new file mode 100644 index 0000000..09c5ea8 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setStrParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setStrParam" 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_setStrParam</refname> + <refpurpose>This routine is used to set a string type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setStrParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the string type parameter to be set. Note: should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding string parameter. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the string parameter was unsuccessful due to invalid inputs</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setStrParam("source_path","..")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setVarLower.xml b/help/en_US/Symphony Native Function/sym_setVarLower.xml new file mode 100644 index 0000000..1f24813 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarLower.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarLower" 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_setVarLower</refname> + <refpurpose>Set lower bound of a variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarLower(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the lower bound of a variable to a new value</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new lower bound for the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarLower(2,-%inf)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setVarSoln.xml b/help/en_US/Symphony Native Function/sym_setVarSoln.xml new file mode 100644 index 0000000..5fe6f3c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarSoln.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarSoln" 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_setVarSoln</refname> + <refpurpose>Set a solution for the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarSoln(solution)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Sets a known solution for the problem.</para> + <para>This function fails if the solution entered does not satisfy all bounds or is worse than another currently known solution.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>solution</term> + <listitem><para>Matrix containing solutions for the variables (must have size 1 row and number of columns equal to number of variables)</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarSoln([1,2,3.2,4])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_setVarUpper.xml b/help/en_US/Symphony Native Function/sym_setVarUpper.xml new file mode 100644 index 0000000..286c45f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarUpper.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarUpper" 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_setVarUpper</refname> + <refpurpose>Set upper bound of a variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarUpper(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the upper bound of a variable to a new value</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new upper bound for the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarUpper(2,100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/Symphony Native Function/sym_solve.xml b/help/en_US/Symphony Native Function/sym_solve.xml new file mode 100644 index 0000000..587b26a --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_solve.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_solve" 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_solve</refname> + <refpurpose>To solve the currently loaded MILP problem from scratch.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_solve()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine solves the currently loaded MILP problem from scratch.</para> + <para>It prints status of the problem solver to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if it receives any return-value indicating an error message or 0 if it receives any return-value indicating a non-error message.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_solve()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + |