Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
Expr_PolyExpression Class Reference

#include <Expr_PolyExpression.hxx>

Inheritance diagram for Expr_PolyExpression:
Inheritance graph
[legend]

Public Member Functions

int NbOperands () const
 returns the number of operands contained in <me>
 
const occ::handle< Expr_GeneralExpression > & Operand (const int index) const
 Returns the <index>-th operand used in <me>. An exception is raised if index is out of range.
 
void SetOperand (const occ::handle< Expr_GeneralExpression > &exp, const int 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>.
 
int NbSubExpressions () const override
 returns the number of sub-expressions contained in <me> ( >= 2)
 
const occ::handle< Expr_GeneralExpression > & SubExpression (const int I) const override
 Returns the sub-expression denoted by in <me> Raises OutOfRange if > NbSubExpressions(me)
 
bool ContainsUnknowns () const override
 Does <me> contains NamedUnknown ?
 
bool Contains (const occ::handle< Expr_GeneralExpression > &exp) const override
 Tests if <exp> is contained in <me>.
 
void Replace (const occ::handle< Expr_NamedUnknown > &var, const occ::handle< Expr_GeneralExpression > &with) override
 Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.
 
occ::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 occ::handle< Expr_GeneralExpressionShallowSimplified () const =0
 Returns a GeneralExpression after a simplification of the arguments of <me>.
 
virtual occ::handle< Expr_GeneralExpressionCopy () const =0
 Returns a copy of <me> having the same unknowns and functions.
 
virtual bool IsLinear () const =0
 Tests if <me> is linear on every NamedUnknown it contains.
 
virtual bool 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 bool IsIdentical (const occ::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 occ::handle< Expr_GeneralExpressionDerivative (const occ::handle< Expr_NamedUnknown > &X) const =0
 Returns the derivative on <X> unknown of <me>
 
virtual occ::handle< Expr_GeneralExpressionNDerivative (const occ::handle< Expr_NamedUnknown > &X, const int N) const
 Returns the <N>-th derivative on <X> unknown of <me>. Raise OutOfRange if N <= 0.
 
virtual double Evaluate (const NCollection_Array1< occ::handle< Expr_NamedUnknown > > &vars, const NCollection_Array1< double > &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.
 
double 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 ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Protected Member Functions

 Expr_PolyExpression ()
 initialize an empty list of operands.
 
void AddOperand (const occ::handle< Expr_GeneralExpression > &exp)
 Adds an operand to the list of <me>.
 
void RemoveOperand (const int 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 charget_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 occ::handle< Expr_GeneralExpression > & exp)
protected

Adds an operand to the list of <me>.

◆ Contains()

bool Expr_PolyExpression::Contains ( const occ::handle< Expr_GeneralExpression > & exp) const
overridevirtual

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

Implements Expr_GeneralExpression.

◆ ContainsUnknowns()

bool Expr_PolyExpression::ContainsUnknowns ( ) const
overridevirtual

Does <me> contains NamedUnknown ?

Implements Expr_GeneralExpression.

◆ NbOperands()

int Expr_PolyExpression::NbOperands ( ) const

returns the number of operands contained in <me>

◆ NbSubExpressions()

int Expr_PolyExpression::NbSubExpressions ( ) const
overridevirtual

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

Implements Expr_GeneralExpression.

◆ Operand()

const occ::handle< Expr_GeneralExpression > & Expr_PolyExpression::Operand ( const int 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 int 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 occ::handle< Expr_NamedUnknown > & var,
const occ::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 occ::handle< Expr_GeneralExpression > & exp,
const int 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()

occ::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 occ::handle< Expr_GeneralExpression > & Expr_PolyExpression::SubExpression ( const int 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: