summaryrefslogtreecommitdiff
path: root/help/en_US/symphony.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/symphony.xml')
-rw-r--r--help/en_US/symphony.xml48
1 files changed, 24 insertions, 24 deletions
diff --git a/help/en_US/symphony.xml b/help/en_US/symphony.xml
index 1f77555..c0caa8e 100644
--- a/help/en_US/symphony.xml
+++ b/help/en_US/symphony.xml
@@ -24,9 +24,9 @@
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
- xopt = symphony(nbVar,nbCon,objCoef,isInt,LB,UB,conMatrix,conLB,conUB)
- xopt = symphony(nbVar,nbCon,objCoef,isInt,LB,UB,conMatrix,conLB,conUB,objSense)
- xopt = symphony(nbVar,nbCon,objCoef,isInt,LB,UB,conMatrix,conLB,conUB,objSense,options)
+ xopt = symphony(nbVar,nbCon,c,isInt,lb,ub,A,conLB,conUB)
+ xopt = symphony(nbVar,nbCon,c,isInt,lb,ub,A,conLB,conUB,objSense)
+ xopt = symphony(nbVar,nbCon,c,isInt,lb,ub,A,conLB,conUB,objSense,options)
[xopt,fopt,status,output] = symphony( ... )
</synopsis>
@@ -39,15 +39,15 @@
<listitem><para> a double, number of variables.</para></listitem></varlistentry>
<varlistentry><term>nbCon :</term>
<listitem><para> a double, number of constraints.</para></listitem></varlistentry>
- <varlistentry><term>objCoeff :</term>
+ <varlistentry><term>c :</term>
<listitem><para> a vector of double, represents coefficients of the variables in the objective.</para></listitem></varlistentry>
<varlistentry><term>isInt :</term>
<listitem><para> a vector of boolean, represents wether a variable is constrained to be an integer.</para></listitem></varlistentry>
- <varlistentry><term>LB :</term>
+ <varlistentry><term>lb :</term>
<listitem><para> a vector of double, represents lower bounds of the variables.</para></listitem></varlistentry>
- <varlistentry><term>UB :</term>
+ <varlistentry><term>ub :</term>
<listitem><para> a vector of double, represents upper bounds of the variables.</para></listitem></varlistentry>
- <varlistentry><term>conMatrix :</term>
+ <varlistentry><term>A :</term>
<listitem><para> a matrix of double, represents matrix representing the constraint matrix.</para></listitem></varlistentry>
<varlistentry><term>conLB :</term>
<listitem><para> a vector of double, represents lower bounds of the constraints.</para></listitem></varlistentry>
@@ -56,15 +56,15 @@
<varlistentry><term>objSense :</term>
<listitem><para> The sense (maximization/minimization) of the objective. Use 1(sym_minimize ) or -1 (sym_maximize) here.</para></listitem></varlistentry>
<varlistentry><term>options :</term>
- <listitem><para> a a list containing the the parameters to be set.</para></listitem></varlistentry>
+ <listitem><para> a list containing the the parameters to be set.</para></listitem></varlistentry>
<varlistentry><term>xopt :</term>
<listitem><para> a vector of double, the computed solution of the optimization problem.</para></listitem></varlistentry>
<varlistentry><term>fopt :</term>
<listitem><para> a double, the function value at x.</para></listitem></varlistentry>
<varlistentry><term>status :</term>
- <listitem><para> status flag from symphony.</para></listitem></varlistentry>
+ <listitem><para> status flag from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded.</para></listitem></varlistentry>
<varlistentry><term>output :</term>
- <listitem><para> The output data structure contains detailed informations about the optimization process. Right now it contains number of iteration.</para></listitem></varlistentry>
+ <listitem><para> The output data structure contains detailed information about the optimization process. This version only contains number of iterations</para></listitem></varlistentry>
</variablelist>
</refsection>
@@ -78,15 +78,15 @@ find the minimum or maximum of f(x) such that
<latex>
\begin{eqnarray}
&amp;\mbox{min}_{x}
-&amp; f^T*x \\
-&amp; \text{subject to} &amp; conLB \leq C*x \leq conUB \\
+&amp; f^T⋅x \\
+&amp; \text{subject to} &amp; conLB \leq A⋅x \leq conUB \\
&amp; &amp; lb \leq x \leq ub \\
&amp; &amp; x_i \in \!\, \mathbb{Z}, i \in \!\, I
\end{eqnarray}
</latex>
</para>
<para>
-We are calling SYMPHONY written in C by gateway files for the actual computation.
+The routine calls SYMPHONY written in C by gateway files for the actual computation.
</para>
<para>
</para>
@@ -97,25 +97,25 @@ We are calling SYMPHONY written in C by gateway files for the actual computation
<programlisting role="example"><![CDATA[
//A basic case :
// Objective function
-objCoef = [350*5,330*3,310*4,280*6,500,450,400,100]';
+c = [350*5,330*3,310*4,280*6,500,450,400,100]';
// Lower Bound of variable
lb = repmat(0,8,1);
// Upper Bound of variables
ub = [repmat(1,4,1);repmat(%inf,4,1)];
// Constraint Matrix
-conMatrix = [5,3,4,6,1,1,1,1;
+A = [5,3,4,6,1,1,1,1;
5*0.05,3*0.04,4*0.05,6*0.03,0.08,0.07,0.06,0.03;
5*0.03,3*0.03,4*0.04,6*0.04,0.06,0.07,0.08,0.09;]
-// Lower Bound of constrains
+// Lower Bound of constraints
conlb = [ 25; 1.25; 1.25]
-// Upper Bound of constrains
+// Upper Bound of constraints
conub = [ 25; 1.25; 1.25]
// Row Matrix for telling symphony that the is integer or not
isInt = [repmat(%t,1,4) repmat(%f,1,4)];
xopt = [1 1 0 1 7.25 0 0.25 3.5]
fopt = [8495]
// Calling Symphony
-[x,f,status,output] = symphony(8,3,c,isInt,lb,ub,conMatrix,conlb,conub,1)
+[x,f,status,output] = symphony(8,3,c,isInt,lb,ub,A,conlb,conub,1)
// Press ENTER to continue
]]></programlisting>
@@ -134,7 +134,7 @@ fopt = [8495]
// st sum{j=1,...,n} r(i,j)x(j) <= b(i) i=1,...,m
// x(j)=0 or 1
// The function to be maximize i.e. P(j)
-p = [ 504 803 667 1103 834 585 811 856 690 832 846 813 868 793 ..
+c = [ 504 803 667 1103 834 585 811 856 690 832 846 813 868 793 ..
825 1002 860 615 540 797 616 660 707 866 647 746 1006 608 ..
877 900 573 788 484 853 942 630 591 630 640 1169 932 1034 ..
957 798 669 625 467 1051 552 717 654 388 559 555 1104 783 ..
@@ -142,7 +142,7 @@ p = [ 504 803 667 1103 834 585 811 856 690 832 846 813 868 793 ..
510 671 575 740 510 675 996 636 826 1022 1140 654 909 799 ..
1162 653 814 625 599 476 767 954 906 904 649 873 565 853 1008 632]';
//Constraint Matrix
-conMatrix = [
+A = [
//Constraint 1
42 41 523 215 819 551 69 193 582 375 367 478 162 898 ..
550 553 298 577 493 183 260 224 852 394 958 282 402 604 ..
@@ -184,15 +184,15 @@ conMatrix = [
483 336 765 637 981 980 202 35 594 689 602 76 767 693 ..
893 160 785 311 417 748 375 362 617 553 474 915 457 261 350 635 ;
];
-nbCon = size(conMatrix,1)
-nbVar = size(conMatrix,2)
+nbCon = size(A,1)
+nbVar = size(A,2)
// Lower Bound of variables
lb = repmat(0,nbVar,1)
// Upper Bound of variables
ub = repmat(1,nbVar,1)
// Row Matrix for telling symphony that the is integer or not
isInt = repmat(%t,1,nbVar)
-// Lower Bound of constrains
+// Lower Bound of constraints
conLB=repmat(0,nbCon,1);
// Upper Bound of constraints
conUB=[11927 13727 11551 13056 13460 ]';
@@ -205,7 +205,7 @@ xopt = [0 1 1 0 0 1 0 1 0 1 0 0 0 0 0 0 0 1 0 0 0 0 1 0 1 1 0 1 1 0 1 ..
// Optimal value
fopt = [ 24381 ]
// Calling Symphony
-[x,f,status,output] = symphony(nbVar,nbCon,p,isInt,lb,ub,conMatrix,conLB,conUB,-1,options);
+[x,f,status,output] = symphony(nbVar,nbCon,c,isInt,lb,ub,A,conLB,conUB,-1,options);
]]></programlisting>
</refsection>