include/opencascade/math_FunctionWithDerivative.hxx

0001 // Created on: 1991-05-13
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_FunctionWithDerivative_HeaderFile
0018 #define _math_FunctionWithDerivative_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <math_Function.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <Standard_Real.hxx>
0027
0028
0029
0030 //! This abstract class describes the virtual functions associated with
0031 //! a function of a single variable for which the first derivative is
0032 //! available.
0033 class math_FunctionWithDerivative  : public math_Function
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   //! Computes the value <F>of the function for the variable <X>.
0041   //! Returns True if the calculation were successfully done,
0042   //! False otherwise.
0043   Standard_EXPORT virtual Standard_Boolean Value (const Standard_Real X, Standard_Real& F) = 0;
0044
0045   //! Computes the derivative <D> of the function
0046   //! for the variable <X>.
0047   //! Returns True if the calculation were successfully done,
0048   //! False otherwise.
0049   Standard_EXPORT virtual Standard_Boolean Derivative (const Standard_Real X, Standard_Real& D) = 0;
0050
0051   //! Computes the value <F> and the derivative <D> of the
0052   //! function for the variable <X>.
0053   //! Returns True if the calculation were successfully done,
0054   //! False otherwise.
0055   Standard_EXPORT virtual Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& D) = 0;
0056   Standard_EXPORT virtual ~math_FunctionWithDerivative();
0057
0058
0059
0060
0061 protected:
0062
0063
0064
0065
0066
0067 private:
0068
0069
0070
0071
0072
0073 };
0074
0075
0076
0077
0078
0079
0080
0081 #endif // _math_FunctionWithDerivative_HeaderFile