IObjective |
Extends IObjectiveModel to help avoid memory allocations during execution of Levenberg-Marquardt.
Namespace: Altaxo.Calc.Optimization
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
SyntaxC#
public interface IObjectiveModelNonAllocating : IObjectiveModel, IObjectiveModelEvaluation
The IObjectiveModelNonAllocating type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DegreeOfFreedom |
Gets the degrees of freedom.
(Inherited from IObjectiveModelEvaluation) |
| FunctionEvaluations |
Gets or sets the number of calls to the objective function.
(Inherited from IObjectiveModelEvaluation) |
| Gradient |
Gets the gradient vector. G = J'(y - f(x; p)).
(Inherited from IObjectiveModelEvaluation) |
| Hessian |
Gets the approximated Hessian matrix. H = J'J.
(Inherited from IObjectiveModelEvaluation) |
| IsFixedByUserOrBoundary | Gets or sets an array of the same length as the parameter array. If an element in this vector is , that parameter is either fixed by the user or fixed because the corresponding parameter has reached a boundary. This array is updated only at the end of the minimization process. |
| IsGradientSupported |
Gets a value indicating whether the gradient can be provided by the model.
(Inherited from IObjectiveModelEvaluation) |
| IsHessianSupported |
Gets a value indicating whether the Hessian can be provided by the model.
(Inherited from IObjectiveModelEvaluation) |
| JacobianEvaluations |
Gets or sets the number of calls to the Jacobian.
(Inherited from IObjectiveModelEvaluation) |
| ModelValues |
Gets the y-values of the fitted model that correspond to the independent values.
(Inherited from IObjectiveModelEvaluation) |
| NegativeGradient | Gets the negative gradient vector. -G = -J'(y - f(x; p)). |
| ObservedY |
Gets the y-values of the observations.
(Inherited from IObjectiveModelEvaluation) |
| Point |
Gets the values of the parameters.
(Inherited from IObjectiveModelEvaluation) |
| Value |
Gets the residual sum of squares.
(Inherited from IObjectiveModelEvaluation) |
| Weights |
Gets the values of the weights for the observations.
(Inherited from IObjectiveModelEvaluation) |
Methods| Name | Description | |
|---|---|---|
 | CreateNew |
Creates a new instance of the objective model with identical configuration but independent state.
(Inherited from IObjectiveModelEvaluation) |
| EvaluateAt(IReadOnlyListDouble) | Evaluates the model with the given parameter set. The resulting Chi² value (i.e., the sum of squares of deviations between data and fit model) can be accessed via Value. |
| EvaluateAt(VectorDouble) |
Evaluates the model at the given parameter vector, updating dependent values.
(Inherited from IObjectiveModel) |
| Fork |
Creates a forked copy of the model with independent mutable state.
(Inherited from IObjectiveModel) |
| SetParameters(IReadOnlyListDouble, IReadOnlyListBoolean) | Sets the initial parameters and the information whether some of the parameters are fixed. |
| SetParameters(VectorDouble, ListBoolean) |
Sets the model parameters and optional fixed flags for individual parameters.
(Inherited from IObjectiveModel) |
| ToObjectiveFunction |
Converts this model to an objective function suitable for minimizers.
(Inherited from IObjectiveModel) |
See Also