qdk_chemistry.algorithms.controlled_circuit_mapper.base module

QDK/Chemistry circuit mapper for controlled-unitary abstractions.

class qdk_chemistry.algorithms.controlled_circuit_mapper.base.ControlledCircuitMapper[source]

Bases: Algorithm

Base class for circuit mapper for controlled-unitary in QDK/Chemistry algorithms.

__init__()[source]

Initialize the ControlledCircuitMapper.

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.controlled_circuit_mapper.base.ControlledCircuitMapperFactory[source]

Bases: AlgorithmFactory

Factory class for creating ControlledCircuitMapper instances.

algorithm_type_name()[source]

Return controlled_circuit_mapper as the algorithm type name.

Return type:

str

default_algorithm_name()[source]

Return pauli_sequence as the default algorithm name.

Return type:

str

class qdk_chemistry.algorithms.controlled_circuit_mapper.base.ControlledCircuitMapperSettings[source]

Bases: Settings

Settings for the ControlledCircuitMapper.

control_indices

The control qubit indices. Defaults to [0].

target_indices

The target qubit indices. An empty list means auto-fill based on the unitary’s qubit count and control indices.

__init__()[source]

Initialize the settings for ControlledCircuitMapper.