<< uncprb_optiminit Benchmark

Unconstrained Optimization Problems Toolbox >> Unconstrained Optimization Problems Toolbox > Benchmark > uncprb_printsummary

uncprb_printsummary

rtolF, atolF, rtolX, atolX, fmt)

Calling Sequence

success = uncprb_printsummary(name, nprob, fopt, xopt, gopt, iter, funeval, geval, ..
rtolF, atolF, rtolX, atolX, fmt)

Parameters

name:

a 1-by-1 matrix of strings, the name of the problem or the name of the solver

nprob:

a 1-by-1 matrix of doubles, integer value, the problem number

fopt:

a 1-by-1 matrix of doubles, the computed optimum F(X)

xopt:

a n-by-1 matrix of doubles, the computed optimum X

gopt:

a n-by-1 matrix of doubles, the computed optimum gradient G(X). If gopt==[], then gopt is not printed.

iter:

a 1-by-1 matrix of doubles, integer value, the number of iterations. If iter==[], then iter is not printed.

funeval:

a 1-by-1 matrix of doubles, integer value, the number of function evaluations

geval:

a 1-by-1 matrix of doubles, integer value, the number of gradient evaluations. If geval==[], then geval is not printed.

rtolF:

a 1-by-1 matrix of doubles, positive, a relative tolerance on F

atolF:

a 1-by-1 matrix of doubles, positive, an absolute tolerance on F

rtolX:

a 1-by-1 matrix of doubles, positive, a relative tolerance on X

atolX:

a 1-by-1 matrix of doubles, positive, an absolute tolerance on X

fmt:

a 1-by-1 matrix of strings, the format of the output. Available values are fmt="detailed", "line" or "wiki". If fmt=="detailed", then a detailed message is produced. If fmt=="line", then a one-line message is produced. If fmt=="wiki", then a one-line message is produced, with Wiki formatting.

success :

a 1-by-1 matrix of booleans. success is %t if the optimization is correct both on X and on F

Description

Prints a summary of an optimization.

The success of the optimization is based on the uncprb_computestatus function.

Examples

// Make optim optimize the problem #1
nprob = 1;
[n,m,x0]=uncprb_getinitf(nprob)
uncprb_optiminit();
objfun = list(uncprb_optimfun,nprob,n,m);
[fopt,xopt,gopt]=optim(objfun,x0,"gc")
funeval = uncprb_optimget();
geval = [];
iter = [];
rtolX = 1.e-4;
atolX = 1.e-10;
rtolF = 1.e-4;
atolF = 1.e-10;
//
// Format "detailed"
success = uncprb_printsummary("optim/UNC/gc", nprob, fopt, xopt, gopt, iter, funeval, geval, ..
rtolF, atolF, rtolX, atolX, "detailed")
//
// Format "line"
success = uncprb_printsummary("optim/UNC/gc", nprob, fopt, xopt, gopt, iter, funeval, geval, ..
rtolF, atolF, rtolX, atolX, "line")
//
// Format "wiki"
success = uncprb_printsummary("optim/UNC/gc", nprob, fopt, xopt, gopt, iter, funeval, geval, ..
rtolF, atolF, rtolX, atolX, "wiki")

Authors

<< uncprb_optiminit Benchmark