Skip to main content
Ctrl+K
NVIDIA cuQuantum - Home NVIDIA cuQuantum - Home

NVIDIA cuQuantum

NVIDIA cuQuantum - Home NVIDIA cuQuantum - Home

NVIDIA cuQuantum

Table of Contents

Contents

  • Overview
  • Release Notes
  • Getting Started
  • cuDensityMat
    • Release Notes
    • Overview
    • Examples
    • API Reference
      • cuDensityMat data types
      • cuDensityMat functions
    • Acknowledgements
  • cuPauliProp
    • Release Notes
    • Overview
    • Examples
    • API Reference
      • cuPauliProp data types
      • cuPauliProp functions
  • cuStabilizer
    • Release Notes
    • Overview
    • Examples
    • API Reference
      • cuStabilizer data types
      • cuStabilizer functions
  • cuStateVec
    • Release Notes
    • Overview
      • State Vector Algorithms
      • Distributed Index Bit Swap API
      • Host State Vector Migration API
      • The cuStateVec Ex API Technical Brief
      • cuStateVec Ex: State Vector Operations
      • cuStateVec Ex: State Vector Updater
      • cuStateVec Ex: State Vector Distribution
      • cuStateVec Ex: State Vector
      • cuStateVec Ex: Communicator
    • Examples
    • API Reference
      • cuStateVec API Reference
      • cuStateVec Ex API Reference
  • cuTensorNet
    • Release Notes
    • Overview
    • Examples
    • API Reference
      • cuTensorNet data types
      • cuTensorNet functions
    • Acknowledgements
  • cuQuantum Python
    • Release Notes
    • Overview
    • Utility APIs
      • cuquantum.BaseCUDAMemoryManager
      • cuquantum.MemoryPointer
      • cuquantum.MemoryLimitExceeded
      • cuquantum.ComputeType
      • cuquantum.cudaDataType
      • cuquantum.libraryPropertyType
    • Low-level Python Bindings
      • cuDensityMat (cuquantum.bindings.cudensitymat)
        • cuquantum.bindings.cudensitymat.ArrayType
        • cuquantum.bindings.cudensitymat.ScalarCallbackType
        • cuquantum.bindings.cudensitymat.TensorCallbackType
        • cuquantum.bindings.cudensitymat.ScalarGradientCallbackType
        • cuquantum.bindings.cudensitymat.TensorGradientCallbackType
        • cuquantum.bindings.cudensitymat.WrappedScalarCallback
        • cuquantum.bindings.cudensitymat.WrappedTensorCallback
        • cuquantum.bindings.cudensitymat.WrappedScalarGradientCallback
        • cuquantum.bindings.cudensitymat.WrappedTensorGradientCallback
        • cuquantum.bindings.cudensitymat.Status
        • cuquantum.bindings.cudensitymat.DistributedProvider
        • cuquantum.bindings.cudensitymat.CallbackDevice
        • cuquantum.bindings.cudensitymat.DifferentiationDir
        • cuquantum.bindings.cudensitymat.StatePurity
        • cuquantum.bindings.cudensitymat.ElementaryOperatorSparsity
        • cuquantum.bindings.cudensitymat.Memspace
        • cuquantum.bindings.cudensitymat.WorkspaceKind
        • cuquantum.bindings.cudensitymat.OperatorSpectrumKind
        • cuquantum.bindings.cudensitymat.OperatorSpectrumConfig
        • cuquantum.bindings.cudensitymat.create
        • cuquantum.bindings.cudensitymat.destroy
        • cuquantum.bindings.cudensitymat.reset_distributed_configuration
        • cuquantum.bindings.cudensitymat.get_num_ranks
        • cuquantum.bindings.cudensitymat.get_proc_rank
        • cuquantum.bindings.cudensitymat.reset_random_seed
        • cuquantum.bindings.cudensitymat.create_workspace
        • cuquantum.bindings.cudensitymat.destroy_workspace
        • cuquantum.bindings.cudensitymat.workspace_get_memory_size
        • cuquantum.bindings.cudensitymat.workspace_set_memory
        • cuquantum.bindings.cudensitymat.workspace_get_memory
        • cuquantum.bindings.cudensitymat.create_elementary_operator
        • cuquantum.bindings.cudensitymat.create_elementary_operator_batch
        • cuquantum.bindings.cudensitymat.destroy_elementary_operator
        • cuquantum.bindings.cudensitymat.create_matrix_operator_dense_local
        • cuquantum.bindings.cudensitymat.create_matrix_operator_dense_local_batch
        • cuquantum.bindings.cudensitymat.destroy_matrix_operator
        • cuquantum.bindings.cudensitymat.create_operator_term
        • cuquantum.bindings.cudensitymat.destroy_operator_term
        • cuquantum.bindings.cudensitymat.operator_term_append_elementary_product
        • cuquantum.bindings.cudensitymat.operator_term_append_elementary_product_batch
        • cuquantum.bindings.cudensitymat.operator_term_append_matrix_product
        • cuquantum.bindings.cudensitymat.operator_term_append_matrix_product_batch
        • cuquantum.bindings.cudensitymat.create_operator
        • cuquantum.bindings.cudensitymat.destroy_operator
        • cuquantum.bindings.cudensitymat.operator_append_term
        • cuquantum.bindings.cudensitymat.operator_append_term_batch
        • cuquantum.bindings.cudensitymat.operator_prepare_action
        • cuquantum.bindings.cudensitymat.operator_compute_action
        • cuquantum.bindings.cudensitymat.operator_prepare_action_backward_diff
        • cuquantum.bindings.cudensitymat.operator_compute_action_backward_diff
        • cuquantum.bindings.cudensitymat.create_operator_action
        • cuquantum.bindings.cudensitymat.destroy_operator_action
        • cuquantum.bindings.cudensitymat.operator_action_prepare
        • cuquantum.bindings.cudensitymat.operator_action_compute
        • cuquantum.bindings.cudensitymat.create_state
        • cuquantum.bindings.cudensitymat.destroy_state
        • cuquantum.bindings.cudensitymat.state_get_num_components
        • cuquantum.bindings.cudensitymat.state_get_component_storage_size
        • cuquantum.bindings.cudensitymat.state_attach_component_storage
        • cuquantum.bindings.cudensitymat.state_get_component_num_modes
        • cuquantum.bindings.cudensitymat.state_get_component_info
        • cuquantum.bindings.cudensitymat.state_initialize_zero
        • cuquantum.bindings.cudensitymat.state_compute_scaling
        • cuquantum.bindings.cudensitymat.state_compute_norm
        • cuquantum.bindings.cudensitymat.state_compute_trace
        • cuquantum.bindings.cudensitymat.state_compute_accumulation
        • cuquantum.bindings.cudensitymat.state_compute_inner_product
        • cuquantum.bindings.cudensitymat.create_expectation
        • cuquantum.bindings.cudensitymat.destroy_expectation
        • cuquantum.bindings.cudensitymat.expectation_prepare
        • cuquantum.bindings.cudensitymat.expectation_compute
        • cuquantum.bindings.cudensitymat.create_operator_spectrum
        • cuquantum.bindings.cudensitymat.destroy_operator_spectrum
        • cuquantum.bindings.cudensitymat.operator_spectrum_configure
        • cuquantum.bindings.cudensitymat.operator_spectrum_prepare
        • cuquantum.bindings.cudensitymat.operator_spectrum_compute
        • cuquantum.bindings.cudensitymat.get_version
      • cuPauliProp (cuquantum.bindings.cupauliprop)
        • cuquantum.bindings.cupauliprop.PauliTerm
        • cuquantum.bindings.cupauliprop.CoefficientTruncationParams
        • cuquantum.bindings.cupauliprop.PauliWeightTruncationParams
        • cuquantum.bindings.cupauliprop.pauli_term_dtype
        • cuquantum.bindings.cupauliprop.coefficient_truncation_params_dtype
        • cuquantum.bindings.cupauliprop.pauli_weight_truncation_params_dtype
        • cuquantum.bindings.cupauliprop.Status
        • cuquantum.bindings.cupauliprop.ComputeType
        • cuquantum.bindings.cupauliprop.Memspace
        • cuquantum.bindings.cupauliprop.WorkspaceKind
        • cuquantum.bindings.cupauliprop.TruncationStrategy
        • cuquantum.bindings.cupauliprop.PauliKind
        • cuquantum.bindings.cupauliprop.CliffordGateKind
        • cuquantum.bindings.cupauliprop.QuantumOperatorKind
        • cuquantum.bindings.cupauliprop.get_version
        • cuquantum.bindings.cupauliprop.get_error_string
        • cuquantum.bindings.cupauliprop.create
        • cuquantum.bindings.cupauliprop.destroy
        • cuquantum.bindings.cupauliprop.set_stream
        • cuquantum.bindings.cupauliprop.create_workspace_descriptor
        • cuquantum.bindings.cupauliprop.destroy_workspace_descriptor
        • cuquantum.bindings.cupauliprop.workspace_get_memory_size
        • cuquantum.bindings.cupauliprop.workspace_set_memory
        • cuquantum.bindings.cupauliprop.workspace_get_memory
        • cuquantum.bindings.cupauliprop.get_num_packed_integers
        • cuquantum.bindings.cupauliprop.create_pauli_expansion
        • cuquantum.bindings.cupauliprop.destroy_pauli_expansion
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_storage_buffer
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_num_qubits
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_num_terms
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_data_type
        • cuquantum.bindings.cupauliprop.pauli_expansion_is_sorted
        • cuquantum.bindings.cupauliprop.pauli_expansion_is_deduplicated
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_contiguous_range
        • cuquantum.bindings.cupauliprop.pauli_expansion_get_term
        • cuquantum.bindings.cupauliprop.destroy_pauli_expansion_view
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_get_num_terms
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_get_location
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_get_term
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_canonical_sort
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_execute_canonical_sort
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_deduplication
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_execute_deduplication
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_truncation
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_execute_truncation
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_trace_with_expansion_view
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_compute_trace_with_expansion_view
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_trace_with_zero_state
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_compute_trace_with_zero_state
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_prepare_operator_application
        • cuquantum.bindings.cupauliprop.pauli_expansion_view_compute_operator_application
        • cuquantum.bindings.cupauliprop.pauli_expansion_populate_from_view
        • cuquantum.bindings.cupauliprop.create_clifford_gate_operator
        • cuquantum.bindings.cupauliprop.create_pauli_rotation_gate_operator
        • cuquantum.bindings.cupauliprop.create_pauli_noise_channel_operator
        • cuquantum.bindings.cupauliprop.quantum_operator_get_kind
        • cuquantum.bindings.cupauliprop.destroy_operator
      • cuStabilizer (cuquantum.bindings.custabilizer)
        • cuquantum.bindings.custabilizer.cuStabilizerError
        • cuquantum.bindings.custabilizer.Status
        • cuquantum.bindings.custabilizer.get_version
        • cuquantum.bindings.custabilizer.get_error_string
        • cuquantum.bindings.custabilizer.create
        • cuquantum.bindings.custabilizer.destroy
        • cuquantum.bindings.custabilizer.circuit_size_from_string
        • cuquantum.bindings.custabilizer.create_circuit_from_string
        • cuquantum.bindings.custabilizer.destroy_circuit
        • cuquantum.bindings.custabilizer.create_frame_simulator
        • cuquantum.bindings.custabilizer.destroy_frame_simulator
        • cuquantum.bindings.custabilizer.frame_simulator_apply_circuit
      • cuStateVec (cuquantum.bindings.custatevec)
        • cuquantum.bindings.custatevec.SVSwapParameters
        • cuquantum.bindings.custatevec.sv_swap_parameters_dtype
        • cuquantum.bindings.custatevec.Pauli
        • cuquantum.bindings.custatevec.MatrixLayout
        • cuquantum.bindings.custatevec.MatrixType
        • cuquantum.bindings.custatevec.MatrixMapType
        • cuquantum.bindings.custatevec.CollapseOp
        • cuquantum.bindings.custatevec.SamplerOutput
        • cuquantum.bindings.custatevec.DeviceNetworkType
        • cuquantum.bindings.custatevec.StateVectorType
        • cuquantum.bindings.custatevec.MathMode
        • cuquantum.bindings.custatevec.CommunicatorType
        • cuquantum.bindings.custatevec.DataTransferType
        • cuquantum.bindings.custatevec.create
        • cuquantum.bindings.custatevec.destroy
        • cuquantum.bindings.custatevec.get_default_workspace_size
        • cuquantum.bindings.custatevec.set_workspace
        • cuquantum.bindings.custatevec.set_stream
        • cuquantum.bindings.custatevec.get_stream
        • cuquantum.bindings.custatevec.logger_set_callback_data
        • cuquantum.bindings.custatevec.logger_open_file
        • cuquantum.bindings.custatevec.logger_set_level
        • cuquantum.bindings.custatevec.logger_set_mask
        • cuquantum.bindings.custatevec.logger_force_disable
        • cuquantum.bindings.custatevec.set_device_mem_handler
        • cuquantum.bindings.custatevec.get_device_mem_handler
        • cuquantum.bindings.custatevec.get_property
        • cuquantum.bindings.custatevec.get_version
        • cuquantum.bindings.custatevec.set_math_mode
        • cuquantum.bindings.custatevec.get_math_mode
        • cuquantum.bindings.custatevec.initialize_state_vector
        • cuquantum.bindings.custatevec.apply_matrix_get_workspace_size
        • cuquantum.bindings.custatevec.apply_matrix
        • cuquantum.bindings.custatevec.apply_matrix_batched_get_workspace_size
        • cuquantum.bindings.custatevec.apply_matrix_batched
        • cuquantum.bindings.custatevec.apply_pauli_rotation
        • cuquantum.bindings.custatevec.apply_generalized_permutation_matrix_get_workspace_size
        • cuquantum.bindings.custatevec.apply_generalized_permutation_matrix
        • cuquantum.bindings.custatevec.abs2sum_on_z_basis
        • cuquantum.bindings.custatevec.collapse_on_z_basis
        • cuquantum.bindings.custatevec.measure_on_z_basis
        • cuquantum.bindings.custatevec.abs2sum_array
        • cuquantum.bindings.custatevec.collapse_by_bit_string
        • cuquantum.bindings.custatevec.batch_measure
        • cuquantum.bindings.custatevec.abs2sum_array_batched
        • cuquantum.bindings.custatevec.collapse_by_bit_string_batched_get_workspace_size
        • cuquantum.bindings.custatevec.collapse_by_bit_string_batched
        • cuquantum.bindings.custatevec.measure_batched
        • cuquantum.bindings.custatevec.batch_measure_with_offset
        • cuquantum.bindings.custatevec.compute_expectation_get_workspace_size
        • cuquantum.bindings.custatevec.compute_expectation
        • cuquantum.bindings.custatevec.compute_expectation_batched_get_workspace_size
        • cuquantum.bindings.custatevec.compute_expectation_batched
        • cuquantum.bindings.custatevec.compute_expectations_on_pauli_basis
        • cuquantum.bindings.custatevec.sampler_create
        • cuquantum.bindings.custatevec.sampler_destroy
        • cuquantum.bindings.custatevec.sampler_preprocess
        • cuquantum.bindings.custatevec.sampler_sample
        • cuquantum.bindings.custatevec.sampler_get_squared_norm
        • cuquantum.bindings.custatevec.sampler_apply_sub_sv_offset
        • cuquantum.bindings.custatevec.accessor_create
        • cuquantum.bindings.custatevec.accessor_create_view
        • cuquantum.bindings.custatevec.accessor_destroy
        • cuquantum.bindings.custatevec.accessor_set_extra_workspace
        • cuquantum.bindings.custatevec.accessor_get
        • cuquantum.bindings.custatevec.accessor_set
        • cuquantum.bindings.custatevec.swap_index_bits
        • cuquantum.bindings.custatevec.multi_device_swap_index_bits
        • cuquantum.bindings.custatevec.communicator_create
        • cuquantum.bindings.custatevec.communicator_destroy
        • cuquantum.bindings.custatevec.dist_index_bit_swap_scheduler_create
        • cuquantum.bindings.custatevec.dist_index_bit_swap_scheduler_destroy
        • cuquantum.bindings.custatevec.dist_index_bit_swap_scheduler_set_index_bit_swaps
        • cuquantum.bindings.custatevec.dist_index_bit_swap_scheduler_get_parameters
        • cuquantum.bindings.custatevec.sv_swap_worker_create
        • cuquantum.bindings.custatevec.sv_swap_worker_destroy
        • cuquantum.bindings.custatevec.sv_swap_worker_set_extra_workspace
        • cuquantum.bindings.custatevec.sv_swap_worker_set_transfer_workspace
        • cuquantum.bindings.custatevec.sv_swap_worker_set_sub_svs_p2p
        • cuquantum.bindings.custatevec.sv_swap_worker_set_parameters
        • cuquantum.bindings.custatevec.sv_swap_worker_execute
        • cuquantum.bindings.custatevec.sub_sv_migrator_create
        • cuquantum.bindings.custatevec.sub_sv_migrator_destroy
        • cuquantum.bindings.custatevec.sub_sv_migrator_migrate
        • cuquantum.bindings.custatevec.test_matrix_type_get_workspace_size
        • cuquantum.bindings.custatevec.test_matrix_type
      • cuTensorNet (cuquantum.bindings.cutensornet)
        • cuquantum.bindings.cutensornet.MPSEnvBounds
        • cuquantum.bindings.cutensornet.tensor_qualifiers_dtype
        • cuquantum.bindings.cutensornet.contraction_path_dtype
        • cuquantum.bindings.cutensornet.slice_info_pair_dtype
        • cuquantum.bindings.cutensornet.slicing_config_dtype
        • cuquantum.bindings.cutensornet.mps_env_bounds_dtype
        • cuquantum.bindings.cutensornet.Status
        • cuquantum.bindings.cutensornet.NetworkAttribute
        • cuquantum.bindings.cutensornet.ContractionAutotunePreferenceAttribute
        • cuquantum.bindings.cutensornet.ContractionOptimizerConfigAttribute
        • cuquantum.bindings.cutensornet.ContractionOptimizerInfoAttribute
        • cuquantum.bindings.cutensornet.GraphAlgo
        • cuquantum.bindings.cutensornet.MemoryModel
        • cuquantum.bindings.cutensornet.OptimizerCost
        • cuquantum.bindings.cutensornet.SmartOption
        • cuquantum.bindings.cutensornet.WorksizePref
        • cuquantum.bindings.cutensornet.Memspace
        • cuquantum.bindings.cutensornet.WorkspaceKind
        • cuquantum.bindings.cutensornet.TensorSVDConfigAttribute
        • cuquantum.bindings.cutensornet.TensorSVDInfoAttribute
        • cuquantum.bindings.cutensornet.TensorSVDNormalization
        • cuquantum.bindings.cutensornet.TensorSVDPartition
        • cuquantum.bindings.cutensornet.TensorSVDAlgo
        • cuquantum.bindings.cutensornet.GateSplitAlgo
        • cuquantum.bindings.cutensornet.StatePurity
        • cuquantum.bindings.cutensornet.BoundaryCondition
        • cuquantum.bindings.cutensornet.StateAttribute
        • cuquantum.bindings.cutensornet.StateMPOApplication
        • cuquantum.bindings.cutensornet.StateMPSGaugeOption
        • cuquantum.bindings.cutensornet.MarginalAttribute
        • cuquantum.bindings.cutensornet.SamplerAttribute
        • cuquantum.bindings.cutensornet.AccessorAttribute
        • cuquantum.bindings.cutensornet.ExpectationAttribute
        • cuquantum.bindings.cutensornet.StateProjectionMPSOrthoOption
        • cuquantum.bindings.cutensornet.StateProjectionMPSAttribute
        • cuquantum.bindings.cutensornet.create
        • cuquantum.bindings.cutensornet.destroy
        • cuquantum.bindings.cutensornet.create_network_descriptor
        • cuquantum.bindings.cutensornet.destroy_network_descriptor
        • cuquantum.bindings.cutensornet.get_output_tensor_descriptor
        • cuquantum.bindings.cutensornet.network_get_attribute
        • cuquantum.bindings.cutensornet.network_set_attribute
        • cuquantum.bindings.cutensornet.get_network_attribute_dtype
        • cuquantum.bindings.cutensornet.create_network
        • cuquantum.bindings.cutensornet.destroy_network
        • cuquantum.bindings.cutensornet.network_append_tensor
        • cuquantum.bindings.cutensornet.network_set_output_tensor
        • cuquantum.bindings.cutensornet.network_set_optimizer_info
        • cuquantum.bindings.cutensornet.network_prepare_contraction
        • cuquantum.bindings.cutensornet.network_autotune_contraction
        • cuquantum.bindings.cutensornet.create_network_autotune_preference
        • cuquantum.bindings.cutensornet.network_autotune_preference_get_attribute
        • cuquantum.bindings.cutensornet.network_autotune_preference_set_attribute
        • cuquantum.bindings.cutensornet.destroy_network_autotune_preference
        • cuquantum.bindings.cutensornet.network_set_input_tensor_memory
        • cuquantum.bindings.cutensornet.network_set_output_tensor_memory
        • cuquantum.bindings.cutensornet.network_set_gradient_tensor_memory
        • cuquantum.bindings.cutensornet.network_set_adjoint_tensor_memory
        • cuquantum.bindings.cutensornet.network_contract
        • cuquantum.bindings.cutensornet.network_prepare_gradients_backward
        • cuquantum.bindings.cutensornet.network_compute_gradients_backward
        • cuquantum.bindings.cutensornet.create_tensor_descriptor
        • cuquantum.bindings.cutensornet.destroy_tensor_descriptor
        • cuquantum.bindings.cutensornet.get_tensor_details
        • cuquantum.bindings.cutensornet.create_contraction_optimizer_info
        • cuquantum.bindings.cutensornet.create_contraction_optimizer_info_from_packed_data
        • cuquantum.bindings.cutensornet.update_contraction_optimizer_info_from_packed_data
        • cuquantum.bindings.cutensornet.destroy_contraction_optimizer_info
        • cuquantum.bindings.cutensornet.get_contraction_optimizer_info_attribute_dtype
        • cuquantum.bindings.cutensornet.contraction_optimizer_info_get_attribute
        • cuquantum.bindings.cutensornet.contraction_optimizer_info_set_attribute
        • cuquantum.bindings.cutensornet.contraction_optimizer_info_get_packed_size
        • cuquantum.bindings.cutensornet.contraction_optimizer_info_pack_data
        • cuquantum.bindings.cutensornet.create_contraction_optimizer_config
        • cuquantum.bindings.cutensornet.destroy_contraction_optimizer_config
        • cuquantum.bindings.cutensornet.get_contraction_optimizer_config_attribute_dtype
        • cuquantum.bindings.cutensornet.contraction_optimizer_config_get_attribute
        • cuquantum.bindings.cutensornet.contraction_optimizer_config_set_attribute
        • cuquantum.bindings.cutensornet.contraction_optimize
        • cuquantum.bindings.cutensornet.create_contraction_plan
        • cuquantum.bindings.cutensornet.destroy_contraction_plan
        • cuquantum.bindings.cutensornet.create_contraction_autotune_preference
        • cuquantum.bindings.cutensornet.destroy_contraction_autotune_preference
        • cuquantum.bindings.cutensornet.get_contraction_autotune_preference_attribute_dtype
        • cuquantum.bindings.cutensornet.contraction_autotune_preference_get_attribute
        • cuquantum.bindings.cutensornet.contraction_autotune_preference_set_attribute
        • cuquantum.bindings.cutensornet.contraction_autotune
        • cuquantum.bindings.cutensornet.create_workspace_descriptor
        • cuquantum.bindings.cutensornet.destroy_workspace_descriptor
        • cuquantum.bindings.cutensornet.workspace_compute_contraction_sizes
        • cuquantum.bindings.cutensornet.workspace_compute_qr_sizes
        • cuquantum.bindings.cutensornet.workspace_compute_svd_sizes
        • cuquantum.bindings.cutensornet.workspace_compute_gate_split_sizes
        • cuquantum.bindings.cutensornet.workspace_get_memory_size
        • cuquantum.bindings.cutensornet.workspace_set_memory
        • cuquantum.bindings.cutensornet.workspace_get_memory
        • cuquantum.bindings.cutensornet.workspace_purge_cache
        • cuquantum.bindings.cutensornet.set_device_mem_handler
        • cuquantum.bindings.cutensornet.get_device_mem_handler
        • cuquantum.bindings.cutensornet.contract_slices
        • cuquantum.bindings.cutensornet.create_slice_group_from_id_range
        • cuquantum.bindings.cutensornet.create_slice_group_from_ids
        • cuquantum.bindings.cutensornet.destroy_slice_group
        • cuquantum.bindings.cutensornet.tensor_qr
        • cuquantum.bindings.cutensornet.tensor_svd
        • cuquantum.bindings.cutensornet.gate_split
        • cuquantum.bindings.cutensornet.create_tensor_svd_config
        • cuquantum.bindings.cutensornet.destroy_tensor_svd_config
        • cuquantum.bindings.cutensornet.get_tensor_svd_config_attribute_dtype
        • cuquantum.bindings.cutensornet.tensor_svd_config_get_attribute
        • cuquantum.bindings.cutensornet.tensor_svd_config_set_attribute
        • cuquantum.bindings.cutensornet.tensor_svd_algo_params_get_dtype
        • cuquantum.bindings.cutensornet.create_tensor_svd_info
        • cuquantum.bindings.cutensornet.destroy_tensor_svd_info
        • cuquantum.bindings.cutensornet.get_tensor_svd_info_attribute_dtype
        • cuquantum.bindings.cutensornet.tensor_svd_info_get_attribute
        • cuquantum.bindings.cutensornet.tensor_svd_algo_status_get_dtype
        • cuquantum.bindings.cutensornet.distributed_reset_configuration
        • cuquantum.bindings.cutensornet.distributed_get_num_ranks
        • cuquantum.bindings.cutensornet.distributed_get_proc_rank
        • cuquantum.bindings.cutensornet.distributed_synchronize
        • cuquantum.bindings.cutensornet.create_state
        • cuquantum.bindings.cutensornet.destroy_state
        • cuquantum.bindings.cutensornet.state_apply_tensor
        • cuquantum.bindings.cutensornet.state_apply_tensor_operator
        • cuquantum.bindings.cutensornet.state_apply_controlled_tensor_operator
        • cuquantum.bindings.cutensornet.state_apply_unitary_channel
        • cuquantum.bindings.cutensornet.state_apply_general_channel
        • cuquantum.bindings.cutensornet.state_apply_network_operator
        • cuquantum.bindings.cutensornet.state_update_tensor
        • cuquantum.bindings.cutensornet.state_update_tensor_operator
        • cuquantum.bindings.cutensornet.get_state_attribute_dtype
        • cuquantum.bindings.cutensornet.state_configure
        • cuquantum.bindings.cutensornet.state_prepare
        • cuquantum.bindings.cutensornet.state_get_info
        • cuquantum.bindings.cutensornet.state_compute
        • cuquantum.bindings.cutensornet.state_initialize_mps
        • cuquantum.bindings.cutensornet.state_finalize_mps
        • cuquantum.bindings.cutensornet.state_capture_mps
        • cuquantum.bindings.cutensornet.get_output_state_details
        • cuquantum.bindings.cutensornet.create_marginal
        • cuquantum.bindings.cutensornet.destroy_marginal
        • cuquantum.bindings.cutensornet.get_marginal_attribute_dtype
        • cuquantum.bindings.cutensornet.marginal_configure
        • cuquantum.bindings.cutensornet.marginal_prepare
        • cuquantum.bindings.cutensornet.marginal_get_info
        • cuquantum.bindings.cutensornet.marginal_compute
        • cuquantum.bindings.cutensornet.create_sampler
        • cuquantum.bindings.cutensornet.destroy_sampler
        • cuquantum.bindings.cutensornet.get_sampler_attribute_dtype
        • cuquantum.bindings.cutensornet.sampler_configure
        • cuquantum.bindings.cutensornet.sampler_prepare
        • cuquantum.bindings.cutensornet.sampler_get_info
        • cuquantum.bindings.cutensornet.sampler_sample
        • cuquantum.bindings.cutensornet.create_accessor
        • cuquantum.bindings.cutensornet.destroy_accessor
        • cuquantum.bindings.cutensornet.get_accessor_attribute_dtype
        • cuquantum.bindings.cutensornet.accessor_configure
        • cuquantum.bindings.cutensornet.accessor_prepare
        • cuquantum.bindings.cutensornet.accessor_get_info
        • cuquantum.bindings.cutensornet.accessor_compute
        • cuquantum.bindings.cutensornet.create_expectation
        • cuquantum.bindings.cutensornet.destroy_expectation
        • cuquantum.bindings.cutensornet.get_expectation_attribute_dtype
        • cuquantum.bindings.cutensornet.expectation_configure
        • cuquantum.bindings.cutensornet.expectation_prepare
        • cuquantum.bindings.cutensornet.expectation_get_info
        • cuquantum.bindings.cutensornet.expectation_compute
        • cuquantum.bindings.cutensornet.create_state_projection_mps
        • cuquantum.bindings.cutensornet.get_state_projection_mps_attribute_dtype
        • cuquantum.bindings.cutensornet.state_projection_mps_configure
        • cuquantum.bindings.cutensornet.state_projection_mps_prepare
        • cuquantum.bindings.cutensornet.state_projection_mps_compute_tensor_env
        • cuquantum.bindings.cutensornet.state_projection_mps_get_tensor_info
        • cuquantum.bindings.cutensornet.state_projection_mps_extract_tensor
        • cuquantum.bindings.cutensornet.state_projection_mps_insert_tensor
        • cuquantum.bindings.cutensornet.destroy_state_projection_mps
        • cuquantum.bindings.cutensornet.create_network_operator
        • cuquantum.bindings.cutensornet.network_operator_append_product
        • cuquantum.bindings.cutensornet.network_operator_append_mpo
        • cuquantum.bindings.cutensornet.destroy_network_operator
        • cuquantum.bindings.cutensornet.get_error_string
        • cuquantum.bindings.cutensornet.logger_set_callback_data
        • cuquantum.bindings.cutensornet.logger_open_file
        • cuquantum.bindings.cutensornet.logger_set_level
        • cuquantum.bindings.cutensornet.logger_set_mask
        • cuquantum.bindings.cutensornet.logger_force_disable
        • cuquantum.bindings.cutensornet.logger_set_file
        • cuquantum.bindings.cutensornet.get_version
        • cuquantum.bindings.cutensornet.get_cudart_version
    • Stabilizer APIs
      • cuquantum.stabilizer.Circuit
      • cuquantum.stabilizer.FrameSimulator
      • cuquantum.stabilizer.PauliTable
      • cuquantum.stabilizer.PauliFrame
      • cuquantum.stabilizer.Options
    • Quantum Dynamics APIs
      • cuquantum.densitymat.WorkStream
      • cuquantum.densitymat.CPUCallback
      • cuquantum.densitymat.GPUCallback
      • cuquantum.densitymat.tensor_product
      • cuquantum.densitymat.full_matrix_product
      • cuquantum.densitymat.DenseOperator
      • cuquantum.densitymat.MultidiagonalOperator
      • cuquantum.densitymat.LocalDenseMatrixOperator
      • cuquantum.densitymat.OperatorTerm
      • cuquantum.densitymat.Operator
      • cuquantum.densitymat.OperatorAction
      • cuquantum.densitymat.OperatorSpectrumSolver
      • cuquantum.densitymat.OperatorSpectrumConfig
      • cuquantum.densitymat.OperatorSpectrumResult
      • cuquantum.densitymat.DensePureState
      • cuquantum.densitymat.DenseMixedState
    • Tensor Network APIs
      • cuquantum.tensornet.Network
      • cuquantum.tensornet.CircuitToEinsum
      • cuquantum.tensornet.NetworkOptions
      • cuquantum.tensornet.OptimizerInfo
      • cuquantum.tensornet.OptimizerOptions
      • cuquantum.tensornet.PathFinderOptions
      • cuquantum.tensornet.ReconfigOptions
      • cuquantum.tensornet.SlicerOptions
      • cuquantum.tensornet.QiskitParserOptions
      • cuquantum.tensornet.CirqParserOptions
      • cuquantum.tensornet.contract
      • cuquantum.tensornet.contract_path
      • cuquantum.tensornet.einsum
      • cuquantum.tensornet.einsum_path
      • cuquantum.tensornet.get_mpi_comm_pointer
      • cuquantum.tensornet.tensor.decompose
      • cuquantum.tensornet.tensor.DecompositionOptions
      • cuquantum.tensornet.tensor.QRMethod
      • cuquantum.tensornet.tensor.SVDInfo
      • cuquantum.tensornet.tensor.SVDMethod
      • cuquantum.tensornet.experimental.contract_decompose
      • cuquantum.tensornet.experimental.NetworkState
      • cuquantum.tensornet.experimental.NetworkOperator
      • cuquantum.tensornet.experimental.ContractDecomposeAlgorithm
      • cuquantum.tensornet.experimental.ContractDecomposeInfo
      • cuquantum.tensornet.experimental.MPSConfig
      • cuquantum.tensornet.experimental.TNConfig
    • JAX Extension APIs
      • cuquantum.densitymat.jax.operator_action
      • cuquantum.densitymat.jax.ElementaryOperator
      • cuquantum.densitymat.jax.MatrixOperator
      • cuquantum.densitymat.jax.OperatorTerm
      • cuquantum.densitymat.jax.Operator
    • Code of Conduct
    • Contributing
  • cuQuantum Appliance
    • Overview
    • Release Notes
    • Cirq
    • Qiskit
    • cusvaer
    • Acknowledgements
  • Software License Agreement
  • cuStateVec: A High-Performance Library for State Vector Quantum Simulators
  • API Reference

API Reference#

This reference describes all components of the cuStateVec and cuStateVec Ex APIs.

  • cuStateVec API Reference
    • cuStateVec data types
    • cuStateVec functions
  • cuStateVec Ex API Reference
    • cuStateVec Ex data types
    • cuStateVec Ex functions

previous

Examples

next

cuStateVec API Reference
NVIDIA NVIDIA
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2021-2025, NVIDIA Corporation & affiliates.