InitialStateSegmentTCreateVariable Method (Double, Double, SetVariableCallbackT, SolverVariableScaling)

Creates a DelegateBasedVariableT based on this segments configuration, which is the state that will be returned when this segment is propagated. This is a helper method to provide variables for the TargetedSegmentListDifferentialCorrector.

Namespace: AGI.Foundation.SegmentPropagation
Assembly: AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public DelegateBasedVariable<InitialStateSegmentConfiguration> CreateVariable(
	double maximumStep,
	double perturbation,
	SetVariableCallback<T> setter,
	SolverVariableScaling scaling
)

Public Function CreateVariable ( 
	maximumStep As Double,
	perturbation As Double,
	setter As SetVariableCallback(Of T),
	scaling As SolverVariableScaling
) As DelegateBasedVariable(Of InitialStateSegmentConfiguration)

public:
DelegateBasedVariable<InitialStateSegmentConfiguration^>^ CreateVariable(
	double maximumStep, 
	double perturbation, 
	SetVariableCallback<T>^ setter, 
	SolverVariableScaling^ scaling
)

member CreateVariable : 
        maximumStep : float * 
        perturbation : float * 
        setter : SetVariableCallback<'T> * 
        scaling : SolverVariableScaling -> DelegateBasedVariable<InitialStateSegmentConfiguration>

Parameters

maximumStep: Type: SystemDouble
The maximum step that the variable should take.
perturbation: Type: SystemDouble
The perturbation that should be used when finding the functions derivative with respect to this variable.
setter: Type: AGI.Foundation.NumericalMethodsSetVariableCallbackT
The delegate that will set the value in the configuration. The value of the variable passed into this delegate is the delta that must be added to the relevant value in the configuration, not the total value that the value in the delegate should be.
scaling: Type: AGI.Foundation.NumericalMethodsSolverVariableScaling
The type of scaling to be used on the variable.

Return Value

Type: DelegateBasedVariableInitialStateSegmentConfiguration
The configured DelegateBasedVariableT.

Reference

InitialStateSegmentT Class

CreateVariable Overload

AGI.Foundation.SegmentPropagation Namespace