qdk_chemistry.algorithms.phase_estimation.base module

QDK/Chemistry phase estimation abstractions and utilities.

class qdk_chemistry.algorithms.phase_estimation.base.PhaseEstimation

Bases: Algorithm

Abstract base class for phase estimation algorithms.

__init__()

Initialize the PhaseEstimation with default settings.

type_name()

Return the algorithm type name as phase_estimation.

Return type:

str

run(*args, **kwargs)

Run the algorithm with the provided arguments.

This method wraps the internal _run_impl method to provide a consistent interface for executing the algorithm.

Parameters:

• args – The arguments required to run the algorithm.

• kwargs – The keyword arguments required to run the algorithm.

Returns:

The results of the algorithm

Return type:

Any

class qdk_chemistry.algorithms.phase_estimation.base.PhaseEstimationFactory

Bases: AlgorithmFactory

Factory class for creating PhaseEstimation instances.

__init__()

Initialize the PhaseEstimationFactory.

algorithm_type_name()

Return the algorithm type name as phase_estimation.

Return type:

str

default_algorithm_name()

Return the qdk_iterative as default algorithm name.

Return type:

str

class qdk_chemistry.algorithms.phase_estimation.base.PhaseEstimationSettings

Bases: Settings

Settings for the Phase Estimation algorithm.

__init__()

Initialize the settings for Phase Estimation.

Includes nested algorithm references for the circuit builder and circuit executor.