Click or drag to resize

LogisticIncreasing Class

Fit fuction with one or more increasing steps (Logistic function), with a background polynomial of variable order.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.FitFunctions.TransitionsLogisticIncreasing

Namespace: Altaxo.Calc.FitFunctions.Transitions
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class LogisticIncreasing : IFitFunctionWithDerivative, 
	IFitFunction, IImmutable

The LogisticIncreasing type exposes the following members.

Constructors
 NameDescription
Public methodLogisticIncreasing Initializes a new instance of the LogisticIncreasing class with NumberOfTerms=1, and OrderOfBackgroundPolynomial=0.
Public methodLogisticIncreasing(Int32, Int32) Initializes a new instance of the LogisticIncreasing class.
Top
Properties
 NameDescription
Public propertyNumberOfDependentVariables Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
Public propertyNumberOfIndependentVariables Number of independent variables (i.e. x).
Public propertyNumberOfParameters Number of parameters of this fit function.
Public propertyNumberOfTerms Gets the number of logistic step terms.
Public propertyOrderOfBackgroundPolynomial Gets the order of the background polynomial.
Top
Methods
 NameDescription
Public methodStatic memberCreate_1_0 Creates a new instance of the LogisticIncreasing class, with NumberOfTerms=1 and OrderOfBackgroundPolynomial=0.
Public methodDefaultParameterValue Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters.
Public methodDefaultVarianceScaling 
Public methodDependentVariableName Returns the ith dependent variable name.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluate(Double, Double, Double) This evaluates a function value.
Public methodEvaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) 
Public methodEvaluateDerivative This evaluates the gradient of the function with respect to the parameters.
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 methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetParameterBoundariesHardLimit 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.
Public methodGetParameterBoundariesSoftLimit 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.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndependentVariableName Returns the ith independent variable name.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParameterName Returns the ith parameter name.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWithNumberOfTerms Creates a new instance with the provided number of logistic step terms.
Public methodWithOrderOfBackgroundPolynomial Creates a new instance with the provided order of the background polynomial.
Top
Events
 NameDescription
Public eventChanged Not functional because instance is immutable.
Top
Remarks
See Also