include/opencascade/math_FunctionSetWithDerivatives.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_FunctionSetWithDerivatives_HeaderFile
0018 #define _math_FunctionSetWithDerivatives_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <math_FunctionSet.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <math_Vector.hxx>
0026 class math_Matrix;
0027
0028
0029 //! This abstract class describes the virtual functions associated
0030 //! with a set of N Functions each of M independent variables.
0031 class math_FunctionSetWithDerivatives  : public math_FunctionSet
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   //! Returns the number of variables of the function.
0039   Standard_EXPORT virtual Standard_Integer NbVariables() const = 0;
0040
0041   //! Returns the number of equations of the function.
0042   Standard_EXPORT virtual Standard_Integer NbEquations() const = 0;
0043
0044   //! Computes the values <F> of the Functions for the
0045   //! variable <X>.
0046   //! Returns True if the computation was done successfully,
0047   //! False otherwise.
0048   Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, math_Vector& F) = 0;
0049
0050   //! Returns the values <D> of the derivatives for the
0051   //! variable <X>.
0052   //! Returns True if the computation was done successfully,
0053   //! False otherwise.
0054   Standard_EXPORT virtual Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D) = 0;
0055
0056   //! returns the values <F> of the functions and the derivatives
0057   //! <D> for the variable <X>.
0058   //! Returns True if the computation was done successfully,
0059   //! False otherwise.
0060   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D) = 0;
0061
0062
0063
0064
0065 protected:
0066
0067
0068
0069
0070
0071 private:
0072
0073
0074
0075
0076
0077 };
0078
0079
0080
0081
0082
0083
0084
0085 #endif // _math_FunctionSetWithDerivatives_HeaderFile