Appearance

@graphty/algorithms / index / ConvergenceError

Class: ConvergenceError ​

Defined in: errors.ts:107

Thrown when an iterative algorithm reaches its iteration cap before meeting its tolerance.

The scores it had reached are not returned: an unconverged vector is not the answer, and returning it in silence would pass it off as one. networkx makes the same choice with PowerIterationFailedConvergence. Raise maxIterations, or loosen tolerance, and call again.

Extends ​

  • Error

Constructors ​

Constructor ​

new ConvergenceError(algorithm, iterations, tolerance): ConvergenceError

Defined in: errors.ts:117

Builds the error and its message.

Parameters ​

algorithm ​

string

The function that gave up, e.g. "eigenvectorCentrality"

iterations ​

number

The passes it ran, which is its maxIterations

tolerance ​

number

The tolerance it did not meet

Returns ​

ConvergenceError

Overrides ​

Error.constructor

Properties ​

algorithm ​

readonly algorithm: string

Defined in: errors.ts:118

The function that gave up, e.g. "eigenvectorCentrality"

code ​

readonly code: AlgorithmErrorCode = "E_NOT_CONVERGED"

Defined in: errors.ts:109

iterations ​

readonly iterations: number

Defined in: errors.ts:119

The passes it ran, which is its maxIterations

name ​

readonly name: "ConvergenceError" = "ConvergenceError"

Defined in: errors.ts:108

Overrides ​

Error.name

tolerance ​

readonly tolerance: number

Defined in: errors.ts:120

The tolerance it did not meet