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
  • ManagedIterativeAlgorithm(T) Class
    • ManagedIterativeAlgorithm(T) Constructor
    • ManagedIterativeAlgorithm(T) Properties
    • ManagedIterativeAlgorithm(T) Methods

ManagedIterativeAlgorithmT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents an implementation of an iterative algorithm that uses a managed driver routine.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmT, Double, SolutionReportT, Double
    Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmT
      Extreme.Mathematics.AlgorithmsIterativeAlgorithm
      Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithm
      Extreme.Mathematics.Calculus.OrdinaryDifferentialEquationsOdeIntegrator
      Extreme.Mathematics.OptimizationLeastSquaresOptimizer
      Extreme.Mathematics.OptimizationOneDimensionalOptimizer

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

C#
VB
C++
F#
Copy
public abstract class ManagedIterativeAlgorithm<T> : ManagedIterativeAlgorithm<T, double, SolutionReport<T, double>>
Public MustInherit Class ManagedIterativeAlgorithm(Of T)
	Inherits ManagedIterativeAlgorithm(Of T, Double, SolutionReport(Of T, Double))
generic<typename T>
public ref class ManagedIterativeAlgorithm abstract : public ManagedIterativeAlgorithm<T, double, SolutionReport<T, double>^>
[<AbstractClassAttribute>]
type ManagedIterativeAlgorithm<'T> =  
    class
        inherit ManagedIterativeAlgorithm<'T, float, SolutionReport<'T, float>>
    end

Type Parameters

T

The ManagedIterativeAlgorithmT type exposes the following members.

Constructors

  NameDescription
Protected methodManagedIterativeAlgorithmT
Initializes a new instance of the ManagedIterativeAlgorithmT class
Top
Properties

  NameDescription
Public propertyConvergenceTests
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyEstimatedError
Gets a value indicating the size of the absolute error of the result.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyEvaluationsNeeded
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected propertyEvaluationsRemaining
Gets the number of evaluations still available.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyHasSharedDegreeOfParallelism
Indicates whether the degree of parallelism is a property that is shared across instances.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyIterationsNeeded
Gets the number of iterations needed by the algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected propertyIterationsRemaining
Gets the number of iterations remaining.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxDegreeOfParallelism
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxEvaluations
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxIterations
Gets or sets the maximum number of iterations to use when approximating the roots of the target function.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMinIterations
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyParallelOptions
Gets or sets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyResult
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertySolutionReport
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyStatus
Gets the AlgorithmStatus following an execution of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyThrowExceptionOnFailure
Gets or sets a value indicating whether to throw an exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
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 methodIncrementEvaluations
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodIncrementEvaluations(Int32)
Increments the number of evaluations by the specified amount.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodIterate
Performs one iteration of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodIterated
Performs tasks after the iteration is completed, but before the status of the algorithm is finalized.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConvergence
Performs any tasks after the main algorithm has converged.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodOnFailure
Performs any tasks after the main algorithm has failed to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodOnInit
Performs initialization before the first iteration.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodReportFailure
Records the results of an algorithm in case it fails.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodReportResult
Records the results of an algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodReportSuccess
Records the results of a algorithm that converged successfully.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodResetEvaluations
Resets the number of evaluations to zero.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodRestart
Prepares the algorithm to be run again with possibly different inputs.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodRun
Runs the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodRun(ParallelOptions)
Runs the algorithm using the specified parallelization options.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodSetResult
Sets the results of an algorithm's execution.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodTestConvergence
Checks whether the algorithm has converged.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodThreadSafeIncrementEvaluations
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodThreadSafeIncrementEvaluations(Int32)
Increments the number of evaluations by the specified amount.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected methodThrowConvergenceException
Interprets the AlgorithmStatus and throws the appropriate exception.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference

Extreme.Mathematics.Algorithms Namespace
Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmT, TError, TReport

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.