Click or drag to resize

RateOfConversionNthOrderEvaluateDerivative Method

This evaluates the gradient of the function with respect to the parameters.

Namespace: Altaxo.Calc.FitFunctions.Kinetics
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public void EvaluateDerivative(
	IROMatrix<double> X,
	IReadOnlyList<double> P,
	IReadOnlyList<bool>? isParameterFixed,
	IMatrix<double> DY,
	IReadOnlyList<bool> dependentVariableChoice
)

Parameters

X  IROMatrixDouble

[Missing <param name="X"/> documentation for "M:Altaxo.Calc.FitFunctions.Kinetics.RateOfConversionNthOrder.EvaluateDerivative(Altaxo.Calc.LinearAlgebra.IROMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean},Altaxo.Calc.LinearAlgebra.IMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean})"]

P  IReadOnlyListDouble

[Missing <param name="P"/> documentation for "M:Altaxo.Calc.FitFunctions.Kinetics.RateOfConversionNthOrder.EvaluateDerivative(Altaxo.Calc.LinearAlgebra.IROMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean},Altaxo.Calc.LinearAlgebra.IMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean})"]

isParameterFixed  IReadOnlyListBoolean

[Missing <param name="isParameterFixed"/> documentation for "M:Altaxo.Calc.FitFunctions.Kinetics.RateOfConversionNthOrder.EvaluateDerivative(Altaxo.Calc.LinearAlgebra.IROMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean},Altaxo.Calc.LinearAlgebra.IMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean})"]

DY  IMatrixDouble

[Missing <param name="DY"/> documentation for "M:Altaxo.Calc.FitFunctions.Kinetics.RateOfConversionNthOrder.EvaluateDerivative(Altaxo.Calc.LinearAlgebra.IROMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean},Altaxo.Calc.LinearAlgebra.IMatrix{System.Double},System.Collections.Generic.IReadOnlyList{System.Boolean})"]

dependentVariableChoice  IReadOnlyListBoolean
Determines which output variables are written to the output vector. See remarks.

Implements

IFitFunctionWithDerivativeEvaluateDerivative(IROMatrixDouble, IReadOnlyListDouble, IReadOnlyListBoolean, IMatrixDouble, IReadOnlyListBoolean)
Remarks
The derivative values are stored in the array DF. For each dependent variable of the fit function that is included in the output (see dependentVariableChoice), the derivative to all given parameters must be calculated. Presumed we have 3 parameters (p0, p1 and p2) and 2 dependent variables (f0 and f1), for one observation the array DF must contain:
C#
DF[0,0] : df0/dp0
DF[0,1] : df0/dp1
DF[0,2] : df0/dp2
DF[1,0] : df1/dp0
DF[1,1] : df2/dp1
DF[1,2] : df1/dp2
Concerning dependentVariableChoice: if this parameter is null, the derivatives of all dependent variables the fit function provides will be included in the output matrix DF. If this parameter is not null, only the derivatives of those dependent variables, for which the element is true, are included in the output vector (at least one element of this array must be true).
See Also