summaryrefslogtreecommitdiff
path: root/inc/Expr_NamedFunction.hxx
blob: e955568b575573a780a6799fc5ee61c8b7e79eed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Expr_NamedFunction_HeaderFile
#define _Expr_NamedFunction_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Expr_NamedFunction_HeaderFile
#include <Handle_Expr_NamedFunction.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Handle_Expr_GeneralExpression_HeaderFile
#include <Handle_Expr_GeneralExpression.hxx>
#endif
#ifndef _Expr_Array1OfNamedUnknown_HeaderFile
#include <Expr_Array1OfNamedUnknown.hxx>
#endif
#ifndef _Expr_GeneralFunction_HeaderFile
#include <Expr_GeneralFunction.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Expr_NamedUnknown_HeaderFile
#include <Handle_Expr_NamedUnknown.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Handle_Expr_GeneralFunction_HeaderFile
#include <Handle_Expr_GeneralFunction.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Expr_GeneralExpression;
class Standard_OutOfRange;
class Standard_DimensionMismatch;
class Standard_NumericError;
class Expr_NotEvaluable;
class TCollection_AsciiString;
class Expr_Array1OfNamedUnknown;
class Expr_NamedUnknown;
class TColStd_Array1OfReal;
class Expr_GeneralFunction;



class Expr_NamedFunction : public Expr_GeneralFunction {

public:

  //! Creates a function of given variables <vars> with name <br>
//!          <name> defined by the expression <exp>. <br>
  Standard_EXPORT   Expr_NamedFunction(const TCollection_AsciiString& name,const Handle(Expr_GeneralExpression)& exp,const Expr_Array1OfNamedUnknown& vars);
  //! Sets the name <newname> to <me>. <br>
  Standard_EXPORT     void SetName(const TCollection_AsciiString& newname) ;
  //! Returns the name assigned to <me> <br>
  Standard_EXPORT     TCollection_AsciiString GetName() const;
  //! Returns the number of variables of <me>. <br>
  Standard_EXPORT     Standard_Integer NbOfVariables() const;
  //! Returns the variable denoted by <index> in <me>. <br>
//!          Raises OutOfRange if <index> is greater than <br>
//!          NbOfVariables of <me>, or less than or equal to zero. <br>
  Standard_EXPORT     Handle_Expr_NamedUnknown Variable(const Standard_Integer index) const;
  //! Computes the value of <me> with the given variables. <br>
//!          Raises DimensionMismatch if Length(vars) is different from <br>
//!          Length(values). <br>
  Standard_EXPORT     Standard_Real Evaluate(const Expr_Array1OfNamedUnknown& vars,const TColStd_Array1OfReal& values) const;
  //! Returns a copy of <me> with the same form. <br>
  Standard_EXPORT     Handle_Expr_GeneralFunction Copy() const;
  //! Returns Derivative of <me> for variable <var>. <br>
  Standard_EXPORT     Handle_Expr_GeneralFunction Derivative(const Handle(Expr_NamedUnknown)& var) const;
  //! Returns Derivative of <me> for variable <var> with <br>
//!          degree <deg>. <br>
  Standard_EXPORT     Handle_Expr_GeneralFunction Derivative(const Handle(Expr_NamedUnknown)& var,const Standard_Integer deg) const;
  //! Tests if <me> and <func> are similar functions (same <br>
//!          name and same used expression). <br>
  Standard_EXPORT     Standard_Boolean IsIdentical(const Handle(Expr_GeneralFunction)& func) const;
  //! Tests if <me> is linear on variable on range <index> <br>
  Standard_EXPORT     Standard_Boolean IsLinearOnVariable(const Standard_Integer index) const;
  
  Standard_EXPORT     TCollection_AsciiString GetStringName() const;
  //! Returns equivalent expression of <me>. <br>
  Standard_EXPORT     Handle_Expr_GeneralExpression Expression() const;
  //! Modifies expression of <me>. <br>
//!  Warning: Beware of derivatives. See FunctionDerivative <br>
  Standard_EXPORT     void SetExpression(const Handle(Expr_GeneralExpression)& exp) ;




  DEFINE_STANDARD_RTTI(Expr_NamedFunction)

protected:




private: 


TCollection_AsciiString myName;
Handle_Expr_GeneralExpression myExp;
Expr_Array1OfNamedUnknown myVariables;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif