From dad86bd42cdc2a0e56df9e0591879e5d26fd56fa Mon Sep 17 00:00:00 2001 From: Harpreet Date: Tue, 5 Jan 2016 12:22:43 +0530 Subject: constrviolation and licence file added --- help/en_US/lsqlin.xml | 41 +++++++++++++++++-- help/en_US/lsqnonneg.xml | 37 +++++++++++++++-- help/en_US/qpipopt.xml | 45 ++++++++++++++++++--- help/en_US/qpipoptmat.xml | 43 +++++++++++++++++--- help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS | Bin 6899 -> 7094 bytes .../scilab_en_US_help/JavaHelpSearch/DOCS.TAB | Bin 761 -> 781 bytes .../en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS | Bin 264 -> 266 bytes .../scilab_en_US_help/JavaHelpSearch/POSITIONS | Bin 33375 -> 34656 bytes help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA | 2 +- help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP | Bin 14336 -> 16384 bytes help/en_US/scilab_en_US_help/lsqlin.html | 27 +++++++++++-- help/en_US/scilab_en_US_help/lsqnonneg.html | 23 +++++++++-- help/en_US/scilab_en_US_help/qpipopt.html | 31 +++++++++++--- help/en_US/scilab_en_US_help/qpipoptmat.html | 29 ++++++++++--- help/en_US/scilab_en_US_help/symphony.html | 17 ++++++-- help/en_US/scilab_en_US_help/symphonymat.html | 17 ++++++-- help/en_US/symphony.xml | 27 +++++++++++-- help/en_US/symphonymat.xml | 27 +++++++++++-- 18 files changed, 313 insertions(+), 53 deletions(-) (limited to 'help') diff --git a/help/en_US/lsqlin.xml b/help/en_US/lsqlin.xml index c6ec286..0904933 100644 --- a/help/en_US/lsqlin.xml +++ b/help/en_US/lsqlin.xml @@ -56,7 +56,7 @@ x0 : a vector of double, contains initial guess of variables. param : - a list containing the the parameters to be set. + a list containing the parameters to be set. xopt : a vector of double, the computed solution of the optimization problem. resnorm : @@ -64,11 +64,11 @@ residual : a vector of double, solution residuals returned as the vector d-C*x. exitflag : - A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro. + The exit status. See below for details. output : - Structure containing information about the optimization. This version only contains number of iterations. + The structure consist of statistics about the optimization. See below for details. lambda : - Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier. + The structure consist of the Lagrange multipliers at the solution of problem. See below for details. @@ -92,6 +92,39 @@ Search the minimum of a constrained linear least square problem specified by : The routine calls Ipopt for solving the linear least square problem, Ipopt is a library written in C++. +The exitflag allows to know the status of the optimization which is given back by Ipopt. + +exitflag=0 : Optimal Solution Found +exitflag=1 : Maximum Number of Iterations Exceeded. Output may not be optimal. +exitflag=2 : Maximum CPU Time exceeded. Output may not be optimal. +exitflag=3 : Stop at Tiny Step. +exitflag=4 : Solved To Acceptable Level. +exitflag=5 : Converged to a point of local infeasibility. + + + +For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search +output.constrviolation: The max-norm of the constraint violation. + + + +The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. + +lambda.lower: The Lagrange multipliers for the lower bound constraints. +lambda.upper: The Lagrange multipliers for the upper bound constraints. +lambda.eqlin: The Lagrange multipliers for the linear equality constraints. +lambda.ineqlin: The Lagrange multipliers for the linear inequality constraints. + + + diff --git a/help/en_US/lsqnonneg.xml b/help/en_US/lsqnonneg.xml index 5d78bbd..201e878 100644 --- a/help/en_US/lsqnonneg.xml +++ b/help/en_US/lsqnonneg.xml @@ -45,11 +45,11 @@ residual : a vector of double, solution residuals returned as the vector d-C*x. exitflag : - A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro. + The exit status. See below for details. output : - Structure containing information about the optimization. This version only contains number of iterations. + The structure consist of statistics about the optimization. See below for details. lambda : - Structure containing the Lagrange multipliers at the solution xopt. It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier. + The structure consist of the Lagrange multipliers at the solution of problem. See below for details. @@ -71,6 +71,37 @@ Solves nonnegative least-squares curve fitting problems specified by : The routine calls Ipopt for solving the nonnegative least-squares curve fitting problems, Ipopt is a library written in C++. +The exitflag allows to know the status of the optimization which is given back by Ipopt. + +exitflag=0 : Optimal Solution Found +exitflag=1 : Maximum Number of Iterations Exceeded. Output may not be optimal. +exitflag=2 : Maximum CPU Time exceeded. Output may not be optimal. +exitflag=3 : Stop at Tiny Step. +exitflag=4 : Solved To Acceptable Level. +exitflag=5 : Converged to a point of local infeasibility. + + + +For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search +output.constrviolation: The max-norm of the constraint violation. + + + +The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. + +lambda.lower: The Lagrange multipliers for the lower bound constraints. +lambda.upper: The Lagrange multipliers for the upper bound constraints. + + + diff --git a/help/en_US/qpipopt.xml b/help/en_US/qpipopt.xml index 3ba2107..170b457 100644 --- a/help/en_US/qpipopt.xml +++ b/help/en_US/qpipopt.xml @@ -48,7 +48,7 @@ ub : a vector of double, contains upper bounds of the variables. A : - a matrix of double, contains matrix representing the constraint matrix + a matrix of double, contains the constraint matrix conLB : a vector of double, contains lower bounds of the constraints. conUB : @@ -56,17 +56,17 @@ x0 : a vector of double, contains initial guess of variables. param : - a list containing the the parameters to be set. + a list containing the parameters to be set. xopt : a vector of double, the computed solution of the optimization problem. fopt : - a double, the function value at x. + a double, the value of the function at x. exitflag : - A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro. + The exit status. See below for details. output : - Structure containing information about the optimization. This version only contains number of iterations + The structure consist of statistics about the optimization. See below for details. lambda : - Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier. + The structure consist of the Lagrange multipliers at the solution of problem. See below for details. @@ -89,6 +89,39 @@ Search the minimum of a constrained linear quadratic optimization problem specif The routine calls Ipopt for solving the quadratic problem, Ipopt is a library written in C++. +The exitflag allows to know the status of the optimization which is given back by Ipopt. + +exitflag=0 : Optimal Solution Found +exitflag=1 : Maximum Number of Iterations Exceeded. Output may not be optimal. +exitflag=2 : Maximum CPU Time exceeded. Output may not be optimal. +exitflag=3 : Stop at Tiny Step. +exitflag=4 : Solved To Acceptable Level. +exitflag=5 : Converged to a point of local infeasibility. + + + +For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search +output.constrviolation: The max-norm of the constraint violation. + + + +The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. + +lambda.lower: The Lagrange multipliers for the lower bound constraints. +lambda.upper: The Lagrange multipliers for the upper bound constraints. +lambda.eqlin: The Lagrange multipliers for the linear equality constraints. +lambda.ineqlin: The Lagrange multipliers for the linear inequality constraints. + + + diff --git a/help/en_US/qpipoptmat.xml b/help/en_US/qpipoptmat.xml index 1334603..82249a7 100644 --- a/help/en_US/qpipoptmat.xml +++ b/help/en_US/qpipoptmat.xml @@ -57,19 +57,19 @@ x0 : a vector of double, contains initial guess of variables. param : - a list containing the the parameters to be set. + a list containing the parameters to be set. xopt : a vector of double, the computed solution of the optimization problem. fopt : - a double, the function value at x. + a double, the value of the function at x. residual : a vector of double, solution residuals returned as the vector d-C*x. exitflag : - A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro. + The exit status. See below for details. output : - Structure containing information about the optimization. This version only contains number of iterations. + The structure consist of statistics about the optimization. See below for details. lambda : - Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier. + The structure consist of the Lagrange multipliers at the solution of problem. See below for details. @@ -93,6 +93,39 @@ Search the minimum of a constrained linear quadratic optimization problem specif The routine calls Ipopt for solving the quadratic problem, Ipopt is a library written in C++. +The exitflag allows to know the status of the optimization which is given back by Ipopt. + +exitflag=0 : Optimal Solution Found +exitflag=1 : Maximum Number of Iterations Exceeded. Output may not be optimal. +exitflag=2 : Maximum CPU Time exceeded. Output may not be optimal. +exitflag=3 : Stop at Tiny Step. +exitflag=4 : Solved To Acceptable Level. +exitflag=5 : Converged to a point of local infeasibility. + + + +For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search +output.constrviolation: The max-norm of the constraint violation. + + + +The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. + +lambda.lower: The Lagrange multipliers for the lower bound constraints. +lambda.upper: The Lagrange multipliers for the upper bound constraints. +lambda.eqlin: The Lagrange multipliers for the linear equality constraints. +lambda.ineqlin: The Lagrange multipliers for the linear inequality constraints. + + + diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS index d3146bf..8323669 100644 Binary files a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS and b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS differ diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB index f0a1fcb..ba30e61 100644 Binary files a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB and b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB differ diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS index 8a63187..6e8476f 100644 Binary files a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS and b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS differ diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS index 423d132..9cd3f49 100644 Binary files a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS and b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS differ diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA index 6df2edb..f4e9ef7 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA @@ -1,2 +1,2 @@ JavaSearch 1.0 -TMAP bs=2048 rt=1 fl=-1 id1=1249 id2=1 +TMAP bs=2048 rt=1 fl=-1 id1=1280 id2=1 diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP index 6104335..12891d8 100644 Binary files a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP and b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP differ diff --git a/help/en_US/scilab_en_US_help/lsqlin.html b/help/en_US/scilab_en_US_help/lsqlin.html index e9253c5..7dbb227 100644 --- a/help/en_US/scilab_en_US_help/lsqlin.html +++ b/help/en_US/scilab_en_US_help/lsqlin.html @@ -64,7 +64,7 @@
x0 :

