naginterfaces.library.blas.zsrotg

naginterfaces.library.blas.zsrotg(pivot, direct, alpha, x)[source]

zsrotg generates a sequence of complex plane rotations.

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

https://www.nag.com/numeric/nl/nagdoc_28.7/flhtml/f06/f06hqf.html

Parameters
pivotstr, length 1

Specifies the plane rotated by .

(variable pivot)

rotates the plane.

(fixed pivot)

rotates the plane if , or the plane if .

directstr, length 1

Specifies the sequence direction.

(forward sequence)

.

(backward sequence)

.

alphacomplex

The scalar .

xcomplex, array-like, shape

The -element vector .

Returns
alphacomplex

The scalar .

xcomplex, ndarray, shape

The referenced elements are overwritten by details of the plane rotations.

cfloat, ndarray, shape

The values , the cosines of the rotations.

scomplex, ndarray, shape

The values , the sines of the rotations.

Raises
NagValueError
(errno )

On entry, error in parameter .

Constraint: or .

(errno )

On entry, error in parameter .

Constraint: or .

(errno )

On entry, error in parameter .

Constraint: .

Notes

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

zsrotg generates the parameters of a complex unitary matrix , of order , chosen so as to set to zero the elements of a supplied -element complex vector .

If and , or if and ,

If and , or if and ,

Here and are complex scalars.

is represented as a sequence of plane rotations , as specified by and ; is chosen to annihilate , and its plane rotation part has the form

with real. The tangent of the rotation, , is overwritten on .