Source code for qurry.qurrech

"""Qurrech - Wave Function Overlap
(:mod:`qurry.qurrech`)

"""

from typing import Literal, Union, overload

from .hadamard_test import EchoListenHadamard, EchoListenHadamardMeasureArgs
from .randomized_measure import EchoListenRandomized, EchoListenRandomizedMeasureArgs
from .randomized_measure_v1 import EchoListenRandomizedV1, EchoListenRandomizedV1MeasureArgs


# pylint: disable=invalid-name
@overload
def EchoListen(*args, method: Literal["hadamard"], **kwargs) -> EchoListenHadamard: ...


@overload
def EchoListen(*args, method: Literal["randomized_v1"], **kwargs) -> EchoListenRandomizedV1: ...


@overload
def EchoListen(
    *args, method: Union[Literal["randomized", "base"], str] = "randomized", **kwargs
) -> EchoListenRandomized: ...



[docs]
def EchoListen(
    *args,
    method="randomized",
    **kwargs,
):
    """Call :func:`EchoListen` methods.

    Args:
        method (Literal["randomized", "hadamard"], optional):
            The method to use for wave function overlap measurement.

            - randomized: running by haar randomized measure.
            - hadamard: running by hadamard test.

            Defaults to 'randomized'.

    Returns:
        EchoListenBase: method.
    """
    if method == "hadamard":
        return EchoListenHadamard(*args, **kwargs)
    if method == "randomized_v1":
        return EchoListenRandomizedV1(*args, **kwargs)
    return EchoListenRandomized(*args, **kwargs)



@overload
def WaveFunctionOverlap(*args, method: Literal["hadamard"], **kwargs) -> EchoListenHadamard: ...


@overload
def WaveFunctionOverlap(
    *args, method: Literal["randomized_v1"], **kwargs
) -> EchoListenRandomizedV1: ...


@overload
def WaveFunctionOverlap(
    *args, method: Union[Literal["randomized", "base"], str] = "randomized", **kwargs
) -> EchoListenRandomized: ...



[docs]
def WaveFunctionOverlap(
    *args,
    method="randomized",
    **kwargs,
):
    """Call :func:`WaveFunctionOverlap` methods, another name of :func:`EchoListen`.

    Args:
        method (Literal["randomized", "hadamard"], optional):
            The method to use for wave function overlap measurement.

            - randomized: running by haar randomized measure.
            - hadamard: running by hadamard test.

            Defaults to 'randomized'.

    Returns:
        WaveFunctionOverlapBase: method.
    """
    if method == "hadamard":
        return EchoListenHadamard(*args, **kwargs)
    if method == "randomized_v1":
        return EchoListenRandomizedV1(*args, **kwargs)
    return EchoListenRandomized(*args, **kwargs)