src/math/math_BFGS.hxx

   1 // Created on: 1991-05-14
   2 // Created by: Laurent PAINNOT
   3 // Copyright (c) 1991-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _math_BFGS_HeaderFile
  18 #define _math_BFGS_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 #include <math_Status.hxx>
  26 #include <math_Vector.hxx>
  27 #include <Standard_Real.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <Standard_OStream.hxx>
  30 class StdFail_NotDone;
  31 class Standard_DimensionError;
  32 class math_MultipleVarFunctionWithGradient;
  33
  34
  35
  36 //! This class implements the Broyden-Fletcher-Goldfarb-Shanno variant of
  37 //! Davidson-Fletcher-Powell minimization algorithm of a function of
  38 //! multiple variables.Knowledge of the function's gradient is required.
  39 class math_BFGS
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   //! Initializes the computation of the minimum of a function with
  47   //! NbVariables.
  48   //! Tolerance, ZEPS and NbIterations are described in the method Perform.
  49   //! Warning:
  50   //! A call to the Perform method must be made after this
  51   //! initialization to effectively compute the minimum of the
  52   //! function F.
  53   Standard_EXPORT math_BFGS(const Standard_Integer NbVariables, const Standard_Real Tolerance = 1.0e-8, const Standard_Integer NbIterations = 200, const Standard_Real ZEPS = 1.0e-12);
  54 Standard_EXPORT virtual ~math_BFGS();
  55
  56   //! Given the starting point StartingPoint,
  57   //! minimization is done on the function F.
  58   //! The solution F = Fi is found when :
  59   //! 2.0 * abs(Fi - Fi-1) <= Tolerance * (abs(Fi) + abs(Fi-1) + ZEPS).
  60   //! Tolerance, ZEPS and maximum number of iterations are given
  61   //! in the constructor.
  62   Standard_EXPORT void Perform (math_MultipleVarFunctionWithGradient& F, const math_Vector& StartingPoint);
  63
  64
  65   //! This method is called at the end of each iteration to check if the
  66   //! solution is found.
  67   //! It can be redefined in a sub-class to implement a specific test to
  68   //! stop the iterations.
  69   Standard_EXPORT virtual Standard_Boolean IsSolutionReached (math_MultipleVarFunctionWithGradient& F) const;
  70
  71   //! Returns true if the computations are successful, otherwise returns false.
  72     Standard_Boolean IsDone() const;
  73
  74   //! returns the location vector of the minimum.
  75   //! Exception NotDone is raised if the minimum was not found.
  76     const math_Vector& Location() const;
  77
  78   //! outputs the location vector of the minimum in Loc.
  79   //! Exception NotDone is raised if the minimum was not found.
  80   //! Exception DimensionError is raised if the range of Loc is not
  81   //! equal to the range of the StartingPoint.
  82     void Location (math_Vector& Loc) const;
  83
  84   //! returns the value of the minimum.
  85   //! Exception NotDone is raised if the minimum was not found.
  86     Standard_Real Minimum() const;
  87
  88   //! Returns the gradient vector at the minimum.
  89   //! Exception NotDone is raised if the minimum was not found.
  90     const math_Vector& Gradient() const;
  91
  92   //! Returns the value of the gradient vector at the minimum in Grad.
  93   //! Exception NotDone is raised if the minimum was not found.
  94   //! Exception DimensionError is raised if the range of Grad is not
  95   //! equal to the range of the StartingPoint.
  96     void Gradient (math_Vector& Grad) const;
  97
  98   //! Returns the number of iterations really done in the
  99   //! calculation of the minimum.
 100   //! The exception NotDone is raised if the minimum was not found.
 101     Standard_Integer NbIterations() const;
 102
 103   //! Prints on the stream o information on the current state
 104   //! of the object.
 105   //! Is used to redefine the operator <<.
 106   Standard_EXPORT void Dump (Standard_OStream& o) const;
 107
 108
 109
 110
 111 protected:
 112
 113
 114
 115   math_Status TheStatus;
 116   math_Vector TheLocation;
 117   math_Vector TheGradient;
 118   Standard_Real PreviousMinimum;
 119   Standard_Real TheMinimum;
 120   Standard_Real XTol;
 121   Standard_Real EPSZ;
 122   Standard_Integer nbiter;
 123
 124
 125 private:
 126
 127
 128
 129   Standard_Boolean Done;
 130   Standard_Integer Itermax;
 131
 132
 133 };
 134
 135
 136 #include <math_BFGS.lxx>
 137
 138
 139
 140
 141
 142 #endif // _math_BFGS_HeaderFile