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
  • ConvergenceTestCollection(T) Class
    • ConvergenceTestCollection(T) Constructors
    • Properties
    • Methods

ConvergenceTestCollectionT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents a collection of convergence tests for an IterativeAlgorithm.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.AlgorithmsConvergenceTestT
    Extreme.Mathematics.AlgorithmsConvergenceTestCollectionT

Namespace:  Extreme.Mathematics.Algorithms
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax

C#
VB
C++
F#
Copy
public sealed class ConvergenceTestCollection<T> : ConvergenceTest<T>, 
	ICollection, IEnumerable, ICollection<ConvergenceTest<T>>, IEnumerable<ConvergenceTest<T>>
Public NotInheritable Class ConvergenceTestCollection(Of T)
	Inherits ConvergenceTest(Of T)
	Implements ICollection, IEnumerable, ICollection(Of ConvergenceTest(Of T)), 
	IEnumerable(Of ConvergenceTest(Of T))
generic<typename T>
public ref class ConvergenceTestCollection sealed : public ConvergenceTest<T>, 
	ICollection, IEnumerable, ICollection<ConvergenceTest<T>^>, IEnumerable<ConvergenceTest<T>^>
[<SealedAttribute>]
type ConvergenceTestCollection<'T> =  
    class
        inherit ConvergenceTest<'T>
        interface ICollection
        interface IEnumerable
        interface ICollection<ConvergenceTest<'T>>
        interface IEnumerable<ConvergenceTest<'T>>
    end

Type Parameters

T

The ConvergenceTestCollectionT type exposes the following members.

Constructors

  NameDescription
Public methodConvergenceTestCollectionT
Constructs a new ConvergenceTestCollectionT.
Public methodConvergenceTestCollectionT(ConvergenceTestT)
Constructs a new ConvergenceTestCollectionT.
Public methodConvergenceTestCollectionT(ConvergenceTestQuantifier, ConvergenceTestT)
Constructs a new ConvergenceTestCollectionT.
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 propertyCount
Gets the number of tests in the ConvergenceTestCollectionT
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 propertyIsReadOnly
Gets a value indicating whether the ConvergenceTestCollectionT is read-only.
Public propertyQuantifier
Gets or sets a value that indicates how the tests in the collection are to be combined.
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.)
Top
Methods

  NameDescription
Public methodAdd
Adds a ConvergenceTestT to the collection.
Public methodClear
Removes all tests in the collection.
Public methodContains
Determines whether the ConvergenceTestCollectionT contains a specific item.
Public methodCopyTo
Copies the members of the collection to the specified array.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetEnumerator
Gets an IEnumerator object that can iterate over the tests in the collection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes the first occurrence of the specified item from the ConvergenceTestCollectionT.
Public methodTestConvergence
Performs the convergence test.
(Inherited from ConvergenceTestT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods

  NameDescription
Public Extension MethodGroupConvergenceTestTOverloaded.
Returns a grouping by the unique elements in a sequence.
(Defined by Grouping.)
Public Extension MethodGroupConvergenceTestT(IEqualityComparerConvergenceTestT)Overloaded.
Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality.
(Defined by Grouping.)
Public Extension MethodSumConvergenceTestTOverloaded.
Computes the sum of the sequence of values.
(Defined by ArrayMath.)
Public Extension MethodSumConvergenceTestT, U(FuncConvergenceTestT, U)Overloaded.
Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by ArrayMath.)
Top
Remarks

Use the ConvergenceTestCollectionT to specify a convergence test that consists of several criteria. Depending on the value of the Quantifier property, the test succeeds if any one of the member tests succeed, or only if all of the tests succeed. Only tests whose Enabled property is are included in the test.

See Also

Reference

Extreme.Mathematics.Algorithms Namespace
Extreme.Mathematics.AlgorithmsSimpleConvergenceTestT
Extreme.Mathematics.AlgorithmsVectorConvergenceTestT

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.