include/opencascade/math_BFGS.lxx

0001 // Copyright (c) 1997-1999 Matra Datavision
0002 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #include <StdFail_NotDone.hxx>
0016 #include <math_Vector.hxx>
0017
0018 inline bool math_BFGS::IsDone() const
0019 {
0020   return Done;
0021 }
0022
0023 inline Standard_OStream& operator<<(Standard_OStream& o, const math_BFGS& B)
0024 {
0025   B.Dump(o);
0026   return o;
0027 }
0028
0029 inline const math_Vector& math_BFGS::Location() const
0030 {
0031   StdFail_NotDone_Raise_if(!Done, " ");
0032   return TheLocation;
0033 }
0034
0035 inline void math_BFGS::Location(math_Vector& Loc) const
0036 {
0037   StdFail_NotDone_Raise_if(!Done, " ");
0038   Loc = TheLocation;
0039 }
0040
0041 inline double math_BFGS::Minimum() const
0042 {
0043   StdFail_NotDone_Raise_if(!Done, " ");
0044   return TheMinimum;
0045 }
0046
0047 inline const math_Vector& math_BFGS::Gradient() const
0048 {
0049   StdFail_NotDone_Raise_if(!Done, " ");
0050   return TheGradient;
0051 }
0052
0053 inline void math_BFGS::Gradient(math_Vector& Grad) const
0054 {
0055   StdFail_NotDone_Raise_if(!Done, " ");
0056   Grad = TheGradient;
0057 }
0058
0059 inline int math_BFGS::NbIterations() const
0060 {
0061   StdFail_NotDone_Raise_if(!Done, " ");
0062   return nbiter;
0063 }