Click or drag to resize

NonlinearModelOfFitEnsemble Class

Adapts a FitEnsemble to the requirements of a Levenberg-Marquardt fitting procedure. This means, the adapter makes the FitEnsemble compatible with the Levenberg-Marquardt algorithm.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.Optimization.ObjectiveFunctionsNonlinearObjectiveFunctionNonAllocatingBase
    Altaxo.Calc.Regression.NonlinearNonlinearModelOfFitEnsemble

Namespace: Altaxo.Calc.Regression.Nonlinear
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class NonlinearModelOfFitEnsemble : NonlinearObjectiveFunctionNonAllocatingBase

The NonlinearModelOfFitEnsemble type exposes the following members.

Constructors
 NameDescription
Public methodNonlinearModelOfFitEnsemble Constructor of the adapter.
Top
Properties
 NameDescription
Public propertyDegreeOfFreedom Get the degree of freedom
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyFunctionEvaluations Get the number of calls to function.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyGradient Get the Gradient vector of x and p.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyHessian Get the Hessian matrix of x and p, J'WJ
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyIsFixedByUser Get whether parameters are fixed or free (by the user).
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyIsFixedByUserOrBoundary Array of the length NumberOfParameters. If an element is true, that parameter is either fixed by the user (see IsFixedByUser), or is fixed because it has reached a boundary. This array will be updated only at the end of the minimization process.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyIsGradientSupported
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyIsHessianSupported
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyJacobianEvaluations Get the number of calls to jacobian.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyModelValues Get the y-values of the fitted model that correspond to the independent values.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyNegativeGradient Get the negative gradient vector of x and p.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyNumberOfObservations Get the number of observations.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyNumberOfParameters Get the number of unknown parameters.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyObservedY Set or get the values of the observations.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyPoint Set or get the values of the parameters.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertySigmaSquare Gets Chi²/(N-F+1)
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyValue Get the residual sum of squares.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public propertyWeights Set or get the values of the weights for the observations.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Top
Methods
 NameDescription
Public methodCopyParametersBackTo 
Public methodCopyParametersForFitElement Copies the current parameters for the fit element with the provided index into the provided array.
Public methodCreateNew
(Overrides NonlinearObjectiveFunctionNonAllocatingBaseCreateNew)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluateAt(IReadOnlyListDouble)
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public methodEvaluateAt(VectorDouble)
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Protected methodEvaluateFunction
(Overrides NonlinearObjectiveFunctionNonAllocatingBaseEvaluateFunction)
Protected methodEvaluateJacobian
(Overrides NonlinearObjectiveFunctionNonAllocatingBaseEvaluateJacobian)
Public methodEvaluateModelValues(VectorDouble, Boolean) Calculates the fitting values.
Public methodEvaluateModelValues(IReadOnlyListDouble, VectorDouble, Boolean) Calculates the fitting values.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFork
(Overrides NonlinearObjectiveFunctionNonAllocatingBaseFork)
Public methodGetDependentVariablesInUse Returns the array of indices of dependent variables that are currently in use (i.e. associated with a data column).
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetValidNumericRows Returns the collection of valid numeric rows for the given fit element.
Public methodGetWeights Stores the weights for the fit differences in an array. The data are stored from FitElement_0 to FitElement_n. For FitElements with more than one dependent variable in use, the data are stored interleaved.
Public methodHasToUseWeights Returns true if any of the fit elements use scaling weights. In this case we have to calculate the weights for all fit elements and include them in the fitting procedures.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodNumericalJacobian
(Overrides NonlinearObjectiveFunctionNonAllocatingBaseNumericalJacobian(VectorDouble, VectorDouble, Int32))
Public methodSetParameters(IReadOnlyListDouble, IReadOnlyListBoolean) Set parameters and bounds.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public methodSetParameters(VectorDouble, ListBoolean) Set parameters and bounds.
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public methodToObjectiveFunction
(Inherited from NonlinearObjectiveFunctionNonAllocatingBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
See Also