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
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
    • 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.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.Distributed.Cuda
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.FSharp
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.Generic.LinearAlgebra
    • Extreme.Mathematics.Generic.LinearAlgebra.Implementation
    • Extreme.Mathematics.Generic.LinearAlgebra.Providers
    • Extreme.Mathematics.Generic.SignalProcessing
    • Extreme.Mathematics.Implementation
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Complex
    • Extreme.Mathematics.LinearAlgebra.Complex.Decompositions
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IO
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.LinearAlgebra.Providers
    • Extreme.Mathematics.LinearAlgebra.Sparse
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.Genetic
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Numerics.FSharp
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.IO
    • Extreme.Statistics.Linq
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Random
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Mathematics.Algorithms
    • AlgorithmHelper Class
    • ConvergenceException Class
    • ConvergenceMode Enumeration
    • ConvergenceTest Class
    • ConvergenceTest(T) Class
    • ConvergenceTestCollection 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
    • Properties
    • Methods
    • Fields
  • Properties
    • ConvergenceTests Property Overloads
    • EstimatedError Property Overloads
    • EvaluationsNeeded Property
    • EvaluationsRemaining Property
    • HasSharedDegreeOfParallelism Property
    • IterationsNeeded Property
    • IterationsRemaining Property
    • MaxDegreeOfParallelism Property
    • MaxEvaluations Property
    • MaxIterations Property
    • MinIterations Property
    • ParallelOptions Property
    • Result Property
    • SolutionReport Property Overloads
    • Status Property
    • ThrowExceptionOnFailure Property
  • Status Property
ManagedIterativeAlgorithmTStatus Property Extreme Optimization Numerical Libraries for .NET Professional
Gets the AlgorithmStatus following an execution of the algorithm.

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 6.0.16073.0 (6.0.16312.0)
Syntax

C#
VB
C++
F#
Copy
public AlgorithmStatus Status { get; }
Public ReadOnly Property Status As AlgorithmStatus
	Get
public:
property AlgorithmStatus Status {
	AlgorithmStatus get ();
}
member Status : AlgorithmStatus with get

Property Value

Type: AlgorithmStatus
One of the AlgorithmStatus values.
Remarks

This property indicates the outcome of approximating the zero of the function. The root finding process can fail for a number of reasons. The possible values are as follows:

Result codeDescription
NoResultThe algorithm has not been executed.
NormalThe algorithm ended normally.
IterationLimitExceededThe maximum number of iterations was exceeded.
EvaluationLimitExceededThe maximum number of function evaluations was exceeded.
RoundOffErrorRound-off prevented the algorithm from achieving a result within the desired tolerance.
BadFunctionA badly behaved function prevented the algorithm from achieving a result within the desired tolerance.
DivergentThe algorithm diverges.

Even if the result is not Normal, an approximate value of the root is still available. However, it cannot be guaranteed that this value will even be close to the actual result.

When finding roots, it is recommended to set the ThrowExceptionOnFailure property to and inspect the value of this property after the algorithm has run.

Version Information

Numerical Libraries

Supported in: 5.x, 4.x
See Also

Reference

ManagedIterativeAlgorithmT Class
Extreme.Mathematics.Algorithms Namespace

Copyright (c) 2004-2016 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2018, 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.