1 // Created on: 1991-05-13
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_FunctionWithDerivative_HeaderFile
18 #define _math_FunctionWithDerivative_HeaderFile
19 
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23 
24 #include <math_Function.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Real.hxx>
27 
28 
29 
30 //! This abstract class describes the virtual functions associated with
31 //! a function of a single variable for which the first derivative is
32 //! available.
33 class math_FunctionWithDerivative  : public math_Function
34 {
35 public:
36 
37   DEFINE_STANDARD_ALLOC
38 
39 
40   //! Computes the value <F>of the function for the variable <X>.
41   //! Returns True if the calculation were successfully done,
42   //! False otherwise.
43   Standard_EXPORT virtual Standard_Boolean Value (const Standard_Real X, Standard_Real& F) = 0;
44 
45   //! Computes the derivative <D> of the function
46   //! for the variable <X>.
47   //! Returns True if the calculation were successfully done,
48   //! False otherwise.
49   Standard_EXPORT virtual Standard_Boolean Derivative (const Standard_Real X, Standard_Real& D) = 0;
50 
51   //! Computes the value <F> and the derivative <D> of the
52   //! function for the variable <X>.
53   //! Returns True if the calculation were successfully done,
54   //! False otherwise.
55   Standard_EXPORT virtual Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& D) = 0;
56   Standard_EXPORT virtual ~math_FunctionWithDerivative();
57 
58 
59 
60 
61 protected:
62 
63 
64 
65 
66 
67 private:
68 
69 
70 
71 
72 
73 };
74 
75 
76 
77 
78 
79 
80 
81 #endif // _math_FunctionWithDerivative_HeaderFile
82