complex_value

Graph.complex_value(x, y, *, name=None)

Creates element-wise complex values from real numbers, np.ndarrays, Tensors, Pwcs, or Stfs, that is, the real and imaginary parts.

Considering numbers and np.ndarrays as Tensors, if the two objects are of the same type, so is the returned object. If the objects have different types, Pwcs and Stfs can operate with a tensor (returning a Pwc or Stf, respectively).

This operation supports broadcasting between the different objects. When operating a tensor-like object with an Stf or a Pwc, the time dimension of the latter is ignored.

Parameters
  • x (number or np.ndarray or Tensor or Pwc or Stf) – The real part, \(x\).

  • y (number or np.ndarray or Tensor or Pwc or Stf) – The imaginary part, \(y\).

  • name (str, optional) – The name of the node. You can only provide a name if neither x nor y are Stfs.

Returns

The element-wise complex number \(x+iy\).

Return type

Tensor or Pwc or Stf

See also

abs()

Absolute value of a complex object.

angle()

Argument of a complex object.

conjugate()

Conjugate of a complex object.

imag()

Imaginary part of a complex object.

real()

Real part of a complex object.