/usr/share/octave/packages/3.2/optim-1.0.17/fminunc_compat.m is in octave-optim 1.0.17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | ## Copyright (C) 2002 Etienne Grossmann. All rights reserved.
##
## This program is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by the
## Free Software Foundation; either version 2, or (at your option) any
## later version.
##
## This is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
## for more details.
## [x,v,flag,out,df,d2f] = fminunc_compat (f,x,opt,...) - M*tlab-like optimization
##
## Imitation of m*tlab's fminunc(). The optional 'opt' argument is a struct,
## e.g. produced by 'optimset()'.
##
## Supported options
## -----------------
## Diagnostics, [off|on] : Be verbose
## Display , [off|iter|notify|final]
## : Be verbose unless value is "off"
## GradObj , [off|on] : Function's 2nd return value is derivatives
## Hessian , [off|on] : Function's 2nd and 3rd return value are
## derivatives and Hessian.
## TolFun , scalar : Termination criterion (see 'ftol' in minimize())
## TolX , scalar : Termination criterion (see 'utol' in minimize())
## MaxFunEvals, int : Max. number of function evaluations
## MaxIter , int : Max. number of algorithm iterations
##
## These non-m*tlab are provided to facilitate porting code to octave:
## -----------------------
## "MinEquiv" , [off|on] : Don't minimize 'fun', but instead return the
## option passed to minimize().
##
## "Backend" , [off|on] : Don't minimize 'fun', but instead return
## [backend, opt], the name of the backend
## optimization function that is used and the
## optional arguments that will be passed to it. See
## the 'backend' option of minimize().
##
## This function is a front-end to minimize().
function [x,fval,flag,out,df,d2f] = fminunc_compat (fun,x0,opt,varargin)
if nargin < 3, opt = struct (); end
if nargin > 3,
args = {x0, varargin{:}};
else
args = {x0};
end
## Do some checks ####################################################
ws = es = "";
## Check for unknown options
## All known options
opn = [" DerivativeCheck Diagnostics DiffMaxChange DiffMinChange",\
" Display GoalsExactAchieve GradConstr GradObj Hessian HessMult",\
" HessPattern HessUpdate Jacobian JacobMult JacobPattern",\
" LargeScale LevenbergMarquardt LineSearchType MaxFunEvals MaxIter",\
" MaxPCGIter MeritFunction MinAbsMax PrecondBandWidth TolCon",\
" TolFun TolPCG TolX TypicalX ",\
" MinEquiv Backend "];
for [v,k] = opt
if ! findstr ([" ",k," "],opn)
es = [es,sprintf("Unknown option '%s'\n",k)];
end
end
## Check for ignored options
## All ignored options
iop = [" DerivativeCheck DiffMaxChange DiffMinChange",\
" Display GoalsExactAchieve GradConstr HessMult",\
" HessPattern HessUpdate JacobMult JacobPattern",\
" LargeScale LevenbergMarquardt LineSearchType",\
" MaxPCGIter MeritFunction MinAbsMax PrecondBandWidth TolCon",\
" TolPCG TypicalX "];
for [v,k] = opt
if ! findstr ([" ",k," "],iop)
ws = [ws,sprintf("Ignoring option '%s'\n",k)];
end
end
if length (ws) && ! length (es), warning (ws);
elseif length (es), error ([ws,es]);
end
## Transform fminunc options into minimize() options
opm = struct(); # minimize() options
equiv = struct ("TolX" , "utol" , "TolFun" , "ftol",\
"MaxFunEvals", "maxev" , "MaxIter" , "maxit",\
"GradObj" , "jac" , "Hessian" , "hess",\
"Display" , "verbose", "Diagnostics", "verbose",\
"Backend" , "backend");
for [v,k] = equiv
if isfield (opt,k)
opm = setfield (opm, getfield(equiv,k), getfield(opt,k));
end
end
# Transform "off" into 0, other strings into
# 1.
for [v,k] = opm
if ischar (v)
if strcmp (v,"off")
opm = setfield (opm, k,0);
else
opm = setfield (opm, k,1);
end
end
end
unary_opt = " hess jac backend verbose ";
opml = {};
for [v,k] = opm
if findstr ([" ",k," "], unary_opt)
opml(end+1) = {k}; # append k
else
opml(end+[1,2]) = {k,v}; # append k and v
end
end
# Return only options to minimize() ##
if isfield (opt, "MinEquiv")
x = opml;
if nargout > 1
warning ("Only 1 return value is defined with the 'MinEquiv' option");
end
return
# Use the backend option #############
elseif isfield (opm, "backend")
[x,fval] = minimize (fun, args, opml);
if nargout > 2
warning ("Only 2 return values are defined with the 'Backend' option");
end
return
else # Do the minimization ################
[x,fval,out] = minimize (fun, args, opml);
if isfield (opm, "maxev")
flag = out(1) < getfield(opm,"maxev");
else
flag = 1;
end
if nargout > 4
[dummy,df,d2f] = feval (fun, x, args{2:end});
elseif nargout > 3
[dummy,df] = feval (fun, x, args{2:end});
end
end
|