cuquantum.densitymat.tensor_product

cuquantum.densitymat.tensor_product(*operands: Tuple[Union[ElementaryOperator, numpy.ndarray, cupy.ndarray, Tuple[Union[numpy.ndarray, cupy.ndarray], Callback]], Sequence[int], Optional[Sequence[bool]]], coeff: Union[numbers.Number, numpy.ndarray, cupy.ndarray, Callback, Tuple[numbers.Number, Callback], Tuple[Union[numpy.ndarray, cupy.ndarray], Callback]] = 1, batch_size: int = 1, dtype: Optional[str] = None) → OperatorTerm

Return an OperatorTerm from a tensor product of elementary operators.

Parameters

• operands –

  Operands in the tensor product. Each operand is a tuple of length 2 or 3 of the form (tensor, modes, dual), where dual is optional. tensor contains the numerical data of the elementary operator and an optional callback function providing the tensor data. Accepted inputs for tensor are

  • Subclass of ElementaryOperator, i.e. DenseOperator and MultidiagonalOperator

  • NDArrayType, which will be converted to a DenseOperator

  • Tuple[NDArrayType, Callable], which will be passed to the initializer of DenseOperator

• coeff – Coefficient(s) associated with this OperatorTerm.

• dtype – Data type of this OperatorTerm. Default value is inferred from input operands unless this function returns a scalar OperatorTerm, in which case dtype is required.

• batch_size – Batch size of coefficient coeff, needs to be specified only if coeff is a Callback.

Returns

An OperatorTerm constructed from the tensor product of elementary operators.