| DelegateBasedVariableT Class | 
 Inheritance Hierarchy
Inheritance HierarchyNamespace: AGI.Foundation.NumericalMethods
 Syntax
Syntaxpublic class DelegateBasedVariable<T> : SegmentPropagatorVariable where T : SegmentConfiguration
The DelegateBasedVariableT type exposes the following members.
 Constructors
Constructors| Name | Description | |
|---|---|---|
|  | DelegateBasedVariableT | Initializes a new instance. Before GetEvaluator(EvaluatorGroup) can be called, Setter, PerturbationValue and Segment must be configured, and Settings must be configured with a valid MaximumStep. Scaling defaults to NoScalingOnVariable. | 
|  | DelegateBasedVariableT(DelegateBasedVariableT, CopyContext) | Initializes a new instance as a copy of an existing instance. | 
|  | DelegateBasedVariableT(Double, Double, SegmentDefinition, SetVariableCallbackT) | 
            Initializes a new instance.
             | 
|  | DelegateBasedVariableT(Double, Double, SegmentDefinition, SetVariableCallbackT, SolverVariableScaling) | 
            Initializes a new instance.
             | 
 Properties
Properties| Name | Description | |
|---|---|---|
|  | IsFrozen | 
            Gets a value indicating whether this object is frozen.  A frozen object cannot be modified and an
            ObjectFrozenException will be thrown if an attempt is made to do so.
            (Inherited from DefinitionalObject.) | 
|  | Name | 
            Gets or sets an optional name for this variable.
            (Inherited from SegmentPropagatorVariable.) | 
|  | PerturbationValue | 
            Gets or sets the perturbation value to use when computing a numerical derivative relative
            to this variable of a SolvableMultivariableFunction that uses
            SegmentPropagators.
            (Inherited from SegmentPropagatorVariable.) | 
|  | Segment | 
            Gets or sets the segment that this variable will act on.
            (Inherited from SegmentPropagatorVariable.) | 
|  | Setter | 
            Gets or sets the delegate that will alter the relevant value in the 
            segment's configuration.
             | 
|  | Settings | 
            Gets or sets the settings for the MultivariableFunctionSolver associated with this variable.
            (Inherited from SegmentPropagatorVariable.) | 
 Methods
Methods| Name | Description | |
|---|---|---|
|  | CheckForSameDefinition(DefinitionalObject) | 
        Checks to determine if another instance has the same definition as this instance and
        returns  if it does.  Derived classes MUST override this method and check
        all new fields introduced by the derived class for definitional equivalence.  It is NOT necessary
        to check base class fields because the base class will already have done that.  When overriding this method,
        you should NOT call the base implementation because it will return  for all derived-class instances.
        Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
      (Inherited from SegmentPropagatorVariable.) | 
|  | CheckForSameDefinition(DelegateBasedVariableT) | 
        Checks to determine if another instance has the same definition as this instance and
        returns  if it does.  Derived classes MUST override this method and check
        all new fields introduced by the derived class for definitional equivalence.  It is NOT necessary
        to check base class fields because the base class will already have done that.  When overriding this method,
        you should NOT call the base implementation because it will return  for all derived-class instances.
        Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
       | 
|  | CheckForSameDefinition(SegmentPropagatorVariable) | 
        Checks to determine if another instance has the same definition as this instance and
        returns  if it does.  Derived classes MUST override this method and check
        all new fields introduced by the derived class for definitional equivalence.  It is NOT necessary
        to check base class fields because the base class will already have done that.  When overriding this method,
        you should NOT call the base implementation because it will return  for all derived-class instances.
        Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
      (Overrides SegmentPropagatorVariableCheckForSameDefinition(SegmentPropagatorVariable).) | 
|  | Clone | 
            Clones this object using the specified context.
            (Overrides DefinitionalObjectClone(CopyContext).) | 
|  | ComputeCurrentDefinitionHashCode | 
        Computes a hash code based on the current properties of this object. Derived classes MUST override this
        method and compute a hash code that combines: a unique hash code seed, the base implementation result, and
        the hash codes of all new fields introduced by the derived class which are used in the
        CheckForSameDefinition(DefinitionalObject) method.
      (Overrides SegmentPropagatorVariableComputeCurrentDefinitionHashCode.) | 
|  | EnumerateDependencies | 
        Enumerates the dependencies of this object by calling
        EnumerateT(T) for each object that this object directly depends upon.
        Derived classes which contain additional dependencies MUST override this method, call the base
        implementation, and enumerate dependencies introduced by the derived class.
      (Overrides SegmentPropagatorVariableEnumerateDependencies(DependencyEnumerator).) | 
|  | Equals | Determines whether the specified object is equal to the current object.(Inherited from Object.) | 
|  | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) | 
|  | Freeze | 
            Freezes this object.  Further attempts to modify it will result
            in an ObjectFrozenException.
            (Inherited from DefinitionalObject.) | 
|  | FreezeAggregatedObjects | 
        Called by Freeze to also freeze any objects that are considered to be a part of this object.
        Derived classes which contain additional aggregated objects MUST override this method, call the base
        implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be
        frozen in this method are frequently created in this object's constructor and are not settable via
        properties.
      (Inherited from SegmentPropagatorVariable.) | 
|  | GetDefinitionHashCode | 
            Gets a hash code representing the definition of this object.
            (Inherited from DefinitionalObject.) | 
|  | GetEvaluator | 
            Gets a SegmentPropagatorVariableEvaluator for this variable. 
            (Overrides SegmentPropagatorVariableGetEvaluator(EvaluatorGroup).) | 
|  | GetHashCode | Serves as the default hash function. (Inherited from Object.) | 
|  | GetType | Gets the Type of the current instance.(Inherited from Object.) | 
|  | IsSameDefinition | 
        Determines if this object has the same definition as another object.
      (Inherited from DefinitionalObject.) | 
|  | MemberwiseClone | Creates a shallow copy of the current Object.(Inherited from Object.) | 
|  | ThrowIfFrozen | 
            Throws ObjectFrozenException if this object IsFrozen.
            This method should be called from any method or property that modifies this object.
            (Inherited from DefinitionalObject.) | 
|  | ToString | Returns a string that represents the current object.(Inherited from Object.) | 
|  | ValidateProperties | 
            Validates that required properties are configured correctly in order to get an
            evaluator for this instance. Derived classes should call this method when implementing
            GetEvaluator(EvaluatorGroup), as well as validate their own properties.
            (Overrides SegmentPropagatorVariableValidateProperties.) | 
 See Also
See Also