qdk_chemistry.algorithms.qubit_mapper package

QDK/Chemistry qubit mapper abstractions and utilities.

This module provides the base class QubitMapper as well as the QubitMapperFactory for mapping electronic structure Hamiltonians to qubit Hamiltonians using various mapping strategies.

class qdk_chemistry.algorithms.qubit_mapper.QdkQubitMapperSettings

Bases: QubitMapperSettings

Settings configuration for a QdkQubitMapper.

Inherits base settings from QubitMapperSettings.

Available encodings:

  • "jordan-wigner" (default)

  • "bravyi-kitaev"

Additional settings:

threshold (double, default=1e-12): Threshold for pruning small Pauli coefficients. integral_threshold (double, default=1e-12): Threshold for filtering small integrals.

__init__()

Initialize QdkQubitMapperSettings.

Return type:

None

class qdk_chemistry.algorithms.qubit_mapper.QubitMapperFactory

Bases: AlgorithmFactory

Factory class for creating QubitMapper instances.

algorithm_type_name()

Return qubit_mapper as the algorithm type name.

Return type:

str

default_algorithm_name()

Return qdk as the default algorithm name.

Return type:

str

class qdk_chemistry.algorithms.qubit_mapper.QubitMapperSettings(valid_encodings=None)

Bases: Settings

Base settings for all QubitMapper implementations.

Common settings:

encoding (string, default=”jordan-wigner”): Fermion-to-qubit encoding strategy.

Parameters:

valid_encodings (list[str] | None)

__init__(valid_encodings=None)

Initialize QubitMapperSettings.

Parameters:

valid_encodings (list[str] | None) – Allowed encoding values. Default: ["jordan-wigner"].

Return type:

None

Submodules