Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

Eigenvalues

class Eigenvalues

GitHub

Base class for eigenvalue estimation.

This method should initialize the module and use an exception if a component of the module is not available.


Methods

construct_circuit

abstract Eigenvalues.construct_circuit(mode, register=None)

Construct the eigenvalue estimation quantum circuit.

Parameters

  • mode (str) – ‘matrix’ or ‘circuit’
  • register (QuantumRegister) – register for circuit construction where eigenvalues will be stored.

Returns

object for the eigenvalue estimation circuit.

Return type

QuantumCircuit

Raises

NotImplementedError – not implemented

construct_inverse

Eigenvalues.construct_inverse(mode, circuit)

Construct the inverse eigenvalue estimation quantum circuit.

Parameters

  • mode (str) – construction mode, ‘matrix’ not supported
  • circuit (QuantumCircuit) – the quantum circuit to invert

Returns

object for of the inverted eigenvalue estimation

circuit.

Return type

QuantumCircuit

Raises

  • NotImplementedError – not implemented for matrix mode
  • ValueError – Circuit was not constructed beforehand

get_register_sizes

abstract Eigenvalues.get_register_sizes()

get register sizes

get_scaling

abstract Eigenvalues.get_scaling()

get scaling

Was this page helpful?
Report a bug or request content on GitHub.