naginterfaces.library.blas.dzssq

naginterfaces.library.blas.dzssq(x, scal, sumsq)[source]

dzssq updates the Euclidean norm of complex vector in scaled form.

For full information please refer to the NAG Library document for f06kj

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/f06/f06kjf.html

Parameters
xcomplex, array-like, shape

The -element vector .

scalfloat

The scaling factor . On the first call to dzssq .

sumsqfloat

The scaled sum of squares . On the first call to dzssq .

Returns
scalfloat

The updated scaling factor .

sumsqfloat

The updated scaled sum of squares , satisfying: .

Raises
NagValueError
(errno )

On entry, error in parameter .

Constraint: .

(errno )

On entry, error in parameter .

Constraint: .

(errno )

On entry, error in parameter .

Constraint: .

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

Given an -element complex vector , and real scalars and , dzssq returns updated values and such that

dzssq is designed for use in the safe computation of the Euclidean norm of a complex vector, without unnecessary overflow or destructive underflow. An initial call to dzssq (with and ) may be followed by further calls to dzssq and finally a call to dnorm() to complete the computation. Multiple calls of dzssq may be needed if the elements of the vector cannot all be accessed in a single array .