nlcpy.conjugate

nlcpy.conjugate = <ufunc 'nlcpy_conjugate'>

Returns the element-wise complex conjugate.

The complex conjugate of a complex number is obtained by changing the sign of its imaginary part.

Parameters

xarray_like

Input an array or a scalar.

outndarray or None, optional

A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.

wherearray_like, optional

This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default out=None, locations within it where the condition is False will remain uninitialized.

**kwargs

For other keyword-only arguments, see the section Optional Keyword Arguments.

Returns

yndarray

A ndarray, containing the complex conjugate for each element in x. If x is a scalar, this function returns the result as a 0-dimension ndarray.

Note

nlcpy.conj() is an alias for nlcpy.conjugate():

>>> import nlcpy as vp
>>> vp.conj is vp.conjugate
True

Examples

>>> import nlcpy as vp
>>> vp.conjugate(1+2j)
array(1.-2.j)
>>> x = vp.eye(2) + 1j * vp.eye(2)
>>> vp.conjugate(x)
array([[1.-1.j, 0.-0.j],
       [0.-0.j, 1.-1.j]])