IFitFunction Interface

Represents the interface to a fitting function.

Namespace: Altaxo.Calc.Regression.Nonlinear
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

public interface IFitFunction

The IFitFunction type exposes the following members.

Properties

	Name	Description
	NumberOfDependentVariables	Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
	NumberOfIndependentVariables	Number of independent variables (i.e. x).
	NumberOfParameters	Number of parameters of this fit function.

Methods

	Name	Description
	DefaultParameterValue	Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters.
	DefaultVarianceScaling	Returns the default variance scaling for the dependent variable i.
	DependentVariableName	Returns the ith dependent variable name.
	Evaluate(Double, Double, Double)	This evaluates a function value.
	Evaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean)	Evaluates the function values at multiple x-points.
	GetParameterBoundariesHardLimit	Gets the parameter boundaries that are really a hard limit, i.e. outside those limits, the function would probably evaluate NaN values, or makes no sense.
	GetParameterBoundariesSoftLimit	Gets the intended parameter boundaries. This are soft limits, boundaries so that the intended purpose of the fit function is fullfilled. Example: in the exponential decay Exp(-a*t) a is intended to be positive. This is a soft limit, and not a hard limit, because a could be also negative, and the fit nevertheless would succeed.
	IndependentVariableName	Returns the ith independent variable name.
	ParameterName	Returns the ith parameter name.

Events

	Name	Description
	Changed	Occurs when the fit function changed, including number or name of parameters, independent variables, dependent variables, or the scaling.