Open CASCADE Technology 7.8.2.dev
Expr_PolyExpression Class Reference

#include <Expr_PolyExpression.hxx>

Inheritance diagram for Expr_PolyExpression:

Public Member Functions

Standard_Integer NbOperands () const
 returns the number of operands contained in <me>
 
const Handle< Expr_GeneralExpression > & Operand (const Standard_Integer index) const
 Returns the <index>-th operand used in <me>. An exception is raised if index is out of range.
 
void SetOperand (const Handle< Expr_GeneralExpression > &exp, const Standard_Integer index)
 Sets the <index>-th operand used in <me>. An exception is raised if <index> is out of range Raises InvalidOperand if <exp> contains <me>.
 
Standard_Integer NbSubExpressions () const override
 returns the number of sub-expressions contained in <me> ( >= 2)
 
const Handle< Expr_GeneralExpression > & SubExpression (const Standard_Integer I) const override
 Returns the sub-expression denoted by in <me> Raises OutOfRange if > NbSubExpressions(me)
 
Standard_Boolean ContainsUnknowns () const override
 Does <me> contains NamedUnknown ?
 
Standard_Boolean Contains (const Handle< Expr_GeneralExpression > &exp) const override
 Tests if <exp> is contained in <me>.
 
void Replace (const Handle< Expr_NamedUnknown > &var, const Handle< Expr_GeneralExpression > &with) override
 Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.
 
Handle< Expr_GeneralExpressionSimplified () const override
 Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
 
- Public Member Functions inherited from Expr_GeneralExpression
virtual Handle< Expr_GeneralExpressionShallowSimplified () const =0
 Returns a GeneralExpression after a simplification of the arguments of <me>.
 
virtual Handle< Expr_GeneralExpressionCopy () const =0
 Returns a copy of <me> having the same unknowns and functions.
 
virtual Standard_Boolean IsLinear () const =0
 Tests if <me> is linear on every NamedUnknown it contains.
 
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).
 
virtual Standard_Boolean IsIdentical (const Handle< Expr_GeneralExpression > &Other) const =0
 Tests if <me> and <Other> define the same expression. Warning: This method does not include any simplification before testing. It could also be very slow; to be used carefully.
 
virtual Handle< Expr_GeneralExpressionDerivative (const Handle< Expr_NamedUnknown > &X) const =0
 Returns the derivative on <X> unknown of <me>
 
virtual Handle< Expr_GeneralExpressionNDerivative (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.
 
virtual Standard_Real Evaluate (const Expr_Array1OfNamedUnknown &vars, const TColStd_Array1OfReal &vals) const =0
 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.
 
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.
 
virtual TCollection_AsciiString String () const =0
 returns a string representing <me> in a readable way.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean IsKind (const opencascade::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.
 
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.
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Protected Member Functions

 Expr_PolyExpression ()
 initialize an empty list of operands.
 
void AddOperand (const Handle< Expr_GeneralExpression > &exp)
 Adds an operand to the list of <me>.
 
void RemoveOperand (const Standard_Integer index)
 Remove the operand denoted by <index> from the list of <me>. Raises exception if <index> is out of range or if removing operand intend to leave only one or no operand.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const char * get_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

Constructor & Destructor Documentation

◆ Expr_PolyExpression()

Expr_PolyExpression::Expr_PolyExpression ( )
protected

initialize an empty list of operands.

Member Function Documentation

◆ AddOperand()

void Expr_PolyExpression::AddOperand ( const Handle< Expr_GeneralExpression > & exp)
protected

Adds an operand to the list of <me>.

◆ Contains()

Standard_Boolean Expr_PolyExpression::Contains ( const Handle< Expr_GeneralExpression > & exp) const
overridevirtual

Tests if <exp> is contained in <me>.

Implements Expr_GeneralExpression.

◆ ContainsUnknowns()

Standard_Boolean Expr_PolyExpression::ContainsUnknowns ( ) const
overridevirtual

Does <me> contains NamedUnknown ?

Implements Expr_GeneralExpression.

◆ NbOperands()

Standard_Integer Expr_PolyExpression::NbOperands ( ) const

returns the number of operands contained in <me>

◆ NbSubExpressions()

Standard_Integer Expr_PolyExpression::NbSubExpressions ( ) const
overridevirtual

returns the number of sub-expressions contained in <me> ( >= 2)

Implements Expr_GeneralExpression.

◆ Operand()

const Handle< Expr_GeneralExpression > & Expr_PolyExpression::Operand ( const Standard_Integer index) const

Returns the <index>-th operand used in <me>. An exception is raised if index is out of range.

◆ RemoveOperand()

void Expr_PolyExpression::RemoveOperand ( const Standard_Integer index)
protected

Remove the operand denoted by <index> from the list of <me>. Raises exception if <index> is out of range or if removing operand intend to leave only one or no operand.

◆ Replace()

void Expr_PolyExpression::Replace ( const Handle< Expr_NamedUnknown > & var,
const Handle< Expr_GeneralExpression > & with )
overridevirtual

Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.

Implements Expr_GeneralExpression.

◆ SetOperand()

void Expr_PolyExpression::SetOperand ( const Handle< Expr_GeneralExpression > & exp,
const Standard_Integer index )

Sets the <index>-th operand used in <me>. An exception is raised if <index> is out of range Raises InvalidOperand if <exp> contains <me>.

◆ Simplified()

Handle< Expr_GeneralExpression > Expr_PolyExpression::Simplified ( ) const
overridevirtual

Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.

Implements Expr_GeneralExpression.

◆ SubExpression()

const Handle< Expr_GeneralExpression > & Expr_PolyExpression::SubExpression ( const Standard_Integer I) const
overridevirtual

Returns the sub-expression denoted by in <me> Raises OutOfRange if > NbSubExpressions(me)

Implements Expr_GeneralExpression.


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