a vector of double, contains initial guess of variables.

param : -

a list containing the the parameters to be set.

+

a list containing the parameters to be set.

xopt :

a vector of double, the computed solution of the optimization problem.

resnorm : @@ -72,16 +72,35 @@
residual :

a vector of double, solution residuals returned as the vector d-C*x.

exitflag : -

A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro.

+

The exit status. See below for details.

output : -

Structure containing information about the optimization. This version only contains number of iterations.

+

The structure consist of statistics about the optimization. See below for details.

lambda : -

Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier.

+

The structure consist of the Lagrange multipliers at the solution of problem. See below for details.

Description

Search the minimum of a constrained linear least square problem specified by :

The routine calls Ipopt for solving the linear least square problem, Ipopt is a library written in C++.

+

The exitflag allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

+

The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/scilab_en_US_help/lsqnonneg.html b/help/en_US/scilab_en_US_help/lsqnonneg.html index 7211c40..a8e6801 100644 --- a/help/en_US/scilab_en_US_help/lsqnonneg.html +++ b/help/en_US/scilab_en_US_help/lsqnonneg.html @@ -53,16 +53,33 @@
residual :

a vector of double, solution residuals returned as the vector d-C*x.

exitflag : -

A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro.

+

The exit status. See below for details.

output : -

