operator_append_term_batch#

cuquantum.bindings.cudensitymat.operator_append_term_batch( intptr_t handle, intptr_t superoperator, intptr_t operator_term, int32_t duality, int64_t batch_size, intptr_t static_coefficients, intptr_t total_coefficients, coefficient_callback, coefficient_gradient_callback, )[source]#

Appends a batch of operator terms to the operator.

Parameters:

handle (intptr_t) – Library handle.
superoperator (intptr_t) – Operator.
operator_term (intptr_t) – Operator term.
duality (int32_t) – Duality status of the operator term action as a whole. If not zero, the duality status of each mode action inside the operator term will be flipped, that is, action from the left will be replaced by action from the right, and vice versa.
batch_size (int64_t) – Batch size (>= 1).
static_coefficients (intptr_t) – GPU-accessible array of constant (static) complex scalar coefficients associated with the appended batch of operator terms (of length batch_size).
total_coefficients (intptr_t) – GPU-accessible storage for the array of total complex scalar coefficients associated with the appended batch of operator terms (of length batch_size). Each coefficient will be a product of a static coefficient and a dynamic coefficient generated by the coefficient callback during the computation phase. If the scalar callback is not supplied here (NULL), this argument can also be set to NULL.
coefficient_callback (object) – Optional user-defined batched complex scalar callback function which can be called later to update the array of scalar coefficients associated with the defined batch of operator terms, or NULL. The total coefficient associated with an operator term is a product of the constant (static) coefficient and the result of the scalar callback function, if defined.
coefficient_gradient_callback (object) – Optional user-defined batched scalar gradient callback function which can be called later to compute the gradients of the batched complex scalar coefficients with respect to the batched user-defined real parameters, or NULL.