All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

AdvancedMathematics Class CATMathFunctionX

Mathematics.CATCGMVirtual
  |
  +---AdvancedMathematics.CATMathFunctionGeneral
    |
    +---CATMathFunctionX
 

Usage: you must use this class as is. You should never derive it.


public class CATMathFunctionX

Class representing a scalar function of one variable.

 F: R   -> R
 x   -> F(x)
 


Constructor and Destructor Index


o ~CATMathFunctionX()

Method Index


o DeepDuplicate()
Duplicates this as well as the pointers to the CATMathFunctionX referred to by this.
o Duplicate()
Duplicates this.
o Eval(CATMathInterval&,CATLONG32,CATMathOption,double*,double*,double*)
Simultaneously evaluates this CATMathFunctionX and its derivatives at regularly spaced values.
o Eval(double&)
Evaluates this CATMathFunctionX.
o Eval(double,CATMathOption,double*,double*,double*)
Simultaneously evaluates this CATMathFunctionX and its derivatives.
o EvalFirstDeriv(double&)
Evaluates the first derivative of this CATMathFunctionX.
o EvalSecondDeriv(double&)
Evaluates the second derivative of this CATMathFunctionX.
o EvalThirdDeriv(double&)
Evaluates the third derivative of this CATMathFunctionX.
o IsAKindOf(CATMathClassId)
Tests if this CATMathFunctionX derives from a class (given by its name).
o IsATypeOf(CATMathFunctionXTypeId)
Tests if this CATMathFunctionX derives from a class (given by a numerical value).

Constructor and Destructor


o ~CATMathFunctionX
public virtual ~CATMathFunctionX()

Methods


o DeepDuplicate
public virtual CATMathFunctionX * DeepDuplicate()const
Duplicates this as well as the pointers to the CATMathFunctionX referred to by this. Must be implemented when defining a user CATMathFunctionX.
o Duplicate
public virtual CATMathFunctionX * Duplicate()const = 0
Duplicates this. Must be implemented when defining a user CATMathFunctionX.
o Eval
public virtual void Eval( const CATMathInterval& iI,
const CATLONG32 iNbPoints,
const CATMathOption iOption,
double* ioF,
double* ioDf= 0,
double* ioD2f= 0) const
Simultaneously evaluates this CATMathFunctionX and its derivatives at regularly spaced values.
Precondition: The output arrays must have been previously allocated if you asked for the corresponding evaluation.
Parameters:
iI
The interval containing the regularly spaced values.
iNbPoints
The number of values of iI where this CATMathFunctionX must be evaluated. If NbPoints = 1, the evaluations are made on the first value of iI.
iOption
The type of evalution.
Legal values:
OptionEval
evaluation of the function
OptionEvalFirstDeriv
evaluation of the first derivatives of the function
OptionEvalSecondDeriv
evaluation of the second derivatives of the function
sum of preceeding values
multiple evaluation.
ioF
The array of evaluations of this CATMathFunctionX at the regurlarly spaced values.
ioDf
The array of the first derivatives of this CATMathFunctionX at the regurlarly spaced values.
ioD2f
The array of the second derivatives of this CATMathFunctionX at the regurlarly spaced values.
o Eval
public virtual double Eval( const double& iT) const = 0
Evaluates this CATMathFunctionX.
Parameters:
iT
The variable value where this CATMathFunctionX is evaluated.
Returns:
The result of the evaluation.
o Eval
public virtual void Eval( const double iT,
const CATMathOption iOption,
double* ioF,
double* ioDf= 0,
double* ioD2f= 0) const
Simultaneously evaluates this CATMathFunctionX and its derivatives.
Precondition: The pointers must have been previously allocated if you asked for the corresponding evaluation.
Parameters:
iT
The variable value where this CATMathFunctionX is evaluated.
iOption
The type of evalution.
Legal values:
OptionEval
evaluation of the function
OptionEvalFirstDeriv
evaluation of the first derivatives of the function
OptionEvalSecondDeriv
evaluation of the second derivatives of the function
sum of preceeding values
multiple evaluation.
ioF
A pointer to the value of this CATMathFunctionX.
ioDf
A pointer to the first derivative of this CATMathFunctionX.
ioD2f
A pointer to the second derivative of this CATMathFunctionX.
o EvalFirstDeriv
public virtual double EvalFirstDeriv( const double& iT) const
Evaluates the first derivative of this CATMathFunctionX.
Parameters:
iT
The variable value where this CATMathFunctionX is evaluated.
Returns:
The result of the evaluation.
o EvalSecondDeriv
public virtual double EvalSecondDeriv( const double& iT) const
Evaluates the second derivative of this CATMathFunctionX.
Parameters:
iT
The variable value where this CATMathFunctionX is evaluated.
Returns:
The result of the evaluation.
o EvalThirdDeriv
public virtual double EvalThirdDeriv( const double& iT) const
Evaluates the third derivative of this CATMathFunctionX.
Parameters:
iT
The variable value where this CATMathFunctionX is evaluated.
Returns:
The result of the evaluation.
o IsAKindOf
public virtual CATBoolean IsAKindOf( const CATMathClassId iClassId) const
Tests if this CATMathFunctionX derives from a class (given by its name).
Parameters:
iClassId
The name of the class.
Returns:
The result of the test.
Legal values: TRUE if this CATMathFunctionX is a kind of iClassId, FALSE otherwise.
o IsATypeOf
public virtual CATBoolean IsATypeOf( const CATMathFunctionXTypeId iType) const
Tests if this CATMathFunctionX derives from a class (given by a numerical value).
Parameters:
iClassId
The numerical value representing the class type.
Returns:
The result of the test.
Legal values: TRUE if this CATMathFunction is a type of iType, FALSE otherwise.

This object is included in the file: CATMathFunctionX.h
If needed, your Imakefile.mk should include the module: CATAdvancedMathematics

Copyright © 2003, Dassault Systèmes. All rights reserved.