Click or drag to resize
Accord.NET (logo)

BaseLeastSquaresMethod Class

Base class for least-squares optimizers implementing the ILeastSquaresMethod interface.
Inheritance Hierarchy
SystemObject
  Accord.MachineLearningParallelLearningBase
    Accord.Math.OptimizationBaseLeastSquaresMethod
      Accord.Math.OptimizationGaussNewton
      Accord.Math.OptimizationLevenbergMarquardt

Namespace:  Accord.Math.Optimization
Assembly:  Accord.Math (in Accord.Math.dll) Version: 3.8.0
Syntax
public abstract class BaseLeastSquaresMethod : ParallelLearningBase, 
	IConvergenceLearning
Request Example View Source

The BaseLeastSquaresMethod type exposes the following members.

Constructors
  NameDescription
Public methodBaseLeastSquaresMethod
Initializes a new instance of the BaseLeastSquaresMethod class.
Top
Properties
  NameDescription
Protected propertyConvergence
Gets or sets the convergence verification method.
Public propertyCurrentIteration
Gets the current iteration number.
Public propertyFunction
Gets or sets a parameterized model function mapping input vectors into output values, whose optimum parameters must be found.
Public propertyGradient
Gets or sets a function that computes the gradient vector in respect to the function parameters, given a set of input and output values.
Public propertyHasConverged
Gets whether the algorithm has converged.
Public propertyIterations Obsolete.
Please use MaxIterations instead.
Public propertyMaxIterations
Gets or sets the maximum number of iterations performed by the iterative algorithm. Default is 100.
Public propertyNumberOfParameters
Gets the number of variables (free parameters) in the optimization problem.
Public propertyNumberOfVariables Obsolete.
Gets the number of variables (free parameters) in the optimization problem.
Public propertyParallelOptions
Gets or sets the parallelization options for this algorithm.
(Inherited from ParallelLearningBase.)
Public propertySolution
Gets the solution found, the values of the parameters which optimizes the function, in a least squares sense.
Public propertyToken
Gets or sets a cancellation token that can be used to cancel the algorithm while it is running.
(Inherited from ParallelLearningBase.)
Public propertyTolerance
Gets or sets the maximum relative change in the watched value after an iteration of the algorithm used to detect convergence. Default is zero.
Public propertyValue
Gets the value at the solution found. This should be the minimum value found for the objective function.
Top
Methods
  NameDescription
Public methodComputeError
Compute model error for a given data set.
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitialize
This method should be implemented by child classes to initialize their fields once the NumberOfParameters is known.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
See Also