sv_swap_worker_create#

cuquantum.bindings.custatevec.sv_swap_worker_create(
intptr_t handle,
intptr_t communicator,
intptr_t org_sub_sv,
int32_t org_sub_sv_ind_ex,
intptr_t org_event,
int sv_data_type,
intptr_t stream,
) tuple[source]#

Create state vector swap worker.

Parameters:
  • handle (intptr_t) – the handle to cuStateVec library.

  • communicator (intptr_t) – a pointer to the MPI communicator.

  • org_sub_sv (intptr_t) – a pointer to a sub state vector.

  • org_sub_sv_ind_ex (int32_t) – the index of the sub state vector specified by the org_sub_sv argument.

  • org_event (intptr_t) – the event for synchronization with the peer worker.

  • sv_data_type (int) – data type used by the state vector representation.

  • stream (intptr_t) – a stream that is used to locally execute kernels during data transfers.

Returns:

  • intptr_t: state vector swap worker.

  • size_t: the size of the extra workspace needed.

  • size_t: the minimum-required size of the transfer workspace.

Return type:

A 3-tuple containing