test_matrix_type#

cuquantum.bindings.custatevec.test_matrix_type( intptr_t handle, int matrix_type, intptr_t matrix, int matrix_data_type, int layout, uint32_t n_targets, int32_t adjoint, int compute_type, intptr_t extra_workspace, size_t extra_workspace_size_in_bytes, ) → double[source]#

Test the deviation of a given matrix from a Hermitian (or Unitary) matrix.

Parameters:

handle (intptr_t) – the handle to cuStateVec library.
matrix_type (MatrixType) – matrix type.
matrix (intptr_t) – host or device pointer to a matrix.
matrix_data_type (int) – data type of matrix.
layout (MatrixLayout) – enumerator specifying the memory layout of matrix.
n_targets (uint32_t) – the number of target bits, up to 15.
adjoint (int32_t) – flag to control whether the adjoint of matrix is tested.
compute_type (ComputeType) – compute type.
extra_workspace (intptr_t) – extra workspace.
extra_workspace_size_in_bytes (size_t) – extra workspace size.

Returns:

host pointer, to store the deviation from certain matrix type.

Return type:

double