summaryrefslogtreecommitdiff
path: root/inc/Expr_GeneralExpression.hxx
blob: 3e5adce81fc90851936eb6200cea4f3fc9dd50e2 (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
128
// 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_GeneralExpression_HeaderFile
#define _Expr_GeneralExpression_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Expr_GeneralExpression_HeaderFile
#include <Handle_Expr_GeneralExpression.hxx>
#endif

#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_Expr_NamedUnknown_HeaderFile
#include <Handle_Expr_NamedUnknown.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
class Standard_OutOfRange;
class Standard_NumericError;
class Expr_NotEvaluable;
class Expr_InvalidOperand;
class Expr_NamedUnknown;
class Expr_Array1OfNamedUnknown;
class TColStd_Array1OfReal;
class TCollection_AsciiString;


//! Defines the general purposes of any expression. <br>
class Expr_GeneralExpression : public MMgt_TShared {

public:

  //! Returns the number of sub-expressions contained <br>
//!          in <me> ( >= 0) <br>
  Standard_EXPORT   virtual  Standard_Integer NbSubExpressions() const = 0;
  //! Returns the <I>-th sub-expression of <me> <br>
//!          raises OutOfRange if <I> > NbSubExpressions(me) <br>
  Standard_EXPORT   virtual const Handle_Expr_GeneralExpression& SubExpression(const Standard_Integer I) const = 0;
  //! Returns a GeneralExpression after replacement of <br>
//!          NamedUnknowns by an associated expression and after <br>
//!          values computation. <br>
  Standard_EXPORT   virtual  Handle_Expr_GeneralExpression Simplified() const = 0;
  //! Returns a GeneralExpression after a simplification <br>
//!          of the arguments of <me>. <br>
  Standard_EXPORT   virtual  Handle_Expr_GeneralExpression ShallowSimplified() const = 0;
  //! Returns a copy of <me> having the same unknowns and <br>
//!          functions. <br>
  Standard_EXPORT   virtual  Handle_Expr_GeneralExpression Copy() const = 0;
  //! Tests if <me> contains NamedUnknowns. <br>
  Standard_EXPORT   virtual  Standard_Boolean ContainsUnknowns() const = 0;
  //! Tests if <exp> is contained in <me>. <br>
  Standard_EXPORT   virtual  Standard_Boolean Contains(const Handle(Expr_GeneralExpression)& exp) const = 0;
  //! Tests if <me> is linear on every NamedUnknown it <br>
//!          contains. <br>
  Standard_EXPORT   virtual  Standard_Boolean IsLinear() const = 0;
  //! Tests if <me> can be shared by one or more expressions <br>
//!          or must be copied. This method returns False as a <br>
//!          default value. To be redefined ( especially for <br>
//!          NamedUnknown). <br>
  Standard_EXPORT   virtual  Standard_Boolean IsShareable() const;
  //! Tests if <me> and <Other> define the same expression. <br>
//!  Warning: This method does not include any simplification before <br>
//!          testing. It could also be very slow; to be used <br>
//!          carefully. <br>
  Standard_EXPORT   virtual  Standard_Boolean IsIdentical(const Handle(Expr_GeneralExpression)& Other) const = 0;
  //! Returns the derivative on <X> unknown of <me> <br>
  Standard_EXPORT   virtual  Handle_Expr_GeneralExpression Derivative(const Handle(Expr_NamedUnknown)& X) const = 0;
  //! Returns the <N>-th derivative on <X> unknown of <me>. <br>
//!          Raise OutOfRange if N <= 0 <br>
  Standard_EXPORT   virtual  Handle_Expr_GeneralExpression NDerivative(const Handle(Expr_NamedUnknown)& X,const Standard_Integer N) const;
  //! Replaces all occurences of <var> with copies of <with> <br>
//!          in <me>. Copies of <with> are made with the Copy() method. <br>
//!          Raises InvalidOperand if <with> contains <me>. <br>
  Standard_EXPORT   virtual  void Replace(const Handle(Expr_NamedUnknown)& var,const Handle(Expr_GeneralExpression)& with)  = 0;
  //! Returns the value of <me> (as a Real) by <br>
//!          replacement of <vars> by <vals>. <br>
//!          Raises NotEvaluable if <me> contains NamedUnknown not <br>
//!          in <vars> or NumericError if result cannot be computed. <br>
  Standard_EXPORT   virtual  Standard_Real Evaluate(const Expr_Array1OfNamedUnknown& vars,const TColStd_Array1OfReal& vals) const = 0;
  //! Returns the value of <me> (as a Real) by <br>
//!          replacement of <vars> by <vals>. <br>
//!          Raises NotEvaluable if <me> contains NamedUnknown not <br>
//!          in <vars> or NumericError if result cannot be computed. <br>
  Standard_EXPORT     Standard_Real EvaluateNumeric() const;
  //! returns a string representing <me> in a readable way. <br>
  Standard_EXPORT   virtual  TCollection_AsciiString String() const = 0;




  DEFINE_STANDARD_RTTI(Expr_GeneralExpression)

protected:




private: 




};





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


#endif