Click or drag to resize

LinearApproximation Class

A technique for Linear Interpolation.
Inheritance Hierarchy

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class LinearApproximation : InterpolationAlgorithm

The LinearApproximation type exposes the following members.

Constructors
  NameDescription
Public methodLinearApproximation
Initializes a new instance.
Protected methodLinearApproximation(LinearApproximation, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyDegreeRequired
Gets the minimum degree of approximation that this interpolator can perform.
(Overrides InterpolationAlgorithmDegreeRequired.)
Public propertyIsFrozen
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.)
Public propertyOrderRequired
Gets the number of derivatives of the dependent variable that are required on input in order to interpolate using this interpolation algorithm.
(Overrides InterpolationAlgorithmOrderRequired.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(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 InterpolationAlgorithm.)
Protected methodCheckForSameDefinition(InterpolationAlgorithm)
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 InterpolationAlgorithmCheckForSameDefinition(InterpolationAlgorithm).)
Protected methodCheckForSameDefinition(LinearApproximation)
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).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 InterpolationAlgorithmComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
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.
(Inherited from DefinitionalObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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 DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInterpolator
Gets an evaluator which can compute the interpolated value of a function.
(Inherited from InterpolationAlgorithm.)
Public methodGetInterpolator(EvaluatorGroup)
Gets an evaluator which can compute the interpolated value of a function.
(Overrides InterpolationAlgorithmGetInterpolator(EvaluatorGroup).)
Public methodStatic memberGetRequiredDataPoints
Gets the number of data points needed to interpolate with the desired degree of accuracy. For linear interpolation, the degree must be one, and the result is always two.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberInterpolate(Double, Double, Double, Double, Double)
Interpolate method that can be called with the coordinates of the 2 points and the independent variable to be interpolated.
Public methodStatic memberInterpolate(Double, Double, Double, Int32, Int32, Int32, Int32, Int32)
Interpolates a dependent value corresponding to an independent value when supplied 2 distinct independent values and at least 1 dependent value per independent value.
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also