Structure containing information about the optimization. This version only contains number of iterations.

+

The structure consist of statistics about the optimization. See below for details.

lambda : -

Structure containing the Lagrange multipliers at the solution xopt. It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier.

+

The structure consist of the Lagrange multipliers at the solution of problem. See below for details.

Description

Solves nonnegative least-squares curve fitting problems specified by :

The routine calls Ipopt for solving the nonnegative least-squares curve fitting problems, Ipopt is a library written in C++.

+

The exitflag allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

+

The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/scilab_en_US_help/qpipopt.html b/help/en_US/scilab_en_US_help/qpipopt.html index 31f389f..fc08a81 100644 --- a/help/en_US/scilab_en_US_help/qpipopt.html +++ b/help/en_US/scilab_en_US_help/qpipopt.html @@ -56,7 +56,7 @@
ub :

a vector of double, contains upper bounds of the variables.

A : -

a matrix of double, contains matrix representing the constraint matrix

+

a matrix of double, contains the constraint matrix

conLB :

a vector of double, contains lower bounds of the constraints.

conUB : @@ -64,22 +64,41 @@
x0 :

a vector of double, contains initial guess of variables.

param : -

a list containing the the parameters to be set.

+

a list containing the parameters to be set.

xopt :

a vector of double, the computed solution of the optimization problem.

