Open CASCADE Technology  6.9.0
Public Member Functions

Expr_BinaryFunction Class Reference

Defines the use of a binary function in an expression with given arguments. More...

#include <Expr_BinaryFunction.hxx>

Inheritance diagram for Expr_BinaryFunction:
Inheritance graph
[legend]

Public Member Functions

 Expr_BinaryFunction (const Handle< Expr_GeneralFunction > &func, const Handle< Expr_GeneralExpression > &exp1, const Handle< Expr_GeneralExpression > &exp2)
 Creates <me> as <func> (<exp1>,<exp2>). Raises exception if <func> is not binary. More...
 
Handle< Expr_GeneralFunctionFunction () const
 Returns the function defining <me>. More...
 
Handle< Expr_GeneralExpressionShallowSimplified () const
 Returns a GeneralExpression after a simplification of the arguments of <me>. More...
 
Handle< Expr_GeneralExpressionCopy () const
 Returns a copy of <me> having the same unknowns and functions. More...
 
Standard_Boolean IsIdentical (const Handle< Expr_GeneralExpression > &Other) const
 Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing. More...
 
Standard_Boolean IsLinear () const
 Tests if <me> is linear on every NamedUnknown it contains. More...
 
Handle< Expr_GeneralExpressionDerivative (const Handle< Expr_NamedUnknown > &X) const
 Returns the derivative on <X> unknown of <me> More...
 
Standard_Real Evaluate (const Expr_Array1OfNamedUnknown &vars, const TColStd_Array1OfReal &vals) const
 Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed. More...
 
TCollection_AsciiString String () const
 returns a string representing <me> in a readable way. More...
 
- Public Member Functions inherited from Expr_BinaryExpression
const Handle
< Expr_GeneralExpression > & 
FirstOperand () const
 
const Handle
< Expr_GeneralExpression > & 
SecondOperand () const
 
void SetFirstOperand (const Handle< Expr_GeneralExpression > &exp)
 Sets first operand of <me> Raises InvalidOperand if exp = me. More...
 
void SetSecondOperand (const Handle< Expr_GeneralExpression > &exp)
 Sets second operand of <me> Raises InvalidOperand if <exp> contains <me>. More...
 
Standard_Integer NbSubExpressions () const
 returns the number of sub-expressions contained in <me> ( >= 0) More...
 
const Handle
< Expr_GeneralExpression > & 
SubExpression (const Standard_Integer I) const
 returns the -th sub-expression of <me> raises OutOfRange if > NbSubExpressions(me) More...
 
Standard_Boolean ContainsUnknowns () const
 Does <me> contain NamedUnknown ? More...
 
Standard_Boolean Contains (const Handle< Expr_GeneralExpression > &exp) const
 Tests if <me> contains <exp>. More...
 
void Replace (const Handle< Expr_NamedUnknown > &var, const Handle< Expr_GeneralExpression > &with)
 Replaces all occurences of with <with> in <me>. Raises InvalidOperand if <with> contains <me>. More...
 
Handle< Expr_GeneralExpressionSimplified () const
 Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation. More...
 
- Public Member Functions inherited from Expr_GeneralExpression
virtual Standard_Boolean IsShareable () const
 Tests if <me> can be shared by one or more expressions or must be copied. This method returns False as a default value. To be redefined ( especially for NamedUnknown). More...
 
virtual Handle
< Expr_GeneralExpression
NDerivative (const Handle< Expr_NamedUnknown > &X, const Standard_Integer N) const
 Returns the <N>-th derivative on <X> unknown of <me>. Raise OutOfRange if N <= 0. More...
 
Standard_Real EvaluateNumeric () const
 Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Expr_BinaryExpression
void CreateFirstOperand (const Handle< Expr_GeneralExpression > &exp)
 Sets first operand of <me> More...
 
void CreateSecondOperand (const Handle< Expr_GeneralExpression > &exp)
 Sets second operand of <me> Raises InvalidOperand if <exp> contains <me>. More...
 

Detailed Description

Defines the use of a binary function in an expression with given arguments.

Constructor & Destructor Documentation

Expr_BinaryFunction::Expr_BinaryFunction ( const Handle< Expr_GeneralFunction > &  func,
const Handle< Expr_GeneralExpression > &  exp1,
const Handle< Expr_GeneralExpression > &  exp2 
)

Creates <me> as <func> (<exp1>,<exp2>). Raises exception if <func> is not binary.

Member Function Documentation

Handle< Expr_GeneralExpression > Expr_BinaryFunction::Copy ( ) const
virtual

Returns a copy of <me> having the same unknowns and functions.

Implements Expr_GeneralExpression.

Handle< Expr_GeneralExpression > Expr_BinaryFunction::Derivative ( const Handle< Expr_NamedUnknown > &  X) const
virtual

Returns the derivative on <X> unknown of <me>

Implements Expr_GeneralExpression.

Standard_Real Expr_BinaryFunction::Evaluate ( const Expr_Array1OfNamedUnknown vars,
const TColStd_Array1OfReal vals 
) const
virtual

Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.

Implements Expr_GeneralExpression.

Handle< Expr_GeneralFunction > Expr_BinaryFunction::Function ( ) const

Returns the function defining <me>.

Standard_Boolean Expr_BinaryFunction::IsIdentical ( const Handle< Expr_GeneralExpression > &  Other) const
virtual

Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.

Implements Expr_GeneralExpression.

Standard_Boolean Expr_BinaryFunction::IsLinear ( ) const
virtual

Tests if <me> is linear on every NamedUnknown it contains.

Implements Expr_GeneralExpression.

Handle< Expr_GeneralExpression > Expr_BinaryFunction::ShallowSimplified ( ) const
virtual

Returns a GeneralExpression after a simplification of the arguments of <me>.

Implements Expr_GeneralExpression.

TCollection_AsciiString Expr_BinaryFunction::String ( ) const
virtual

returns a string representing <me> in a readable way.

Implements Expr_GeneralExpression.


The documentation for this class was generated from the following file: