JacobiMethodF Class

JacobiMethodF Class

An iterative solver using the Jacobi method (single-precision).

Inheritance Hierarchy

SystemObject
DigitalRune.Mathematics.AlgebraIterativeLinearSystemSolverF
DigitalRune.Mathematics.AlgebraJacobiMethodF

Namespace: DigitalRune.Mathematics.Algebra
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

public class JacobiMethodF : IterativeLinearSystemSolverF

Public Class JacobiMethodF
	Inherits IterativeLinearSystemSolverF

public ref class JacobiMethodF : public IterativeLinearSystemSolverF

type JacobiMethodF =  
    class
        inherit IterativeLinearSystemSolverF
    end

The JacobiMethodF type exposes the following members.

Constructors

	Name	Description
	JacobiMethodF	Initializes a new instance of the JacobiMethodF class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Solve(MatrixF, VectorF)	Solves the specified linear system of equations A x = b*. (Inherited from IterativeLinearSystemSolverF.)
	Solve(MatrixF, VectorF, VectorF)	Solves the specified linear system of equations Ax=b. (Overrides IterativeLinearSystemSolverFSolve(MatrixF, VectorF, VectorF).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Epsilon	Gets or sets the tolerance value. (Inherited from IterativeLinearSystemSolverF.)
	MaxNumberOfIterations	Gets or sets the maximum number number of iterations. (Inherited from IterativeLinearSystemSolverF.)
	NumberOfIterations	Gets or sets the number of iterations of the last Solve(MatrixF, VectorF) method call. (Inherited from IterativeLinearSystemSolverF.)

Top

Remarks

The method will always converge if the matrix A is strictly or irreducibly diagonally dominant. Strict row diagonal dominance means that for each row, the absolute value of the diagonal term is greater than the sum of absolute values of other terms.

See http://en.wikipedia.org/wiki/Jacobi_method for an introduction to this method and for an explanation of the convergence criterion.

Reference

DigitalRune.Mathematics.Algebra Namespace