ConvergenceWarning

Custom warning to capture convergence problems

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new ConvergenceWarning(opts?: object): ConvergenceWarning;

Parameters

Returns

ConvergenceWarning

Defined in: generated/exceptions/ConvergenceWarning.ts:21 (opens in a new tab)

Methods

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/exceptions/ConvergenceWarning.ts:83 (opens in a new tab)

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

Returns

Promise<void>

Defined in: generated/exceptions/ConvergenceWarning.ts:39 (opens in a new tab)

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Signature

with_traceback(opts: object): Promise<any>;

Parameters

Returns

Promise<any>

Defined in: generated/exceptions/ConvergenceWarning.ts:100 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/exceptions/ConvergenceWarning.ts:19 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/exceptions/ConvergenceWarning.ts:18 (opens in a new tab)

_py

PythonBridge

Defined in: generated/exceptions/ConvergenceWarning.ts:17 (opens in a new tab)

id

string

Defined in: generated/exceptions/ConvergenceWarning.ts:14 (opens in a new tab)

opts

any

Defined in: generated/exceptions/ConvergenceWarning.ts:15 (opens in a new tab)

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/exceptions/ConvergenceWarning.ts:26 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Returns

void

Defined in: generated/exceptions/ConvergenceWarning.ts:30 (opens in a new tab)