Open CASCADE Technology 7.8.2.dev
Expr_GeneralFunction Class Referenceabstract

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

#include <Expr_GeneralFunction.hxx>

Inheritance diagram for Expr_GeneralFunction:

Public Member Functions

virtual Standard_Integer NbOfVariables () const =0
 Returns the number of variables of <me>.
 
virtual Handle< Expr_NamedUnknownVariable (const Standard_Integer index) const =0
 Returns the variable denoted by <index> in <me>. Raises OutOfRange if index > NbOfVariables.
 
virtual Handle< Expr_GeneralFunctionCopy () const =0
 Returns a copy of <me> with the same form.
 
virtual Handle< Expr_GeneralFunctionDerivative (const Handle< Expr_NamedUnknown > &var) const =0
 Returns Derivative of <me> for variable .
 
virtual Handle< Expr_GeneralFunctionDerivative (const Handle< Expr_NamedUnknown > &var, const Standard_Integer deg) const =0
 Returns Derivative of <me> for variable with degree <deg>.
 
virtual Standard_Real Evaluate (const Expr_Array1OfNamedUnknown &vars, const TColStd_Array1OfReal &vals) const =0
 Computes the value of <me> with the given variables. Raises NotEvaluable if <vars> does not match all variables of <me>.
 
virtual Standard_Boolean IsIdentical (const Handle< Expr_GeneralFunction > &func) const =0
 Tests if <me> and <func> are similar functions (same name and same used expression).
 
virtual Standard_Boolean IsLinearOnVariable (const Standard_Integer 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 ()
 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.
 

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.
 

Detailed Description

Defines the general purposes of any function.

Member Function Documentation

◆ Copy()

virtual 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 Handle< Expr_GeneralFunction > Expr_GeneralFunction::Derivative ( const Handle< Expr_NamedUnknown > & var) const
pure virtual

Returns Derivative of <me> for variable .

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Derivative() [2/2]

virtual Handle< Expr_GeneralFunction > Expr_GeneralFunction::Derivative ( const Handle< Expr_NamedUnknown > & var,
const Standard_Integer deg ) const
pure virtual

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

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Evaluate()

virtual Standard_Real Expr_GeneralFunction::Evaluate ( const Expr_Array1OfNamedUnknown & vars,
const TColStd_Array1OfReal & 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 Standard_Boolean Expr_GeneralFunction::IsIdentical ( const 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 Standard_Boolean Expr_GeneralFunction::IsLinearOnVariable ( const Standard_Integer index) const
pure virtual

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

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ NbOfVariables()

virtual Standard_Integer Expr_GeneralFunction::NbOfVariables ( ) const
pure virtual

Returns the number of variables of <me>.

Implemented in Expr_FunctionDerivative, and Expr_NamedFunction.

◆ Variable()

virtual Handle< Expr_NamedUnknown > Expr_GeneralFunction::Variable ( const Standard_Integer 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: