0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / GeomLib / GeomLib_PolyFunc.hxx
CommitLineData
42cf5bc1 1// Created on: 1998-09-22
2// Created by: Philippe MANGINGeomLib_PolyFunc.c
3// Copyright (c) 1998-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 _GeomLib_PolyFunc_HeaderFile
18#define _GeomLib_PolyFunc_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <math_Vector.hxx>
25#include <math_FunctionWithDerivative.hxx>
26#include <Standard_Boolean.hxx>
27#include <Standard_Real.hxx>
28
29
30//! Polynomial Function
31class GeomLib_PolyFunc : public math_FunctionWithDerivative
32{
33public:
34
35 DEFINE_STANDARD_ALLOC
36
37
38 Standard_EXPORT GeomLib_PolyFunc(const math_Vector& Coeffs);
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) Standard_OVERRIDE;
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) Standard_OVERRIDE;
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) Standard_OVERRIDE;
56
57
58
59
60protected:
61
62
63
64
65
66private:
67
68
69
70 math_Vector myCoeffs;
71
72
73};
74
75
76
77
78
79
80
81#endif // _GeomLib_PolyFunc_HeaderFile