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.EquationSolvers
    • BisectionSolver Class
    • DekkerBrentSolver Class
    • DoglegSystemSolver Class
    • EquationSolver Class
    • EquationSystemSolver Class
    • NewtonRaphsonSolver Class
    • NewtonRaphsonSystemSolver Class
    • RegulaFalsiSolver Class
    • RootBracketingSolver Class
    • Toms748Solver Class
  • EquationSolver Class
    • EquationSolver Constructors
    • Properties
    • Methods
    • Fields

EquationSolver Class

Extreme Optimization Numerical Libraries for .NET Professional
Serves as an abstract base class for root finders.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmDouble, Double, SolutionReportDouble, Double
    Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmDouble
      Extreme.Mathematics.AlgorithmsIterativeAlgorithm
        Extreme.Mathematics.EquationSolversEquationSolver
          Extreme.Mathematics.EquationSolversNewtonRaphsonSolver
          Extreme.Mathematics.EquationSolversRootBracketingSolver

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

C#
VB
C++
F#
Copy
public abstract class EquationSolver : IterativeAlgorithm
Public MustInherit Class EquationSolver
	Inherits IterativeAlgorithm
public ref class EquationSolver abstract : public IterativeAlgorithm
[<AbstractClassAttribute>]
type EquationSolver =  
    class
        inherit IterativeAlgorithm
    end

The EquationSolver type exposes the following members.

Constructors

  NameDescription
Protected methodEquationSolver
Constructs a new EquationSolver object.
Protected methodEquationSolver(FuncDouble, Double)
Constructs a new EquationSolver object for the specified target function.
Protected methodEquationSolver(FuncDouble, Double, ConvergenceCriterion, Double)
Constructs a new EquationSolver object for the specified target function and tolerance.
Protected methodEquationSolver(FuncDouble, Double, Double, Double)
Constructs a new EquationSolver object for the specified target function and convergence parameters.
Protected methodEquationSolver(FuncDouble, Double, Double, Double, ConvergenceCriterion, Double)
Constructs a new EquationSolver object for the specified target function and tolerance.
Top
Properties

  NameDescription
Public propertyAbsoluteTolerance
Gets or sets the absolute tolerance used in the convergence test.
(Inherited from IterativeAlgorithm.)
Public propertyConvergenceCriterion
Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.
(Inherited from IterativeAlgorithm.)
Public propertyConvergenceTest
Gets the convergence test for the algorithm.
(Inherited from IterativeAlgorithm.)
Public propertyConvergenceTests
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Protected propertyCurrentError
Gets the estimated error of the approximation of the result at the current iteration.
(Inherited from IterativeAlgorithm.)
Protected propertyCurrentLowerBound
Gets the lower bound of the convergence interval at the current iteration.
Protected propertyCurrentResult
Gets the approximation of the result at the current iteration.
(Inherited from IterativeAlgorithm.)
Protected propertyCurrentUpperBound
Gets the upper bound of the convergence interval at the current iteration.
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 propertyLowerBound
Gets or sets the lower bound for the solution.
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 propertyRelativeTolerance
Gets or sets the relative tolerance used in the convergence test.
(Inherited from IterativeAlgorithm.)
Public propertyResult
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyRightHandSide
Gets or sets the value of the target function to solve for.
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 propertyTargetFunction
Gets or sets the target function for the EquationSolver.
Public propertyThrowExceptionOnFailure
Gets or sets a value indicating whether to throw an exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyUpperBound
Gets or sets the upper bound for the solution.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodErrorEvaluator
Returns the estimated error for testing whether the algorithm has converged.
(Inherited from IterativeAlgorithm.)
Protected methodEvaluate
Evaluates the target function and increments the number of evaluations.
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 IterativeAlgorithm.)
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 tasks when the algorithm is first run.
(Inherited from IterativeAlgorithm.)
Protected methodReportFailure(AlgorithmStatus)
Reports that the algoritm has failed. No further iterations will be performed.
(Inherited from IterativeAlgorithm.)
Protected methodReportFailure(T, TError, AlgorithmStatus)
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
Reports that the algoritm has succeeded. No further iterations will be performed.
(Inherited from IterativeAlgorithm.)
Protected methodReportSuccess(T, TError)
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.)
Public methodSolve
Attempts to find a root or zero of the target function.
Public methodSolve(Double)
Attempts to find the point where the target function equals the specified value.
Protected methodTestConvergence
Checks whether the algorithm has converged.
(Inherited from IterativeAlgorithm.)
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.)
Protected methodUpdateCurrentResult
Updates the current approximation in a point-wise convergence.
(Inherited from IterativeAlgorithm.)
Protected methodValueEvaluator
Returns the value to compare the estimated error to when testing whether the algorithm has converged.
(Inherited from IterativeAlgorithm.)
Top
Fields

  NameDescription
Public fieldStatic memberDefaultMaxIterations
Specifies the default maximum number of iterations to use when approximating the roots of the target function.
Top
Remarks

The EquationSolver class is the abstract base class of all classes that implement equation solving algorithms. The class inherits from IterativeAlgorithm. All the properties and methods exposed by this interface are available to all derived classes.

This class cannot be instantiated directly. Instead, use one of the following derived classes: ClassDescriptionBisectionSolverRepresents a EquationSolver that uses the bisection algorithm.RegulaFalsiSolverRepresents a root finder that uses the regula falsi or false position algorithm.DekkerBrentSolverRepresents a root finder that uses Dekker and Brent's root bracketing algorithm.TOMS748SolverRepresents a root finder that uses Algorithm 748 from the ACM's Transactions On Mathematical Software (TOMS).NewtonRaphsonSolverRepresents a root finder based on the Newton-Raphson algorithm.

See Also

Reference

Extreme.Mathematics.EquationSolvers 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.