fopt : -

a double, the function value at x.

+

a double, the value of the function at x.

exitflag : -

A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro.

+

The exit status. See below for details.

output : -

Structure containing information about the optimization. This version only contains number of iterations

+

The structure consist of statistics about the optimization. See below for details.

lambda : -

Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier.

+

The structure consist of the Lagrange multipliers at the solution of problem. See below for details.

Description

Search the minimum of a constrained linear quadratic optimization problem specified by :

The routine calls Ipopt for solving the quadratic problem, Ipopt is a library written in C++.

+

The exitflag allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

+

The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/scilab_en_US_help/qpipoptmat.html b/help/en_US/scilab_en_US_help/qpipoptmat.html index 6c195ea..4a89648 100644 --- a/help/en_US/scilab_en_US_help/qpipoptmat.html +++ b/help/en_US/scilab_en_US_help/qpipoptmat.html @@ -65,24 +65,43 @@
x0 :

a vector of double, contains initial guess of variables.

param : -

a list containing the the parameters to be set.

+

a list containing the parameters to be set.

xopt :

a vector of double, the computed solution of the optimization problem.

fopt : -

a double, the function value at x.

+

a double, the value of the function at x.

residual :

a vector of double, solution residuals returned as the vector d-C*x.

exitflag : -

A flag showing returned exit flag from Ipopt. It could be 0, 1 or 2 etc. i.e. Optimal, Maximum Number of Iterations Exceeded, CPU time exceeded. Other flags one can see in the lsqlin macro.

+

The exit status. See below for details.

output : -

Structure containing information about the optimization. This version only contains number of iterations.

+

The structure consist of statistics about the optimization. See below for details.

lambda : -

Structure containing the Lagrange multipliers at the solution x (separated by constraint type).It contains lower, upper bound multiplier and linear equality, inequality constraint multiplier.

+

The structure consist of the Lagrange multipliers at the solution of problem. See below for details.

Description

Search the minimum of a constrained linear quadratic optimization problem specified by :

The routine calls Ipopt for solving the quadratic problem, Ipopt is a library written in C++.

+

The exitflag allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on exitflag see the ipopt documentation, go to http://www.coin-or.org/Ipopt/documentation/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

+

The lambda data structure contains the Lagrange multipliers at the end +of optimization. In the current version the values are returned only when the the solution is optimal. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/scilab_en_US_help/symphony.html b/help/en_US/scilab_en_US_help/symphony.html index e374a30..d5b21cd 100644 --- a/help/en_US/scilab_en_US_help/symphony.html +++ b/help/en_US/scilab_en_US_help/symphony.html @@ -64,20 +64,29 @@
objSense :

The sense (maximization/minimization) of the objective. Use 1(sym_minimize ) or -1 (sym_maximize) here.

options : -

a list containing the the parameters to be set.

+

a list containing the parameters to be set.

xopt :

a vector of double, the computed solution of the optimization problem.

fopt : -

a double, the function value at x.

+

a double, the value of the function at x.

status : -

status flag returned from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded.

+

status flag returned from symphony.See below for details.

output : -

The output data structure contains detailed information about the optimization process. This version only contains number of iterations

+

The output data structure contains detailed information about the optimization process. See below for details.

Description

Search the minimum or maximum of a constrained mixed integer linear programming optimization problem specified by :

The routine calls SYMPHONY written in C by gateway files for the actual computation.

+

The status allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on status see the symphony documentation, go to http://www.coin-or.org/SYMPHONY/man-5.6/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/scilab_en_US_help/symphonymat.html b/help/en_US/scilab_en_US_help/symphonymat.html index 203f2d4..db8ffee 100644 --- a/help/en_US/scilab_en_US_help/symphonymat.html +++ b/help/en_US/scilab_en_US_help/symphonymat.html @@ -61,20 +61,29 @@
ub :

