qiskit-documentation/docs/api/qiskit/0.26/qiskit.aqua.utils.mdx

48 lines
5.7 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: utils (v0.26)
description: API reference for qiskit.aqua.utils in qiskit v0.26
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.aqua.utils
---
<span id="module-qiskit.aqua.utils" />
<span id="qiskit-aqua-utils" />
<span id="utilities-qiskit-aqua-utils" />
# Utilities
`qiskit.aqua.utils`
Various utility functionality…
# Utilities
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`tensorproduct`](qiskit.aqua.utils.tensorproduct "qiskit.aqua.utils.tensorproduct") | Calculate tensor product. |
| [`random_unitary`](qiskit.aqua.utils.random_unitary "qiskit.aqua.utils.random_unitary") | Generate a random unitary matrix with size NxN. |
| [`random_h2_body`](qiskit.aqua.utils.random_h2_body "qiskit.aqua.utils.random_h2_body") | Generate a random two body integrals. |
| [`random_h1_body`](qiskit.aqua.utils.random_h1_body "qiskit.aqua.utils.random_h1_body") | Generate a random one body integrals. |
| [`random_hermitian`](qiskit.aqua.utils.random_hermitian "qiskit.aqua.utils.random_hermitian") | Generate random hermitian (sparse) matrix with given properties. |
| [`random_non_hermitian`](qiskit.aqua.utils.random_non_hermitian "qiskit.aqua.utils.random_non_hermitian") | Generate random (sparse) matrix with given properties (singular values). |
| [`decimal_to_binary`](qiskit.aqua.utils.decimal_to_binary "qiskit.aqua.utils.decimal_to_binary") | decimal to binary |
| [`summarize_circuits`](qiskit.aqua.utils.summarize_circuits "qiskit.aqua.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. |
| [`get_subsystem_density_matrix`](qiskit.aqua.utils.get_subsystem_density_matrix "qiskit.aqua.utils.get_subsystem_density_matrix") | Compute the reduced density matrix of a quantum subsystem. |
| [`get_subsystems_counts`](qiskit.aqua.utils.get_subsystems_counts "qiskit.aqua.utils.get_subsystems_counts") | Extract all subsystems counts from the single complete system count dictionary. |
| [`get_entangler_map`](qiskit.aqua.utils.get_entangler_map "qiskit.aqua.utils.get_entangler_map") | Utility method to get an entangler map among qubits. |
| [`validate_entangler_map`](qiskit.aqua.utils.validate_entangler_map "qiskit.aqua.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. |
| [`get_feature_dimension`](qiskit.aqua.utils.get_feature_dimension "qiskit.aqua.utils.get_feature_dimension") | Check feature dimension of a given dataset |
| [`get_num_classes`](qiskit.aqua.utils.get_num_classes "qiskit.aqua.utils.get_num_classes") | Check number of classes in a given dataset |
| [`split_dataset_to_data_and_labels`](qiskit.aqua.utils.split_dataset_to_data_and_labels "qiskit.aqua.utils.split_dataset_to_data_and_labels") | Split dataset to data and labels numpy array |
| [`map_label_to_class_name`](qiskit.aqua.utils.map_label_to_class_name "qiskit.aqua.utils.map_label_to_class_name") | Helper converts labels (numeric) to class name (string) |
| [`reduce_dim_to_via_pca`](qiskit.aqua.utils.reduce_dim_to_via_pca "qiskit.aqua.utils.reduce_dim_to_via_pca") | Reduce the data dimension via pca |
| [`optimize_svm`](qiskit.aqua.utils.optimize_svm "qiskit.aqua.utils.optimize_svm") | Solving quadratic programming problem for SVM; thus, some constraints are fixed. |
| [`CircuitFactory`](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") | Base class for CircuitFactories |
| [`has_ibmq`](qiskit.aqua.utils.has_ibmq "qiskit.aqua.utils.has_ibmq") | Check if IBMQ is installed |
| [`has_aer`](qiskit.aqua.utils.has_aer "qiskit.aqua.utils.has_aer") | check if Aer is installed |
| [`name_args`](qiskit.aqua.utils.name_args "qiskit.aqua.utils.name_args") | Decorator to convert unnamed arguments to named ones. |