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 //! This abstract class describes the virtual functions associated with
0029 //! a function of a single variable for which the first derivative is
0030 //! available.
0031 class math_FunctionWithDerivative : public math_Function
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Computes the value <F>of the function for the variable <X>.
0037   //! Returns True if the calculation were successfully done,
0038   //! False otherwise.
0039   Standard_EXPORT bool Value(const double X, double& F) override = 0;
0040
0041   //! Computes the derivative <D> of the function
0042   //! for the variable <X>.
0043   //! Returns True if the calculation were successfully done,
0044   //! False otherwise.
0045   Standard_EXPORT virtual bool Derivative(const double X, double& D) = 0;
0046
0047   //! Computes the value <F> and the derivative <D> of the
0048   //! function for the variable <X>.
0049   //! Returns True if the calculation were successfully done,
0050   //! False otherwise.
0051   Standard_EXPORT virtual bool Values(const double X, double& F, double& D) = 0;
0052   Standard_EXPORT ~math_FunctionWithDerivative() override;
0053 };
0054
0055 #endif // _math_FunctionWithDerivative_HeaderFile