Upper bounds, specified as a vector or array of double. ub represents the upper bounds elementwise in lb ≤ x ≤ ub.

options : -

a list containing the the parameters to be set.

+

a list containing the parameters to be set.

xopt :

a vector of double, the computed solution of the optimization problem.

fopt : -

a double, the function value at x

+

a double, the value of the function at x.

status : -

status flag returned from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded.

+

status flag returned from symphony. See below for details.

output : -

The output data structure contains detailed information about the optimization process. This version only contains number of iterations.

+

The output data structure contains detailed information about the optimization process. See below for details.

Description

Search the minimum or maximum of a constrained mixed integer linear programming optimization problem specified by :

The routine calls SYMPHONY written in C by gateway files for the actual computation.

+

The status allows to know the status of the optimization which is given back by Ipopt. +

+

For more details on status see the symphony documentation, go to http://www.coin-or.org/SYMPHONY/man-5.6/

+

The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. +

Examples

diff --git a/help/en_US/symphony.xml b/help/en_US/symphony.xml index da156ce..68f1742 100644 --- a/help/en_US/symphony.xml +++ b/help/en_US/symphony.xml @@ -56,15 +56,15 @@ objSense : The sense (maximization/minimization) of the objective. Use 1(sym_minimize ) or -1 (sym_maximize) here. options : - a list containing the the parameters to be set. + a list containing the parameters to be set. xopt : a vector of double, the computed solution of the optimization problem. fopt : - a double, the function value at x. + a double, the value of the function at x. status : - status flag returned from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded. + status flag returned from symphony.See below for details. output : - The output data structure contains detailed information about the optimization process. This version only contains number of iterations + The output data structure contains detailed information about the optimization process. See below for details. @@ -88,6 +88,25 @@ Search the minimum or maximum of a constrained mixed integer linear programming The routine calls SYMPHONY written in C by gateway files for the actual computation. +The status allows to know the status of the optimization which is given back by Ipopt. + +status=227 : Optimal Solution Found +status=228 : Maximum CPU Time exceeded. +status=229 : Maximum Number of Node Limit Exceeded. +status=230 : Maximum Number of Iterations Limit Exceeded. + + + +For more details on status see the symphony documentation, go to http://www.coin-or.org/SYMPHONY/man-5.6/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search + + + diff --git a/help/en_US/symphonymat.xml b/help/en_US/symphonymat.xml index 68ec072..33ed973 100644 --- a/help/en_US/symphonymat.xml +++ b/help/en_US/symphonymat.xml @@ -53,15 +53,15 @@ ub : Upper bounds, specified as a vector or array of double. ub represents the upper bounds elementwise in lb ≤ x ≤ ub. options : - a list containing the the parameters to be set. + a list containing the parameters to be set. xopt : a vector of double, the computed solution of the optimization problem. fopt : - a double, the function value at x + a double, the value of the function at x. status : - status flag returned from symphony. 227 is optimal, 228 is Time limit exceeded, 230 is iteration limit exceeded. + status flag returned from symphony. See below for details. output : - The output data structure contains detailed information about the optimization process. This version only contains number of iterations. + The output data structure contains detailed information about the optimization process. See below for details. @@ -86,6 +86,25 @@ Search the minimum or maximum of a constrained mixed integer linear programming The routine calls SYMPHONY written in C by gateway files for the actual computation. +The status allows to know the status of the optimization which is given back by Ipopt. + +status=227 : Optimal Solution Found +status=228 : Maximum CPU Time exceeded. +status=229 : Maximum Number of Node Limit Exceeded. +status=230 : Maximum Number of Iterations Limit Exceeded. + + + +For more details on status see the symphony documentation, go to http://www.coin-or.org/SYMPHONY/man-5.6/ + + +The output data structure contains detailed informations about the optimization process. +It has type "struct" and contains the following fields. + +output.iterations: The number of iterations performed during the search + + + -- cgit