octave_packages/optim-1.2.0/fminsearch.m

   1 ## Copyright (C) 2006 Sylvain Pelissier <sylvain.pelissier@gmail.com>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{x} =} fminsearch (@var{fun}, @var{x0})
  18 ## @deftypefnx {Function File} {[@var{x}, @var{fval}] =} fminsearch (@var{fun}, @var{x0}, @var{options}, @var{grad}, @var{P1}, @var{P2}, @dots{})
  19 ##
  20 ## Find the minimum of a funtion of several variables.
  21 ## By default the method used is the Nelder&Mead Simplex algorithm.
  22 ## @seealso{fmin,fmins,nmsmax}
  23 ## @end deftypefn
  24
  25 ## TODO: describe arguments in texinfo help string
  26
  27 function [x, fval] = fminsearch (fun, x0, options = [], grad = [], varargin)
  28
  29   if (nargin < 2)
  30     print_usage ();
  31   endif
  32
  33   x = fmins (fun, x0, options, grad, varargin{:});
  34   fval = feval (fun, x, varargin{:});
  35
  36 endfunction