gkdZddlZddlZddlmZddlmZddlmZddl m Z ddl m Z d d l mZd d lmZd d lmZd d lmZmZmZmZmZd dlmZejeZGddeZdS)z Aer qasm simulator backend. N)warnOptions) BackendV2) __version__)AerError) AerBackend)AerBackendConfiguration)target_to_backend_properties)cpp_execute_circuitsavailable_methodsMAX_QUBITS_STATEVECTORLEGACY_METHOD_MAPmap_legacy_method_config)aer_controller_executeceZdZdZegdZegdZdeeddddde ddd eegd Z gd Z d Z d Z d Zdfd ZfdZedZedZdZdZdZdZfdZdZdZdZddZxZS) QasmSimulatora2 Noisy quantum circuit simulator backend. **Configurable Options** The `QasmSimulator` supports multiple simulation methods and configurable options for each simulation method. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the :meth:`set_options` method. Run-time options may also be specified as kwargs using the :meth:`run` method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. For example, to configure a density matrix simulator with a custom noise model to use for every execution .. code-block:: python noise_model = NoiseModel.from_backend(backend) backend = QasmSimulator(method='density_matrix', noise_model=noise_model) **Simulating an IBM Quantum Backend** The simulator can be automatically configured to mimic an IBM Quantum backend using the :meth:`from_backend` method. This will configure the simulator to use the basic device :class:`NoiseModel` for that backend, and the same basis gates and coupling map. .. code-block:: python backend = QasmSimulator.from_backend(backend) **Simulation Method Option** The simulation method is set using the ``method`` kwarg. Supported simulation methods are * ``"statevector"``: A dense statevector simulation that can sample measurement outcomes from *ideal* circuits with all measurements at end of the circuit. For noisy simulations each shot samples a randomly sampled noisy circuit from the noise model. ``"statevector_cpu"`` is an alias of ``"statevector"``. * ``"statevector_gpu"``: A dense statevector simulation that provides the same functionalities with ``"statevector"``. GPU performs the computation to calculate probability amplitudes as CPU does. If no GPU is available, a runtime error is raised. * ``"density_matrix"``: A dense density matrix simulation that may sample measurement outcomes from *noisy* circuits with all measurements at end of the circuit. It can only simulate half the number of qubits as the statevector method. * ``"density_matrix_gpu"``: A dense density matrix simulation that provides the same functionalities with ``"density_matrix"``. GPU performs the computation to calculate probability amplitudes as CPU does. If no GPU is available, a runtime error is raised. * ``"stabilizer"``: An efficient Clifford stabilizer state simulator that can simulate noisy Clifford circuits if all errors in the noise model are also Clifford errors. * ``"extended_stabilizer"``: An approximate simulated based on a ranked-stabilizer decomposition that decomposes circuits into stabilizer state terms. The number of terms grows with the number of non-Clifford gates. * ``"matrix_product_state"``: A tensor-network statevector simulator that uses a Matrix Product State (MPS) representation for the state. * ``"automatic"``: The default behavior where the method is chosen automatically for each circuit based on the circuit instructions, number of qubits, and noise model. **Additional Backend Options** The following simulator specific backend options are supported * ``method`` (str): Set the simulation method (Default: ``"automatic"``). Use :meth:`available_methods` to return a list of all availabe methods. * ``device`` (str): Set the simulation device (Default: ``"CPU"``). Use :meth:`available_devices` to return a list of devices supported on the current system. * ``precision`` (str): Set the floating point precision for certain simulation methods to either ``"single"`` or ``"double"`` precision (default: ``"double"``). * ``executor`` (futures.Executor): Set a custom executor for asynchronous running of simulation jobs (Default: None). * ``max_job_size`` (int or None): If the number of run circuits exceeds this value simulation will be run as a set of of sub-jobs on the executor. If ``None`` simulation of all circuits are submitted to the executor as a single job (Default: None). * ``max_shot_size`` (int or None): If the number of shots of a noisy circuit exceeds this value simulation will be split into multi circuits for execution and the results accumulated. If ``None`` circuits will not be split based on shots. When splitting circuits use the ``max_job_size`` option to control how these split circuits should be submitted to the executor (Default: None). * ``enable_truncation`` (bool): If set to True this removes unnecessary qubits which do not affect the simulation outcome from the simulated circuits (Default: True). * ``zero_threshold`` (double): Sets the threshold for truncating small values to zero in the result data (Default: 1e-10). * ``validation_threshold`` (double): Sets the threshold for checking if initial states are valid (Default: 1e-8). * ``max_parallel_threads`` (int): Sets the maximum number of CPU cores used by OpenMP for parallelization. If set to 0 the maximum will be set to the number of CPU cores (Default: 0). * ``max_parallel_experiments`` (int): Sets the maximum number of experiments that may be executed in parallel up to the max_parallel_threads value. If set to 1 parallel circuit execution will be disabled. If set to 0 the maximum will be automatically set to max_parallel_threads (Default: 1). * ``max_parallel_shots`` (int): Sets the maximum number of shots that may be executed in parallel during each experiment execution, up to the max_parallel_threads value. If set to 1 parallel shot execution will be disabled. If set to 0 the maximum will be automatically set to max_parallel_threads. Note that this cannot be enabled at the same time as parallel experiment execution (Default: 0). * ``max_memory_mb`` (int): Sets the maximum size of memory to store a state vector. If a state vector needs more, an error is thrown. In general, a state vector of n-qubits uses 2^n complex values (16 Bytes). If set to 0, the maximum will be automatically set to the system memory size (Default: 0). These backend options only apply when using the ``"statevector"`` simulation method: * ``statevector_parallel_threshold`` (int): Sets the threshold that the number of qubits must be greater than to enable OpenMP parallelization for matrix multiplication during execution of an experiment. If parallel circuit or shot execution is enabled this will only use unallocated CPU cores up to max_parallel_threads. Note that setting this too low can reduce performance (Default: 14). * ``statevector_sample_measure_opt`` (int): Sets the threshold that the number of qubits must be greater than to enable a large qubit optimized implementation of measurement sampling. Note that setting this two low can reduce performance (Default: 10) These backend options only apply when using the ``"stabilizer"`` simulation method: * ``stabilizer_max_snapshot_probabilities`` (int): set the maximum qubit number for the :class:`~qiskit_aer.library.SaveProbabilities` instruction (Default: 32). These backend options only apply when using the ``"extended_stabilizer"`` simulation method: * ``extended_stabilizer_sampling_method`` (string): Choose how to simulate measurements on qubits. The performance of the simulator depends significantly on this choice. In the following, let n be the number of qubits in the circuit, m the number of qubits measured, and S be the number of shots (Default: resampled_metropolis). - ``"metropolis"``: Use a Monte-Carlo method to sample many output strings from the simulator at once. To be accurate, this method requires that all the possible output strings have a non-zero probability. It will give inaccurate results on cases where the circuit has many zero-probability outcomes. This method has an overall runtime that scales as n^{2} + (S-1)n. - ``"resampled_metropolis"``: A variant of the metropolis method, where the Monte-Carlo method is reinitialised for every shot. This gives better results for circuits where some outcomes have zero probability, but will still fail if the output distribution is sparse. The overall runtime scales as Sn^{2}. - ``"norm_estimation"``: An alternative sampling method using random state inner products to estimate outcome probabilites. This method requires twice as much memory, and significantly longer runtimes, but gives accurate results on circuits with sparse output distributions. The overall runtime scales as Sn^{3}m^{3}. * ``extended_stabilizer_metropolis_mixing_time`` (int): Set how long the monte-carlo method runs before performing measurements. If the output distribution is strongly peaked, this can be decreased alongside setting extended_stabilizer_disable_measurement_opt to True (Default: 5000). * ``"extended_stabilizer_approximation_error"`` (double): Set the error in the approximation for the extended_stabilizer method. A smaller error needs more memory and computational time (Default: 0.05). * ``extended_stabilizer_norm_estimation_samples`` (int): The default number of samples for the norm estimation sampler. The method will use the default, or 4m^{2} samples where m is the number of qubits to be measured, whichever is larger (Default: 100). * ``extended_stabilizer_norm_estimation_repetitions`` (int): The number of times to repeat the norm estimation. The median of these reptitions is used to estimate and sample output strings (Default: 3). * ``extended_stabilizer_parallel_threshold`` (int): Set the minimum size of the extended stabilizer decomposition before we enable OpenMP parallelization. If parallel circuit or shot execution is enabled this will only use unallocated CPU cores up to max_parallel_threads (Default: 100). * ``extended_stabilizer_probabilities_snapshot_samples`` (int): If using the metropolis or resampled_metropolis sampling method, set the number of samples used to estimate probabilities in a probabilities snapshot (Default: 3000). These backend options only apply when using the ``"matrix_product_state"`` simulation method: * ``matrix_product_state_max_bond_dimension`` (int): Sets a limit on the number of Schmidt coefficients retained at the end of the svd algorithm. Coefficients beyond this limit will be discarded. (Default: None, i.e., no limit on the bond dimension). * ``matrix_product_state_truncation_threshold`` (double): Discard the smallest coefficients for which the sum of their squares is smaller than this threshold. (Default: 1e-16). * ``mps_sample_measure_algorithm`` (str): Choose which algorithm to use for ``"sample_measure"`` (Default: "mps_apply_measure"). - ``"mps_probabilities"``: This method first constructs the probability vector and then generates a sample per shot. It is more efficient for a large number of shots and a small number of qubits, with complexity O(2^n * n * D^2) to create the vector and O(1) per shot, where n is the number of qubits and D is the bond dimension. - ``"mps_apply_measure"``: This method creates a copy of the mps structure and measures directly on it. It is more efficient for a small number of shots, and a large number of qubits, with complexity around O(n * D^2) per shot. * ``mps_log_data`` (str): if True, output logging data of the MPS structure: bond dimensions and values discarded during approximation. (Default: False) These backend options apply in circuit optimization passes: * ``fusion_enable`` (bool): Enable fusion optimization in circuit optimization passes [Default: True] * ``fusion_verbose`` (bool): Output gates generated in fusion optimization into metadata [Default: False] * ``fusion_max_qubit`` (int): Maximum number of qubits for a operation generated in a fusion optimization [Default: 5] * ``fusion_threshold`` (int): Threshold that number of qubits must be greater than or equal to enable fusion optimization [Default: 14] );u1u2u3uprrxryrzidxyzhssdgsxsxdgttdgswapcxcyczcsxcpcucu1cu2cu3rxxryyrzzrzxccxcswapmcxmcymczmcsxmcpmcphasemcumcu1mcu2mcu3mcrxmcrymcrzmcrmcswapunitarydiagonal multiplexer initializedelaypaulimcx_grayecr)quantum_channel qerror_locroerrorkraus save_expvalsave_expval_varsave_probabilitiessave_probabilities_dictsave_amplitudessave_amplitudes_sq save_statesave_density_matrixsave_statevectorsave_statevector_dictsave_stabilizerset_statevectorset_density_matrixset_stabilizerresetqasm_simulatorz$https://github.com/Qiskit/qiskit-aerT.AzA C++ Qasm simulator with noiseN) backend_namebackend_versionn_qubitsurl simulatorlocal conditionalmemory max_shots description coupling_map basis_gatescustom_instructionsgates) automatic statevectorstatevector_gpustatevector_custatevecstatevector_thrustdensity_matrixdensity_matrix_gpudensity_matrix_custatevecdensity_matrix_thrust stabilizermatrix_product_stateextended_stabilizer)CPUGPUThrustc ~tdtt|_tj.t tjtjt_|tj tj }nd|_ |j |_t||||dS)NzsThe `QasmSimulator` backend will be deprecated in the future. It has been superseded by the `AerSimulator` backend.F)providerbackend_options)rPendingDeprecationWarningr _controllerr_AVAILABLE_METHODSr_SIMULATION_METHODS_SIMULATION_DEVICESr from_dict_DEFAULT_CONFIGURATION open_pulse_DEFAULT_BASIS_GATES_cached_basis_gatessuper__init__)self configuration propertiesrr __class__s X/granary/edev/quantum/lib/python3.11/site-packages/qiskit_aer/backends/qasm_simulator.pyrzQasmSimulator.__init__s   &    233  + 3/@1100M ,  3=m>bccMM',M $$(#<   :/      cvtdd}dt|jjdzz}t |jdd}|dvr |d|d|d z }t |jd d}|-|s|d|d t|d z }|d z }|S) z'String representation of an AerBackend.N r method)Nrtz, zmethod='' noise_modelz noise_model=)) r__repr__lenr__name__getattroptionsis_idealrepr)rdisplaypadrrrs rrzQasmSimulator.__repr__s''""$$SbS)S011A56x66 , , , 3S33&333 3GdlM4@@  ";+?+?+A+A " BSBBd;.?.?BBB BG3rctd?iddddddddddd dd dd d d ddddddddddddd ddddddddddddddddd dd!dd"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d-d1d2d3d4d5dd6d7d8dd9d:d;dddS)@Nshotsirdevicer precisiondoubleexecutor max_job_size max_shot_sizeenable_truncationTzero_thresholdg|=validation_thresholdmax_parallel_threadsmax_parallel_experimentsmax_parallel_shots max_memory_mb fusion_enablefusion_verboseFfusion_max_qubitfusion_thresholdaccept_distributed_resultsblocking_qubitsblocking_enablermrseed_simulatorstatevector_parallel_thresholdstatevector_sample_measure_opt %stabilizer_max_snapshot_probabilities #extended_stabilizer_sampling_methodresampled_metropolis*extended_stabilizer_metropolis_mixing_timei'extended_stabilizer_approximation_errorg?+extended_stabilizer_norm_estimation_samplesd/extended_stabilizer_norm_estimation_repetitions&extended_stabilizer_parallel_threshold2extended_stabilizer_probabilities_snapshot_samplesi )matrix_product_state_truncation_thresholdgؗҜ<'matrix_product_state_max_bond_dimensionmps_sample_measure_algorithm mps_heuristic mps_log_datachop_thresholdg:0yE>mps_parallel_thresholdmps_omp_threadsr mps_lapackr)clss r_default_optionszQasmSimulator._default_optionss10 0 0 $0 40 5 0 h 0 T 0 0 $0 #d0 !50 "&0 "&0 &*T0  $t0 $0 $!0 "!5#0 $Q%0 & R'0 ((,t)0 *!D+0 ,"E-0 .4/0 010 2 430 6,.270 8,.290 <35"=0 @1G0FA0 B8AI0 J473K0 L@DtM0 P7%>%@%@"!58RR rc4tj|jSz(Return the available simulation methods.)rrrs rrzQasmSimulator.available_methodsJy0111rc4tj|jSr)r_AVAILABLE_DEVICESrs ravailable_deviceszQasmSimulator.available_devicesNrrcNt|}t|j|||S)z Execute circuits on the backend.)rrr)r aer_circuitsrrs r_execute_circuitszQasmSimulator._execute_circuitsRs')&11#D$4lKQWXXXrc|dkr|||dS|dkr|tvr&t|\}}|d||=||vr't d|d|||t |||dvr||_dSdS)NrrrrzInvalid simulation method z. Available methods are: )rrrq) _set_configuration_optionr set_optionrr _set_method_configr _basis_gatesr)rrvaluerrs rrzQasmSimulator.set_optionWs ' ' '  * *3 6 6 6 F (??))) 1% 8 v&111 U$2H2H2J2J%J%J888!335588  # #E * * * 3&&& : : :'+'8'8':':D $ $ $ ; :rcd|jvr |jdS|}|jj}|r#t ||}n|}t |jdd}|r|j}||}nd}|st d|||t|S)zReturn simualtor basis gates. This will be the option value of basis gates if it was set, otherwise it will be the intersection of the configuration, noise model and method supported basis gates. rqrNzThe intersection of configuration basis gates (%s), simulation method basis gates (%s), and noise model basis gates (%s) is empty) r_method_basis_gatesrrqset intersectionrrloggerwarningsorted)r method_gates config_gatesrqr noise_gatess rrzQasmSimulator._basis_gatesis D7 7 7.}= =//11 *6  'l++88FFKK&KdlM4@@  %1K%22;??KKK  NN8    k"""rc|jdd}|dvrtgdS|dkrtgdS|dkrtgdS|d krtgd StjS) 1Return method basis gates and custom instructionsrNryrzr{r|)$rrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r/r1r4r5r6r7r8rIrJrMrNrPr~)&rrrrrr/r+r,r-rr r!r"r#r$r%r&r'r(r)r*r8rIrSrMrNrrrrr4r5r6r7r.r9rJrLr})rr r!r"r#r$r%r&r'r+r,r-r*rMrNrPr)r+r-rr r!r"r#r$r%r&r'r*u0r(r)rrr8cczrMrN)_optionsgetrrrrrs rr z!QasmSimulator._method_basis_gatess""8T22    %%%''' P + + +'''))) T \ ! ! ( * * * 211rcZd|jvr |jdS|jdd}|dvrtgdS|dvrtgdS|dkrtgd S|d krtgd S|d krtgd StjS)rrrrNrurvrwrx)rQrRrSrTrUrVrWrXrYrZr[r\r]r^r`r)rQrRrSrTsuperoprUrVrWrXr[r\rZr`rar~)rQrRrSrTrUrVrWrXr\r[r]rYrZsave_matrix_product_stateset_matrix_product_stater}) rQrRrSrUrVrWrXrZr[r_rbr)rQrRrSr])rrrrr_DEFAULT_CUSTOM_INSTRrs rrz"QasmSimulator._custom_instructionss- !D$? ? ?./DE E""8T22     &     $ + + + & \ ! !     * * *ZZZ[[ [22rc|dvr d}t}n6|dvr d}tdz}n%|dkrd}d}n|d krd }d }n|d krd }d}nd}d}|d||d|dS)z.Set non-basis gate options when setting methodrz&A C++ statevector simulator with noiserz)A C++ density matrix simulator with noiserr~z/A C++ matrix product state simulator with noise?r}z.A C++ Clifford stabilizer simulator with noisei'rz9A C++ Clifford+T extended stabilizer simulator with noiseNrorh)rr)rrrorhs rrz QasmSimulator._set_method_config|s    CK-HH    FK-2HH - - -KKHH | # #JKHH , , ,UKHHKH &&}kBBB &&z8<<<<>@#F   2)&*5SXX8+4"   2      > 1 1 [1 f%%[%N   222222YYY ;;;;;$$#$#$#LK2K2K2Z^3^3^3@!=!=!=!=!=!=!=!=rr)r$rloggingwarningsrqiskit.providers.optionsrqiskit.providers.backendrversionraererrorr aerbackendr backendconfigurationr backendpropertiesr backend_utilsrrrrrcontroller_wrappersr getLoggerrr rrrrr3s] ,,,,,,......!!!!!!""""""999999;;;;;;877777  8 $ $t =t =t =t =t =Jt =t =t =t =t =r