Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET
  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Nuget packages
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.DataAnalysis.Models
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Providers
    • Extreme.Providers.InteropServices
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Mathematics.Algorithms
    • AlgorithmHelper Class
    • ConvergenceException Class
    • ConvergenceMode Enumeration
    • ConvergenceTest(T) Class
    • ConvergenceTestCollection(T) Class
    • ConvergenceTestQuantifier Enumeration
    • IterativeAlgorithm Class
    • ManagedIterativeAlgorithm Class
    • ManagedIterativeAlgorithm(T) Class
    • ManagedIterativeAlgorithm(T, TError, TReport) Class
    • OptimizationGoal Enumeration
    • SimpleConvergenceTest Class
    • SimpleConvergenceTest(T) Class
    • VectorConvergenceErrorMeasure Enumeration
    • VectorConvergenceNorm Enumeration
    • VectorConvergenceTest Class
    • VectorConvergenceTest(T) Class
  • SimpleConvergenceTest(T) Class
    • SimpleConvergenceTest(T) Constructors
    • Properties
    • Methods

SimpleConvergenceTestT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents a convergence test.
Inheritance Hierarchy
SystemObject
  Extreme.Mathematics.AlgorithmsConvergenceTestT
    Extreme.Mathematics.AlgorithmsSimpleConvergenceTestT
      Extreme.Mathematics.AlgorithmsSimpleConvergenceTest
      Extreme.Mathematics.AlgorithmsVectorConvergenceTestT

Namespace:  Extreme.Mathematics.Algorithms
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax
C#
VB
C++
F#
Copy
public class SimpleConvergenceTest<T> : ConvergenceTest<T>

Public Class SimpleConvergenceTest(Of T)
	Inherits ConvergenceTest(Of T)
generic<typename T>
public ref class SimpleConvergenceTest : public ConvergenceTest<T>
type SimpleConvergenceTest<'T> =  
    class
        inherit ConvergenceTest<'T>
    end

Type Parameters

T

The SimpleConvergenceTestT type exposes the following members.

Constructors
  NameDescription
Public methodSimpleConvergenceTestT
Constructs a new SimpleConvergenceTestT object.
Public methodSimpleConvergenceTestT(FuncT, ConvergenceCriterion)
Constructs a new SimpleConvergenceTestT object.
Public methodSimpleConvergenceTestT(FuncT, FuncT, ConvergenceCriterion)
Constructs a new SimpleConvergenceTestT object.
Top
Properties
  NameDescription
Public propertyAbsoluteTolerance
Gets or sets the absolute tolerance used in the convergence test.
(Inherited from ConvergenceTestT.)
Public propertyConvergenceCriterion
Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.
(Inherited from ConvergenceTestT.)
Public propertyEnabled
Gets or sets whether a ConvergenceTestT is enabled.
(Inherited from ConvergenceTestT.)
Public propertyError
Gets the estimated error associated with the convergence test.
(Inherited from ConvergenceTestT.)
Public propertyErrorEvaluator
Gets or sets a delegate that evaluates the error estimate.
Public propertyRelativeTolerance
Gets or sets the relative tolerance used in the convergence test.
(Inherited from ConvergenceTestT.)
Public propertyRequiredSuccessivePasses
Gets or sets a value that indicates the number of times the test criteria must be fulfilled before the test is considered successful.
(Inherited from ConvergenceTestT.)
Public propertyRunBeforeIteration
Gets or sets whether the convergence test should be run before the first actual iteration.
(Inherited from ConvergenceTestT.)
Public propertyTolerance
Gets or sets the tolerance used in the convergence test.
(Inherited from ConvergenceTestT.)
Public propertyValue
Gets the value used in the computation of the relative error.
Public propertyValueEvaluator
Gets or sets a delegate that evaluates the value.
Top
Methods
  NameDescription
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 methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodTestConvergence
Performs the convergence test.
(Inherited from ConvergenceTestT.)
Protected methodTestConvergenceCore
Returns whether the convergence conditions have been met.
(Overrides ConvergenceTestTTestConvergenceCore(Boolean).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Use the SimpleConvergenceTestT class as a convergence test based on whether a value is sufficiently close to another value, or to zero.

See Also

Reference

Extreme.Mathematics.Algorithms Namespace

Copyright (c) 2004-2021 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.