src/math/math_NewtonMinimum.lxx

   1 // Created on: 1996-05-03
   2 // Created by: Philippe MANGIN
   3 // Copyright (c) 1996-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 #include <StdFail_NotDone.hxx>
  18
  19 inline Standard_Boolean math_NewtonMinimum::IsConverged() const
  20 {
  21   return ( (TheStep.Norm() <= XTol ) ||
  22     ( Abs(TheMinimum-PreviousMinimum) <= XTol * Abs(PreviousMinimum) ));
  23 }
  24
  25 inline Standard_Boolean math_NewtonMinimum::IsDone() const
  26 {
  27   return Done;
  28 }
  29
  30 inline const math_Vector& math_NewtonMinimum::Location() const
  31 {
  32    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  33    return TheLocation;
  34 }
  35
  36 inline void math_NewtonMinimum::Location(math_Vector& Loc) const
  37 {
  38    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  39    Loc = TheLocation;
  40 }
  41
  42 inline Standard_Real math_NewtonMinimum::Minimum() const
  43 {
  44    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  45    return TheMinimum;
  46 }
  47
  48 inline const math_Vector& math_NewtonMinimum::Gradient() const
  49 {
  50    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  51    return TheGradient;
  52 }
  53
  54 inline void math_NewtonMinimum::Gradient(math_Vector& Grad) const
  55 {
  56    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  57    Grad = TheGradient;
  58 }
  59
  60 inline Standard_Integer math_NewtonMinimum::NbIterations() const
  61 {
  62    StdFail_NotDone_Raise_if(!Done, "NewtonMinimum");
  63    return nbiter;
  64 }
  65
  66 inline math_Status math_NewtonMinimum::GetStatus() const
  67 {
  68   return TheStatus;
  69 }