HartreeFock

class HartreeFock(num_spatial_orbitals=None, num_particles=None, qubit_mapper=None)[source]

Bases: BlueprintCircuit

A Hartree-Fock initial state.

Parameters:

  • num_spatial_orbitals (int | None) – The number of spatial orbitals.

  • num_particles (tuple[int, int] | None) – The number of particles as a tuple storing the number of alpha and beta-spin electrons in the first and second number, respectively.

  • qubit_mapper (QubitMapper | None) – A QubitMapper.

Raises:

NotImplementedError – If qubit_mapper is (or uses) a BravyiKitaevSuperFastMapper. See https://github.com/Qiskit/qiskit-nature/issues/537 for more information.

Attributes

num_particles

The number of particles.

num_spatial_orbitals

The number of spatial orbitals.

qubit_mapper

The qubit mapper.

name: str

A human-readable name for the circuit.

Example

from qiskit import QuantumCircuit

qc = QuantumCircuit(2, 2, name="my_circuit")
print(qc.name)

(Source code)

my_circuit

Methods