Expr_NamedFunction Class Reference

#include <Expr_NamedFunction.hxx>

Inheritance diagram for Expr_NamedFunction:

Public Member Functions
	Expr_NamedFunction (const TCollection_AsciiString &namename, const occ::handle< Expr_GeneralExpression > &exp, const NCollection_Array1< occ::handle< Expr_NamedUnknown > > &vars)
	Creates a function of given variables <vars> with name <name> defined by the expression <exp>.
void	SetName (const TCollection_AsciiString &newname)
	Sets the name <newname> to <me>.
TCollection_AsciiString	GetName () const
	Returns the name assigned to <me>.
int	NbOfVariables () const override
	Returns the number of variables of <me>.
occ::handle< Expr_NamedUnknown >	Variable (const int indexindex) const override
	Returns the variable denoted by <index> in <me>. Raises OutOfRange if <index> is greater than NbOfVariables of <me>, or less than or equal to zero.
double	Evaluate (const NCollection_Array1< occ::handle< Expr_NamedUnknown > > &vars, const NCollection_Array1< double > &valuesvalues) const override
	Computes the value of <me> with the given variables. Raises DimensionMismatch if Length(vars) is different from Length(values).
occ::handle< Expr_GeneralFunction >	Copy () const override
	Returns a copy of <me> with the same form.
occ::handle< Expr_GeneralFunction >	Derivative (const occ::handle< Expr_NamedUnknown > &var) const override
	Returns Derivative of <me> for variable .
occ::handle< Expr_GeneralFunction >	Derivative (const occ::handle< Expr_NamedUnknown > &var, const int deg) const override
	Returns Derivative of <me> for variable with degree <deg>.
bool	IsIdentical (const occ::handle< Expr_GeneralFunction > &funcfunc) const override
	Tests if <me> and <func> are similar functions (same name and same used expression).
bool	IsLinearOnVariable (const int indexindex) const override
	Tests if <me> is linear on variable on range <index>.
TCollection_AsciiString	GetStringName () const override
occ::handle< Expr_GeneralExpression >	Expression () const
	Returns equivalent expression of <me>.
void	SetExpression (const occ::handle< Expr_GeneralExpression > &exp)
	Modifies expression of <me>. Warning: Beware of derivatives. See FunctionDerivative.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (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_Transient *	This () 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
typedef void	base_type
	Returns a type descriptor about this object.
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_NamedFunction()

Expr_NamedFunction::Expr_NamedFunction	(	const TCollection_AsciiString &	name,
		const occ::handle< Expr_GeneralExpression > &	exp,
		const NCollection_Array1< occ::handle< Expr_NamedUnknown > > &	vars )

Creates a function of given variables <vars> with name <name> defined by the expression <exp>.

Member Function Documentation

Copy()

occ::handle< Expr_GeneralFunction > Expr_NamedFunction::Copy ( ) const

overridevirtual

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

Implements Expr_GeneralFunction.

Derivative() [1/2]

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

overridevirtual

Returns Derivative of <me> for variable .

Implements Expr_GeneralFunction.

Derivative() [2/2]

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

overridevirtual

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

Implements Expr_GeneralFunction.

Evaluate()

double Expr_NamedFunction::Evaluate ( const NCollection_Array1< occ::handle< Expr_NamedUnknown > > & vars, const NCollection_Array1< double > & values ) const

overridevirtual

Computes the value of <me> with the given variables. Raises DimensionMismatch if Length(vars) is different from Length(values).

Implements Expr_GeneralFunction.

Expression()

occ::handle< Expr_GeneralExpression > Expr_NamedFunction::Expression

(

)

const

Returns equivalent expression of <me>.

GetName()

TCollection_AsciiString Expr_NamedFunction::GetName

(

)

const

Returns the name assigned to <me>.

GetStringName()

TCollection_AsciiString Expr_NamedFunction::GetStringName ( ) const

overridevirtual

Implements Expr_GeneralFunction.

IsIdentical()

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

overridevirtual

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

Implements Expr_GeneralFunction.

IsLinearOnVariable()

bool Expr_NamedFunction::IsLinearOnVariable ( const int index ) const

overridevirtual

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

Implements Expr_GeneralFunction.

NbOfVariables()

int Expr_NamedFunction::NbOfVariables ( ) const

overridevirtual

Returns the number of variables of <me>.

Implements Expr_GeneralFunction.

SetExpression()

void Expr_NamedFunction::SetExpression

(

const occ::handle< Expr_GeneralExpression > &

exp

)

Modifies expression of <me>. Warning: Beware of derivatives. See FunctionDerivative.

SetName()

void Expr_NamedFunction::SetName

(

const TCollection_AsciiString &

newname

)

Sets the name <newname> to <me>.

Variable()

occ::handle< Expr_NamedUnknown > Expr_NamedFunction::Variable ( const int index ) const

overridevirtual

Returns the variable denoted by <index> in <me>. Raises OutOfRange if <index> is greater than NbOfVariables of <me>, or less than or equal to zero.

Implements Expr_GeneralFunction.

---

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

• Expr_NamedFunction.hxx