qiskit.aqua.components.eigs.Eigenvalues

class Eigenvalues

Base class for eigenvalue estimation.

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

abstract __init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
construct_circuit(mode[, register])	Construct the eigenvalue estimation quantum circuit.
construct_inverse(mode, circuit)	Construct the inverse eigenvalue estimation quantum circuit.
get_register_sizes()	get register sizes
get_scaling()	get scaling

abstract 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(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

abstract get_register_sizes()

get register sizes

abstract get_scaling()

get scaling