C# Class Accord.Math.Optimization.NonlinearConjugateGradient

Non-linear Conjugate Gradient (WARNING: This code can not be used for commercial purposes. It is MANDATORY to check the accompanying license file for this particular module AND the source code for more details before you use this code).

This code has been contributed by Peter Sergio Larsen based on the original from Edward Rasmussen's FminCG. Please note that this code is only available under a special license that specifically denies the use for commercial applications and is thus not compatible with the LGPL and the GPL. Use at your own risk.

To use this class, add a reference to the Accord.Math.Noncommercial.dll assembly that resides inside the Release/Noncommercial folder of the framework's installation directory.

The copyright license, plus the original documentation for this code, is shown below.

function [X, fX, i] = fmincg(f, X, options, P1, P2, P3, P4, P5) % Minimize a continuous differentialble multivariate function. Starting point % is given by "X" (D by 1), and the function named in the string "f", must % return a function value and a vector of partial derivatives. The Polack- % Ribiere flavour of conjugate gradients is used to compute search directions, % and a line search using quadratic and cubic polynomial approximations and the % Wolfe-Powell stopping criteria is used together with the slope ratio method % for guessing initial step sizes. Additionally a bunch of checks are made to % make sure that exploration is taking place and that extrapolation will not % be unboundedly large. The "length" gives the length of the run: if it is % positive, it gives the maximum number of line searches, if negative its % absolute gives the maximum allowed number of function evaluations. You can % (optionally) give "length" a second component, which will indicate the % reduction in function value to be expected in the first line-search (defaults % to 1.0). The function returns when either its length is up, or if no further % progress can be made (ie, we are at a minimum, or so close that due to % numerical problems, we cannot get any closer). If the function terminates % within a few iterations, it could be an indication that the function value % and derivatives are not consistent (ie, there may be a bug in the % implementation of your "f" function). The function returns the found % solution "X", a vector of function values "fX" indicating the progress made % and "i" the number of iterations (line searches or function evaluations, % depending on the sign of "length") used. % % Usage: [X, fX, i] = fmincg(f, X, options, P1, P2, P3, P4, P5) % % See also: checkgrad % % Copyright (C) 2001 and 2002 by Carl Edward Rasmussen. Date 2002-02-13 % % % (C) Copyright 1999, 2000 & 2001, Carl Edward Rasmussen % % Permission is granted for anyone to copy, use, or modify these % programs and accompanying documents for purposes of research or % education, provided this copyright notice is retained, and note is % made of any changes that have been made. % % These programs and documents are distributed without any warranty, % express or implied. As the programs were written for research % purposes only, they have not been tested to the degree that would be % advisable in any important application. All use of these programs is % entirely at the user's own risk.

Modifications have been made so this code could fit under Accord.NET's IGradientOptimizationMethod interface. Modifications were necessary to port the original code from MATLAB/Octave to C#.

Inheritance: BaseGradientOptimizationMethod, IGradientOptimizationMethod
Show file Open project: accord-net/framework Class Usage Examples

Public Methods

Method Description
NonlinearConjugateGradient ( int numberOfVariables ) : System

Constructs a new NonlinearConjugateGradient algorithm.
NonlinearConjugateGradient ( int numberOfVariables, double>.Func function, double[]>.Func gradient ) : System

Constructs a new NonlinearConjugateGradient algorithm.

Protected Methods

Method Description
Optimize ( ) : bool

Implements the actual optimization algorithm. This method should try to minimize the objective function.

Private Methods

Method Description
init ( ) : void

Method Details

NonlinearConjugateGradient() public method

Constructs a new NonlinearConjugateGradient algorithm.
public NonlinearConjugateGradient ( int numberOfVariables ) : System
numberOfVariables int The number of free parameters in the optimization problem.
return System

NonlinearConjugateGradient() public method

Constructs a new NonlinearConjugateGradient algorithm.
public NonlinearConjugateGradient ( int numberOfVariables, double>.Func function, double[]>.Func gradient ) : System
numberOfVariables int The number of free parameters in the optimization problem.
function double>.Func The function to be optimized.
gradient double[]>.Func The gradient of the function.
return System

Optimize() protected method

Implements the actual optimization algorithm. This method should try to minimize the objective function.
protected Optimize ( ) : bool
return bool