include/opencascade/math_Function.hxx

0001 // Created on: 1991-05-06
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _math_Function_HeaderFile
0018 #define _math_Function_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <Standard_Real.hxx>
0026
0027 //! This abstract class describes the virtual functions
0028 //! associated with a Function of a single variable.
0029 class math_Function
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Virtual destructor, for safe inheritance
0035   virtual ~math_Function() = default;
0036
0037   //! Computes the value of the function <F> for a given value of
0038   //! variable <X>.
0039   //! returns True if the computation was done successfully,
0040   //! False otherwise.
0041   Standard_EXPORT virtual bool Value(const double X, double& F) = 0;
0042
0043   //! returns the state of the function corresponding to the
0044   //! latest call of any methods associated with the function.
0045   //! This function is called by each of the algorithms
0046   //! described later which defined the function Integer
0047   //! Algorithm::StateNumber(). The algorithm has the
0048   //! responsibility to call this function when it has found
0049   //! a solution (i.e. a root or a minimum) and has to maintain
0050   //! the association between the solution found and this
0051   //! StateNumber.
0052   //! Byu default, this method returns 0 (which means for the
0053   //! algorithm: no state has been saved). It is the
0054   //! responsibility of the programmer to decide if he needs
0055   //! to save the current state of the function and to return
0056   //! an Integer that allows retrieval of the state.
0057   Standard_EXPORT virtual int GetStateNumber();
0058 };
0059
0060 #endif // _math_Function_HeaderFile