AdvancedMathematics CATMathPolynomX
Usage: you must use this class as is. You should never derive it.
public class CATMathPolynomX
Class defining the real polynom of one variable.
Constructor and Destructor Index
- o
CATMathPolynomX(CATMathPolynomX&)
- Copy constructor.
- o
CATMathPolynomX(CATLONG32,double*,double)
- Constructs a polynom of one variable.
- o
~CATMathPolynomX()
-
Method Index
- o
Eval(double&)
- Evaluates this CATMathPolynomX.
- o
Eval(CATMathInterval&)
- Evaluates this CATMathPolynomX from values defined by an interval.
- o
Eval(double,CATMathOption,double*,double*,double*)
- Simultaneously evaluates this CATMathPolynomX and its derivatives.
- o
Eval(CATMathInterval&,CATLONG32,CATMathOption,double*,double*,double*)
- Simultaneously evaluates this CATMathPolynomX and its derivatives at regularly spaced values.
- o
EvalFirstDeriv(double&)
- Evaluates the first derivative of this CATMathPolynomX.
- o
EvalFirstDeriv(CATMathInterval&)
- Evaluates the first derivative of this CATMathPolynomX from values defined by an interval.
- o
EvalSecondDeriv(double&)
- Evaluates the second derivative of this CATMathPolynomX.
- o
EvalSecondDeriv(CATMathInterval&)
- Evaluates the second derivative of this CATMathPolynomX from values defined by an interval.
- o
EvalThirdDeriv(double&)
- Evaluates the third derivative of this CATMathPolynomX.
- o
EvalThirdDeriv(CATMathInterval&)
- Evaluates the third derivative of this CATMathPolynomX from values defined by an interval.
- o
GetCoefficients(double*)
- Retrieves the coefficients of this CATMathPolynomX.
- o
GetCoefficients()
- Returns the coefficients of this CATMathPolynomX.
- o
GetDegree()
- Returns the degree of this CATMathPolynomX.
- o
IsA()
- Returns the class name of this CATMathPolynomX.
- o
IsAKindOf(CATMathClassId)
- Tests whether this CATMathPolynomX derives from a class (given by its name).
- o
IsATypeOf(CATMathFunctionXTypeId)
- Tests whether this CATMathPolynomX derives from a class (given by a numerical value).
- o
IsOption(CATMathOption)
- Tests whether an evaluator is available for this CATMathPolynomX.
- o
SetCoefficients(CATLONG32,double*)
- Modifies the coeficients of this CATMathPolynomX.
Constructor and Destructor
o CATMathPolynomX
| public CATMathPolynomX( | const | iToCopy) |
-
Copy constructor.
o CATMathPolynomX
| public CATMathPolynomX( | const | iDeg | = 0, |
| const | iCoef | = 0, |
| const | iShift | =0.) |
-
Constructs a polynom of one variable.
- Parameters:
-
- iDeg
- The degree of the polynom.
- iCoeff
- The array of the coefficients such that:
pol=Sum_{i=0..iDeg} iCoef[i] X^i .
- iShift
- Internal use.
o ~CATMathPolynomX
| public virtual ~CATMathPolynomX( | ) |
-
Methods
o Eval
| public virtual Eval( | const | iT) |
-
Evaluates this CATMathPolynomX.
- Parameters:
-
- iT
- The variable value where this CATMathPolynomX is evaluated.
- Returns:
- The result of the evaluation.
o Eval
| public virtual Eval( | const | x) |
-
Evaluates this CATMathPolynomX from values defined by an interval.
- Parameters:
-
- x
- The interval containing the input values.
- Returns:
- The interval containing the values of this CATMathPolynomX.
o Eval
| public virtual Eval( | const | iT, |
| const | iOption, |
| | ioF, |
| | ioDf | = 0, |
| | ioD2f | = 0) |
-
Simultaneously evaluates this CATMathPolynomX 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 CATMathPolynomX 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 CATMathPolynomX.
- ioDf
- A pointer to the first derivative of this CATMathPolynomX.
- ioD2f
- A pointer to the second derivative of this CATMathPolynomX.
o Eval
| public virtual Eval( | const | iI, |
| const | iNbPoints, |
| const | iOption, |
| | ioF, |
| | ioDf | = 0, |
| | ioD2f | = 0) |
-
Simultaneously evaluates this CATMathPolynomX 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 CATMathPolynomX 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 CATMathPolynomX at the regurlarly spaced values.
- ioDf
- The array of the first derivatives of this CATMathPolynomX at the regurlarly spaced values.
- ioD2f
- The array of the second derivatives of this CATMathPolynomX at the regurlarly spaced values.
o EvalFirstDeriv
| public virtual EvalFirstDeriv( | const | iT) |
-
Evaluates the first derivative of this CATMathPolynomX.
- Parameters:
-
- iT
- The variable value where this CATMathPolynomX is evaluated.
- Returns:
- The result of the evaluation.
o EvalFirstDeriv
| public virtual EvalFirstDeriv( | const | x) |
-
Evaluates the first derivative of this CATMathPolynomX from values defined by an interval.
- Parameters:
-
- x
- The interval containing the input values.
- Returns:
- The interval containing the values of the first derivative.
o EvalSecondDeriv
| public virtual EvalSecondDeriv( | const | iT) |
-
Evaluates the second derivative of this CATMathPolynomX.
- Parameters:
-
- iT
- The variable value where this CATMathPolynomX is evaluated.
- Returns:
- The result of the evaluation.
o EvalSecondDeriv
| public virtual EvalSecondDeriv( | const | x) |
-
Evaluates the second derivative of this CATMathPolynomX from values defined by an interval.
- Parameters:
-
- x
- The interval containing the input values.
- Returns:
- The interval containing the values of the second derivative.
o EvalThirdDeriv
| public virtual EvalThirdDeriv( | const | iT) |
-
Evaluates the third derivative of this CATMathPolynomX.
- Parameters:
-
- iT
- The variable value where this CATMathPolynomX is evaluated.
- Returns:
- The result of the evaluation.
o EvalThirdDeriv
| public virtual EvalThirdDeriv( | const | x) |
-
Evaluates the third derivative of this CATMathPolynomX from values defined by an interval.
- Parameters:
-
- x
- The interval containing the input values.
- Returns:
- The interval containing the values of the third derivative.
o GetCoefficients
| public GetCoefficients( | | ioCoeff) |
-
Retrieves the coefficients of this CATMathPolynomX.
- Parameters:
-
- ioCoeff
- The array (previously allocated) of the coefficients.
pol=Sum_{i=0..iDeg} ioCoef[i] X^i ..
o GetCoefficients
-
Returns the coefficients of this CATMathPolynomX.
- Returns:
- The array of the coefficients. As part of this, it must not be deallocated.
o GetDegree
-
Returns the degree of this CATMathPolynomX.
- Returns:
- The degree.
o IsA
-
Returns the class name of this CATMathPolynomX.
- Returns:
- A pointer to the name CATMathPolynomX.
o IsAKindOf
| public virtual IsAKindOf( | const | iClassId) |
-
Tests whether this CATMathPolynomX 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 CATMathPolynomX is a kind of iClassId,
FALSE otherwise.
o IsATypeOf
| public virtual IsATypeOf( | const | iClassId) |
-
Tests whether this CATMathPolynomX 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 CATMathPolynomX is a type of iType,
FALSE otherwise.
o IsOption
| public virtual IsOption( | const | iOption) |
-
Tests whether an evaluator is available for this CATMathPolynomX.
- Parameters:
-
- iOption
- The type of evalution.
Legal values:
- OptionEval
- evaluation of the function
- OptionEvalFirstDeriv
- evaluation of the first derivative of the function
- OptionEvalSecondDeriv
- evaluation of the second derivative of the function
- OptionEvalThirdDeriv
- evaluation of the third derivative of the function
- Returns:
- The result of the test.
Legal values: TRUE if the evaluation is available for this CATMathPolynomX,
FALSE otherwise.
o SetCoefficients
| public SetCoefficients( | const | iNewDeg | = 0, |
| const | iNewCoef | = 0) |
-
Modifies the coeficients of this CATMathPolynomX.
- Parameters:
-
- iNewDeg
- The new value of the degree.
- iNewCoef
- The array of the new coefficients such that:
pol=Sum_{i=0..iDeg} iCoef[i] X^i .
This object is included in the file: CATMathPolynomX.h
If needed, your Imakefile.mk should include the module: CATAdvancedMathematics
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.