Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
Expr_GeneralFunction Class Referenceabstract

Defines the general purposes of any function. More...

#include <Expr_GeneralFunction.hxx>

Inheritance diagram for Expr_GeneralFunction:
Inheritance graph
[legend]

Public Member Functions

virtual int NbOfVariables () const =0
 Returns the number of variables of <me>.
 
virtual occ::handle< Expr_NamedUnknownVariable (const int index) const =0
 Returns the variable denoted by <index> in <me>. Raises OutOfRange if index > NbOfVariables.
 
virtual occ::handle< Expr_GeneralFunctionCopy () const =0
 Returns a copy of <me> with the same form.
 
virtual occ::handle< Expr_GeneralFunctionDerivative (const occ::handle< Expr_NamedUnknown > &var) const =0
 Returns Derivative of <me> for variable .
 
virtual occ::handle< Expr_GeneralFunctionDerivative (const occ::handle< Expr_NamedUnknown > &var, const int deg) const =0
 Returns Derivative of <me> for variable with degree <deg>.
 
virtual double Evaluate (const NCollection_Array1< occ::handle< Expr_NamedUnknown > > &vars, const NCollection_Array1< double > &vals) const =0
 Computes the value of <me> with the given variables. Raises NotEvaluable if <vars> does not match all variables of <me>.
 
virtual bool IsIdentical (const occ::handle< Expr_GeneralFunction > &func) const =0
 Tests if <me> and <func> are similar functions (same name and same used expression).
 
virtual bool IsLinearOnVariable (const int index) const =0
 Tests if <me> is linear on variable on range <index>
 
virtual TCollection_AsciiString GetStringName () const =0
 
- 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.
 

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.
 

Detailed Description

Defines the general purposes of any function.

Member Function Documentation

◆ Copy()

virtual occ::handle< Expr_GeneralFunction > Expr_GeneralFunction::Copy ( ) const
pure virtual

Returns a copy of <me> with the same form.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Derivative() [1/2]

virtual occ::handle< Expr_GeneralFunction > Expr_GeneralFunction::Derivative ( const occ::handle< Expr_NamedUnknown > & var) const
pure virtual

Returns Derivative of <me> for variable .

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Derivative() [2/2]

virtual occ::handle< Expr_GeneralFunction > Expr_GeneralFunction::Derivative ( const occ::handle< Expr_NamedUnknown > & var,
const int deg ) const
pure virtual

Returns Derivative of <me> for variable with degree <deg>.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Evaluate()

virtual double Expr_GeneralFunction::Evaluate ( const NCollection_Array1< occ::handle< Expr_NamedUnknown > > & vars,
const NCollection_Array1< double > & vals ) const
pure virtual

Computes the value of <me> with the given variables. Raises NotEvaluable if <vars> does not match all variables of <me>.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ GetStringName()

virtual TCollection_AsciiString Expr_GeneralFunction::GetStringName ( ) const
pure virtual

◆ IsIdentical()

virtual bool Expr_GeneralFunction::IsIdentical ( const occ::handle< Expr_GeneralFunction > & func) const
pure virtual

Tests if <me> and <func> are similar functions (same name and same used expression).

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ IsLinearOnVariable()

virtual bool Expr_GeneralFunction::IsLinearOnVariable ( const int index) const
pure virtual

Tests if <me> is linear on variable on range <index>

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ NbOfVariables()

virtual int Expr_GeneralFunction::NbOfVariables ( ) const
pure virtual

Returns the number of variables of <me>.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Variable()

virtual occ::handle< Expr_NamedUnknown > Expr_GeneralFunction::Variable ( const int index) const
pure virtual

Returns the variable denoted by <index> in <me>. Raises OutOfRange if index > NbOfVariables.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.


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