IFit |
[Missing <summary> documentation for "T:Altaxo.Scripting.IFitFunctionScriptText"]
Namespace: Altaxo.Scripting
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public interface IFitFunctionScriptText : IScriptText, IPureScriptText, ICloneable, IFitFunction
The IFitFunctionScriptText type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CodeEnd |
Gets the line after the user code ends
(Inherited from IScriptText) |
| CodeHeader |
Gets the code header, i.e. the leading script text. This includes the using statements
(Inherited from IScriptText) |
| CodeStart |
Gets the line before the user code starts
(Inherited from IScriptText) |
| CodeTail |
Get the ending text of the script, dependent on the ScriptStyle.
(Inherited from IScriptText) |
| CodeUserDefault |
Gets the default code (i.e. an code example)
(Inherited from IScriptText) |
| CreationTime | Date/Time of creating this fit function. |
| DependentVariablesNames | |
| Errors |
Returns the compiler errors as array of strings.
(Inherited from IScriptText) |
| FitFunctionCategory | Category of the fit function. If the fit function category contains PathSeparatorChars, than the parts of the string that are separated by these chars are treated as separate sub-categories. |
| FitFunctionDescription | Descriptional text for that fit function. |
| FitFunctionName | Name of the fit function. |
| IndependentVariablesNames | |
| IsReadOnly |
Returns true when the script text can not be modified. Use CloneForModification to
obtain a writable copy.
(Inherited from IScriptText) |
| IsUsingUserDefinedParameterNames | Returns true if the script uses user defined parameter names instead of using P[0], P[1] ... |
| NumberOfDependentVariables |
Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
(Inherited from IFitFunction) |
| NumberOfIndependentVariables |
Number of independent variables (i.e. x).
(Inherited from IFitFunction) |
| NumberOfParameters | |
| ScriptName | (Inherited from IScriptText) |
| ScriptObject | (Inherited from IScriptText) |
| ScriptObjectType |
Gives the type of the script object (full name), which is created after successfull compilation.
(Inherited from IScriptText) |
| ScriptText |
Get / sets the script text
(Inherited from IPureScriptText) |
| UserAreaScriptOffset |
Gets the index in the script (considered as string), where the
user area starts. This is momentarily behind the comment line
" ----- add your script below this line ------"
(Inherited from IScriptText) |
| UserDefinedParameterNames | Get / sets the user defined parameter names. If setting, this also sets the property IsUsingUserDefinedParameterNames to true, and the NumberOfParameters to the given number of user defined parameters. |
Methods| Name | Description | |
|---|---|---|
 | ClearErrors |
Clears the errors.
(Inherited from IScriptText) |
| Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable) |
| CloneForModification |
This clones the script so that the text can be modified.
(Inherited from IScriptText) |
| Compile |
Does the compilation of the script into an assembly.
If it was not compiled before or is dirty, it is compiled first.
From the compiled assembly, a new instance of the newly created script class is created
and stored in m_ScriptObject.
(Inherited from IScriptText) |
| CopyFrom(IFitFunctionScriptText, Boolean) | |
| CopyFrom(IScriptText, Boolean) |
Copies the content of a script to here.
(Inherited from IScriptText) |
| DefaultParameterValue |
Returns a default parameter value. You must ensure that the fit function would generate
values with those default parameters.
(Inherited from IFitFunction) |
| DefaultVarianceScaling |
Returns the default variance scaling for the dependent variable i.
(Inherited from IFitFunction) |
| DependentVariableName |
Returns the ith dependent variable name.
(Inherited from IFitFunction) |
| Evaluate(Double, Double, Double) |
This evaluates a function value.
(Inherited from IFitFunction) |
| Evaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) |
Evaluates the function values at multiple x-points.
(Inherited from IFitFunction) |
| 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.
(Inherited from IFitFunction) |
| 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.
(Inherited from IFitFunction) |
| IndependentVariableName |
Returns the ith independent variable name.
(Inherited from IFitFunction) |
| ParameterName |
Returns the ith parameter name.
(Inherited from IFitFunction) |
| SetCompilerResult | (Inherited from IScriptText) |
Events| Name | Description | |
|---|---|---|
 | Changed |
Occurs when the fit function changed, including number or name of parameters, independent variables, dependent variables, or the scaling.
(Inherited from IFitFunction) |
See Also